[ aws . pinpoint-email ]
обновить-настройки-набора-конфигураций-назначение-событий
Описание
Обновление настроек назначения событий для набора конфигураций.
В Amazon Pinpoint события включают отправку сообщений, доставку, открытие, клики, возвраты и жалобы. Назначения событий — это места, куда вы можете отправлять информацию об этих событиях. Например, вы можете отправлять данные событий в Amazon SNS, чтобы получать уведомления при получении возвратов или жалоб, или использовать Amazon Kinesis Data Firehose для потоковой передачи данных в Amazon S3 для долгосрочного хранения.
См. также: Документация 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 Pinpoint должен отправлять в назначения в этом EventDestinationDefinition .
(строка)
KinesisFirehoseDestination -> (структура)
Объект, определяющий назначение Amazon Kinesis Data Firehose для событий электронной почты. Вы можете использовать Amazon Kinesis Data Firehose для потоковой передачи данных в другие сервисы, такие как Amazon S3 и Amazon Redshift.
IamRoleArn -> (строка)
DeliveryStreamArn -> (строка)
CloudWatchDestination -> (структура)
Объект, определяющий назначение Amazon CloudWatch для событий электронной почты. Вы можете использовать Amazon CloudWatch для мониторинга и получения информации о ваших метриках отправки электронной почты.
DimensionConfigurations -> (список)
Массив объектов, определяющих измерения, используемые при отправке событий электронной почты в Amazon CloudWatch.
(структура)
Объект, определяющий конфигурацию измерения, используемую при отправке событий электронной почты Amazon Pinpoint в Amazon CloudWatch.
DimensionName -> (строка)
Имя измерения Amazon CloudWatch, связанного с метрикой отправки электронных писем. Имя должно соответствовать следующим критериям:
- Может содержать только ASCII-буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
- Может содержать не более 256 символов.
DimensionValueSource -> (строка)
messageTag . Если вы хотите, чтобы Amazon Pinpoint использовал свои собственные заголовки электронной почты, выберите emailHeader . Если вы хотите, чтобы Amazon Pinpoint использовал теги ссылок, выберите linkTags .DefaultDimensionValue -> (строка)
Значение по умолчанию измерения, которое публикуется в Amazon CloudWatch, если вы не предоставили значение измерения при отправке письма. Это значение должно соответствовать следующим критериям:
- Может содержать только ASCII-буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
- Может содержать не более 256 символов.
SnsDestination -> (структура)
Объект, определяющий назначение Amazon SNS для событий электронной почты. Вы можете использовать Amazon SNS для отправки уведомлений при возникновении определенных событий электронной почты.
TopicArn -> (строка)
PinpointDestination -> (структура)
Объект, определяющий назначение Amazon Pinpoint для событий электронной почты. Вы можете использовать события Amazon Pinpoint для создания атрибутов в проектах Amazon Pinpoint. Вы можете использовать эти атрибуты для создания сегментов для своих кампаний.
ApplicationArn -> (строка)
Синтаксис JSON:
{
"Enabled": true|false,
"MatchingEventTypes": ["SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE", ...],
"KinesisFirehoseDestination": {
"IamRoleArn": "string",
"DeliveryStreamArn": "string"
},
"CloudWatchDestination": {
"DimensionConfigurations": [
{
"DimensionName": "string",
"DimensionValueSource": "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG",
"DefaultDimensionValue": "string"
}
...
]
},
"SnsDestination": {
"TopicArn": "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.
--cli-auto-prompt (логическое)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое)
Отключить автоматическую запрос параметров ввода CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.