Spec-Zone.ru › AWS CLI v2

[ aws . ses ]

обновить-настройку-набора-событий-назначение

Описание

Обновляет назначение событий для набора настроек. Назначения событий связаны с наборами настроек, что позволяет публиковать события отправки электронных писем в Amazon CloudWatch, Amazon Kinesis Firehose или Amazon Simple Notification Service (Amazon SNS). Сведения об использовании наборов настроек см. в руководстве разработчика Amazon SES в разделе «Мониторинг вашей активности отправки Amazon SES».

Примечание

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

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

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

Синтаксис

  update-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 (структура)

Объект назначения событий.

Имя -> (строка)

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

  • Содержать только буквы 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
  • 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