Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

get-configuration-set-event-destinations

Описание

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

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

См. также: Документацию 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

EventDestinations -> (список)

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

(структура)

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

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

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

Включено -> (логическое значение)

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

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

СоответствующиеТипыСобытий -> (список)

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

(строка)

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

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

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

IamRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которую Amazon Pinpoint использует при отправке событий электронной почты в поток Amazon Kinesis Data Firehose.

DeliveryStreamArn -> (строка)

Amazon Resource Name (ARN) потока Amazon Kinesis Data Firehose, в который Amazon Pinpoint отправляет события электронной почты.

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

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

DimensionConfigurations -> (список)

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

(структура)

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

ИмяИзмерения -> (строка)

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

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

ИсточникЗначенияИзмерения -> (строка)

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

ЗначениеИзмеренияПоУмолчанию -> (строка)

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

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

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

TopicArn -> (строка)

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

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

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

ApplicationArn -> (строка)

Amazon Resource Name (ARN) проекта Amazon Pinpoint, в который вы хотите отправить события электронной почты.

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

Spec-Zone.ru

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