Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

get-configuration-set-event-destinations

Описание

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

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

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

Синтаксис

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

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

--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.

Вывод

EventDestinations -> (список)

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

(структура)

В API Amazon SES версии 2, события включают отправку сообщений, доставку, открытие, щелчки, возврат, жалобы и задержки доставки. Пункты назначения событий — это места, куда можно отправлять информацию об этих событиях. Например, можно отправлять данные событий в Amazon SNS для получения уведомлений о возврате или жалобах или использовать Amazon Kinesis Data Firehose для потоковой передачи данных в Amazon S3 для долгосрочного хранения.

Name -> (строка)

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

Enabled -> (булево)

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

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

MatchingEventTypes -> (список)

Типы событий, которые Amazon SES отправляет в указанные пункты назначения событий.

  • SEND - Запрос отправки был выполнен успешно, и SES попытается доставить сообщение на почтовый сервер получателя. (Если используется подавление на уровне учетной записи или глобальное подавление, SES всё равно будет считать это отправкой, но доставка будет подавлена.)
  • REJECT - SES принял электронное письмо, но определил, что оно содержит вирус, и не пытался доставить его на почтовый сервер получателя.
  • BOUNCE - (Жёсткий возврат) Почтовый сервер получателя постоянно отклонил электронное письмо. (Мягкие возвраты включаются только в том случае, если SES не смог доставить электронное письмо после повторных попыток в течение определенного периода времени.)
  • COMPLAINT - Электронное письмо было успешно доставлено на почтовый сервер получателя, но получатель пометил его как спам.
  • DELIVERY - SES успешно доставил электронное письмо на почтовый сервер получателя.
  • OPEN - Получатель получил сообщение и открыл его в своем почтовом клиенте.
  • CLICK - Получатель нажал на одну или несколько ссылок в электронном письме.
  • RENDERING_FAILURE - Электронное письмо не было отправлено из-за проблемы с рендерингом шаблона. Этот тип события может возникнуть, когда отсутствуют данные шаблона или есть несоответствие между параметрами шаблона и данными. (Этот тип события возникает только при отправке электронных писем с использованием операций API ` SendTemplatedEmail https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html`__ или ` SendBulkTemplatedEmail https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html`__.)
  • DELIVERY_DELAY - Электронное письмо не могло быть доставлено на почтовый сервер получателя из-за временной проблемы. Задержки доставки могут возникать, например, когда почтовый ящик получателя переполнен или когда получающий почтовый сервер испытывает временную проблему.
  • SUBSCRIPTION - Электронное письмо было успешно доставлено, но получатель обновил свои настройки подписки, нажав на ссылку «отписаться» в рамках управления подпиской.

(строка)

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

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

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

IamRoleArn -> (строка)

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

DeliveryStreamArn -> (строка)

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

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 версии 2 находит значение измерения для публикации в 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 для отправки событий электронной почты.

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

Spec-Zone.ru

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