Spec-Zone.ru › AWS CLI v2

[ aws . ses ]

создание-настроек-набора-событий-пункта-назначения

Описание

Создаёт пункт назначения событий набора настроек.

Примечание

При создании или обновлении пункта назначения вы должны указать один и только один пункт назначения. Пунктом назначения может быть CloudWatch, Amazon Kinesis Firehose или Amazon Simple Notification Service (Amazon SNS).

Пункт назначения — это служба Amazon Web Services, в которую Amazon SES публикует события отправки электронной почты, связанные с набором настроек. Дополнительную информацию об использовании наборов настроек см. в руководстве разработчика Amazon SES .

Вы можете выполнить эту операцию не более одного раза в секунду.

См. также: документацию AWS API

Синтаксис

  create-configuration-set-event-destination
--configuration-set-name <value>
--event-destination <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--configuration-set-name (строка)

Имя набора настроек, с которым должен быть связан пункт назначения событий.

--event-destination (структура)

Объект, описывающий службу Amazon Web Services, в которую публикуются сведения о событии отправки электронной почты.

Name -> (строка)

Имя пункта назначения. Имя должно соответствовать следующим требованиям:

  • Содержать только буквы ASCII (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
  • Содержать не более 64 символов.

Enabled -> (булево)

Устанавливает, публикует ли Amazon SES события в этот пункт назначения при отправке электронного письма с соответствующим набором настроек. Установите значение true, чтобы включить публикацию в этот пункт назначения; установите значение false, чтобы запретить публикацию в этот пункт назначения. Значение по умолчанию — false .

MatchingEventTypes -> (список)

Тип событий отправки электронных писем, которые должны публиковаться в пункт назначения событий.

  • send - Вызов был успешным, и Amazon SES пытается доставить электронное письмо.
  • reject - Amazon SES определила, что электронное письмо содержит вирус, и отклонила его.
  • bounce - Почтовый сервер получателя постоянно отклонил электронное письмо. Это соответствует жёсткому возврату.
  • complaint - Получатель пометил электронное письмо как спам.
  • delivery - Amazon SES успешно доставил электронное письмо на почтовый сервер получателя.
  • open - Получатель получил электронное письмо и открыл его в своём почтовом клиенте.
  • click - Получатель щелкнул по одной или нескольким ссылкам в электронном письме.
  • renderingFailure - Amazon SES не отправил электронное письмо из-за проблемы с рендерингом шаблона.

(строка)

KinesisFirehoseDestination -> (структура)

Объект, содержащий ARN потока доставки и ARN роли IAM, связанной с пунктом назначения событий Amazon Kinesis Firehose.

IAMRoleARN -> (строка)

ARN роли IAM, под которой Amazon SES публикует события отправки электронных писем в поток Amazon Kinesis Firehose.

DeliveryStreamARN -> (строка)

ARN потока Amazon Kinesis Firehose, в который должны публиковаться события отправки электронных писем.

CloudWatchDestination -> (структура)

Объект, содержащий имена, значения по умолчанию и источники измерений, связанные с пунктом назначения событий Amazon CloudWatch.

DimensionConfigurations -> (список)

Список измерений, по которым следует классифицировать ваши электронные письма при публикации событий отправки электронных писем в Amazon CloudWatch.

(структура)

Содержит конфигурацию измерения, которая должна использоваться при публикации событий отправки электронных писем в Amazon CloudWatch.

Дополнительную информацию о публикации событий отправки электронных писем в Amazon CloudWatch см. в руководстве разработчика Amazon SES .

DimensionName -> (строка)

Имя измерения Amazon CloudWatch, связанного с метрикой отправки электронных писем. Имя должно соответствовать следующим требованиям:

  • Содержать только ASCII буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_), дефисы (-), или двоеточия (:).
  • Содержать не более 256 символов.

DimensionValueSource -> (строка)

Место, где Amazon SES находит значение измерения, которое должно публиковаться в Amazon CloudWatch. Для использования тегов сообщений, которые вы указываете с помощью заголовка X-SES-MESSAGE-TAGS или параметра для API SendEmail/SendRawEmail, укажите messageTag . Для использования собственных заголовков электронных писем укажите emailHeader . Для добавления пользовательского тега на любую ссылку в вашем электронном письме укажите linkTag .

DefaultDimensionValue -> (строка)

Значение измерения по умолчанию, которое публикуется в Amazon CloudWatch, если вы не предоставите значение измерения при отправке электронного письма. Значение по умолчанию должно соответствовать следующим требованиям:

  • Содержать только ASCII буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_), дефисы (-), знаки «@» или точки (.).
  • Содержать не более 256 символов.

SNSDestination -> (структура)

Объект, содержащий ARN темы, связанной с пунктом назначения событий Amazon Simple Notification Service (Amazon SNS).

TopicARN -> (строка)

ARN темы Amazon SNS для событий отправки электронных писем. ARN темы можно найти с помощью операции ListTopics Amazon SNS.

Дополнительную информацию о темах Amazon SNS см. в руководстве разработчика Amazon SNS .

Синтаксис JSON:

{
  "Name": "string",
  "Enabled": true|false,
  "MatchingEventTypes": ["send"|"reject"|"bounce"|"complaint"|"delivery"|"open"|"click"|"renderingFailure", ...],
  "KinesisFirehoseDestination": {
    "IAMRoleARN": "string",
    "DeliveryStreamARN": "string"
  },
  "CloudWatchDestination": {
    "DimensionConfigurations": [
      {
        "DimensionName": "string",
        "DimensionValueSource": "messageTag"|"emailHeader"|"linkTag",
        "DefaultDimensionValue": "string"
      }
      ...
    ]
  },
  "SNSDestination": {
    "TopicARN": "string"
  }
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные данные с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено значение по умолчанию или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выводится пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, проверяются входные данные команды и возвращается пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке сертификатов SSL. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров ввода CLI.

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API