Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

создание назначения событий для набора конфигураций

Описание

Создайте пункт назначения событий. События включают отправку сообщений, доставку, открытие, клики, возвраты и жалобы. Пункты назначения событий — это места, куда можно отправлять информацию об этих событиях. Например, вы можете отправлять данные событий в Amazon EventBridge и назначать правило для отправки события в указанный целевой объект.

Один набор конфигураций может включать более одного пункта назначения событий.

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

Синопсис

  create-configuration-set-event-destination
--configuration-set-name <value>
--event-destination-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-name (строка)

Имя, идентифицирующее пункт назначения событий в рамках набора конфигураций.

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

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

Enabled -> (булево)

Если true , пункт назначения событий включён. При включённом пункте назначения событий указанные типы событий отправляются в пункты назначения в данном EventDestinationDefinition .

Если false , пункт назначения событий отключён. При отключённом пункте назначения событий события не отправляются в указанные пункты назначения.

MatchingEventTypes -> (список)

Массив, определяющий, какие события API Amazon SES v2 должны быть отправлены в пункты назначения в данном EventDestinationDefinition .

(строка)

Тип события отправки электронной почты. Например, отправка писем, открытие и возвраты писем — это все события по электронной почте.

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

Объект, определяющий пункт назначения Amazon Kinesis Data Firehose для событий электронной почты. Вы можете использовать Amazon Kinesis Data Firehose для потоковой передачи данных в другие сервисы, такие как Amazon S3 и Amazon Redshift.

IamRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, которую API Amazon SES v2 использует для отправки событий электронной почты в поток Amazon Kinesis Data Firehose.

DeliveryStreamArn -> (строка)

Идентификатор ресурса Amazon (ARN) потока Amazon Kinesis Data Firehose, в который API Amazon SES v2 отправляет события электронной почты.

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

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

DimensionConfigurations -> (список)

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

(структура)

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

DimensionName -> (строка)

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

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

DimensionValueSource -> (строка)

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

DefaultDimensionValue -> (строка)

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

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

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

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

TopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon SNS для публикации событий электронной почты. Дополнительную информацию о темах Amazon SNS см. в Руководстве разработчика Amazon SNS.

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

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

EventBusArn -> (строка)

Идентификатор ресурса Amazon (ARN) шины Amazon EventBridge для публикации событий электронной почты. Поддерживается только основная шина.

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

Объект, определяющий пункт назначения проекта Amazon Pinpoint для событий электронной почты. Вы можете отправлять данные о событиях электронной почты в проект Amazon Pinpoint для просмотра метрик с использованием встроенных в Amazon Pinpoint панелей мониторинга для транзакционных сообщений. Дополнительную информацию см. в разделе Диаграммы транзакционных сообщений в Руководстве пользователя Amazon Pinpoint.

ApplicationArn -> (строка)

Идентификатор ресурса Amazon (ARN) проекта Amazon Pinpoint для отправки событий электронной почты.

Синтаксис JSON:

{
  "Enabled": true|false,
  "MatchingEventTypes": ["SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE"|"DELIVERY_DELAY"|"SUBSCRIPTION", ...],
  "KinesisFirehoseDestination": {
    "IamRoleArn": "string",
    "DeliveryStreamArn": "string"
  },
  "CloudWatchDestination": {
    "DimensionConfigurations": [
      {
        "DimensionName": "string",
        "DimensionValueSource": "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG",
        "DefaultDimensionValue": "string"
      }
      ...
    ]
  },
  "SnsDestination": {
    "TopicArn": "string"
  },
  "EventBridgeDestination": {
    "EventBusArn": "string"
  },
  "PinpointDestination": {
    "ApplicationArn": "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
  • text
  • таблица
  • 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