Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

update-configuration-set-event-destination

Описание

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

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

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

Синтаксис

  update-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 -> (список)

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

(строка)

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

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

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

IamRoleArn -> (строка)

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

DeliveryStreamArn -> (строка)

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

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

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

DimensionConfigurations -> (список)

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

(структура)

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

DimensionName -> (строка)

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

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

DimensionValueSource -> (строка)

Местоположение, где Amazon SES API 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 -> (строка)

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

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

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

EventBusArn -> (строка)

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

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

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

ApplicationArn -> (строка)

Идентификатор ресурса AWS (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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

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

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

Вывод

Нет

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

Spec-Zone.ru

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