[ aws . pinpoint-sms-voice-v2 ]
создать-пункт-назначения-событий
Описание
Создает новый пункт назначения событий в наборе конфигураций.
Пункт назначения событий — это место, куда вы отправляете события сообщений. Доступные варианты — Amazon CloudWatch, Amazon Data Firehose или Amazon SNS. Например, при успешной доставке сообщения вы можете отправлять информацию об этом событии в пункт назначения событий или отправлять уведомления конечным точкам, подписанным на тему Amazon SNS.
Вы можете создать только один пункт назначения событий за раз. Вы должны указать значение для одного пункта назначения событий, используя либо CloudWatchLogsDestination , либо KinesisFirehoseDestination , либо SnsDestination . Если пункт назначения событий не указан, возвращается исключение.
Каждый набор конфигураций может содержать от 0 до 5 пунктов назначения событий. Каждый пункт назначения событий может содержать ссылку на один пункт назначения, например, пункт назначения CloudWatch или Firehose.
См. также: Документация по API AWS
Синтаксис
create-event-destination
--configuration-set-name <value>
--event-destination-name <value>
--matching-event-types <value>
[--cloud-watch-logs-destination <value>]
[--kinesis-firehose-destination <value>]
[--sns-destination <value>]
[--client-token <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 (строка)
--matching-event-types (список)
Массив типов событий, определяющих, какие события регистрировать. Если используется «ALL», то AWS End User Messaging SMS и Voice регистрируют все типы событий.
Примечание
Тип событияTEXT_SENT не поддерживается.(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
ALL
TEXT_ALL
TEXT_SENT
TEXT_PENDING
TEXT_QUEUED
TEXT_SUCCESSFUL
TEXT_DELIVERED
TEXT_INVALID
TEXT_INVALID_MESSAGE
TEXT_UNREACHABLE
TEXT_CARRIER_UNREACHABLE
TEXT_BLOCKED
TEXT_CARRIER_BLOCKED
TEXT_SPAM
TEXT_UNKNOWN
TEXT_TTL_EXPIRED
TEXT_PROTECT_BLOCKED
VOICE_ALL
VOICE_INITIATED
VOICE_RINGING
VOICE_ANSWERED
VOICE_COMPLETED
VOICE_BUSY
VOICE_NO_ANSWER
VOICE_FAILED
VOICE_TTL_EXPIRED
MEDIA_ALL
MEDIA_PENDING
MEDIA_QUEUED
MEDIA_SUCCESSFUL
MEDIA_DELIVERED
MEDIA_INVALID
MEDIA_INVALID_MESSAGE
MEDIA_UNREACHABLE
MEDIA_CARRIER_UNREACHABLE
MEDIA_BLOCKED
MEDIA_CARRIER_BLOCKED
MEDIA_SPAM
MEDIA_UNKNOWN
MEDIA_TTL_EXPIRED
MEDIA_FILE_INACCESSIBLE
MEDIA_FILE_TYPE_UNSUPPORTED
MEDIA_FILE_SIZE_EXCEEDED
--cloud-watch-logs-destination (структура)
Объект, содержащий информацию о пункте назначения событий для ведения журнала в Amazon CloudWatch Logs.
IamRoleArn -> (строка)
LogGroupArn -> (строка)
Сокращенный синтаксис:
IamRoleArn=string,LogGroupArn=string
JSON-синтаксис:
{
"IamRoleArn": "string",
"LogGroupArn": "string"
}
--kinesis-firehose-destination (структура)
Объект, содержащий информацию о пункте назначения событий для ведения журнала в Amazon Data Firehose.
IamRoleArn -> (строка)
DeliveryStreamArn -> (строка)
Сокращенный синтаксис:
IamRoleArn=string,DeliveryStreamArn=string
JSON-синтаксис:
{
"IamRoleArn": "string",
"DeliveryStreamArn": "string"
}
--sns-destination (структура)
Объект, содержащий информацию о пункте назначения событий для ведения журнала в Amazon SNS.
TopicArn -> (строка)
Сокращенный синтаксис:
TopicArn=string
JSON-синтаксис:
{
"TopicArn": "string"
}
--client-token (строка)
--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.
Вывод
ConfigurationSetArn -> (строка)
ConfigurationSetName -> (строка)
EventDestination -> (структура)
Подробности пункта назначения, в котором регистрируются события.
EventDestinationName -> (строка)
Enabled -> (логическое значение)
MatchingEventTypes -> (список)
Массив типов событий, определяющих, какие события регистрировать.
Примечание
Тип событияTEXT_SENT не поддерживается.(строка)
CloudWatchLogsDestination -> (структура)
Объект, содержащий информацию о пункте назначения событий, который отправляет события ведения журнала в Amazon CloudWatch logs.
IamRoleArn -> (строка)
LogGroupArn -> (строка)
KinesisFirehoseDestination -> (структура)
Объект, содержащий информацию о пункте назначения событий для ведения журнала в Amazon Data Firehose.
IamRoleArn -> (строка)
DeliveryStreamArn -> (строка)
SnsDestination -> (структура)
Объект, содержащий информацию о пункте назначения событий, который отправляет события ведения журнала в Amazon SNS.
TopicArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|