Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

обновить-назначение-события

Описание

Обновляет существующее назначение события в наборе конфигураций. Можно обновить ARN роли IAM для CloudWatch Logs и Firehose. Также можно включить или выключить назначение события.

Возможно, вам нужно обновить назначение события, чтобы изменить сопоставляемые типы событий или обновить ARN ресурса назначения. Нельзя изменить тип назначения события между CloudWatch Logs, Firehose и Amazon SNS.

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

Синтаксис

  update-event-destination
--configuration-set-name <value>
--event-destination-name <value>
[--enabled | --no-enabled]
[--matching-event-types <value>]
[--cloud-watch-logs-destination <value>]
[--kinesis-firehose-destination <value>]
[--sns-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 (строка)

Набор конфигураций, который нужно обновить новым назначением события. Допустимые значения — ConfigurationSetName или ConfigurationSetArn.

--event-destination-name (строка)

Имя, которое нужно использовать для назначения события.

--enabled | --no-enabled (булево)

При значении true ведение журнала включено.

--matching-event-types (список)

Массив типов событий, определяющих, какие события необходимо регистрировать.

Примечание

Тип события 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 (структура)

Объект, содержащий информацию о назначении события, отправляющем данные в CloudWatch Logs.

IamRoleArn -> (строка)

Amazon Resource Name (ARN) управляющей роли Identity and Access Management, которая может записывать данные событий в назначение Amazon CloudWatch.

LogGroupArn -> (строка)

Имя группы журналов Amazon CloudWatch, в которую нужно записывать события.

Сокращенный синтаксис:

IamRoleArn=string,LogGroupArn=string

Синтаксис JSON:

{
  "IamRoleArn": "string",
  "LogGroupArn": "string"
}

--kinesis-firehose-destination (структура)

Объект, содержащий информацию о назначении события для ведения журнала в Firehose.

IamRoleArn -> (строка)

ARN управляющей роли Identity and Access Management, которая может записывать данные событий в назначение Amazon Data Firehose.

DeliveryStreamArn -> (строка)

Amazon Resource Name (ARN) потока доставки.

Сокращенный синтаксис:

IamRoleArn=string,DeliveryStreamArn=string

Синтаксис JSON:

{
  "IamRoleArn": "string",
  "DeliveryStreamArn": "string"
}

--sns-destination (структура)

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

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS, в которую нужно публиковать события.

Сокращенный синтаксис:

TopicArn=string

Синтаксис JSON:

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

Вывод

ConfigurationSetArn -> (строка)

Amazon Resource Name (ARN) для набора конфигураций, который был обновлён.

ConfigurationSetName -> (строка)

Имя набора конфигураций.

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

Объект EventDestination, содержащий подробности о месте регистрации событий.

EventDestinationName -> (строка)

Имя EventDestination.

Enabled -> (булево)

При значении true события будут регистрироваться.

MatchingEventTypes -> (список)

Массив типов событий, определяющих, какие события нужно регистрировать.

Примечание

Тип события TEXT_SENT не поддерживается.

(строка)

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

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

IamRoleArn -> (строка)

Amazon Resource Name (ARN) управляющей роли Identity and Access Management, которая может записывать данные событий в назначение Amazon CloudWatch.

LogGroupArn -> (строка)

Имя группы журналов Amazon CloudWatch, в которую нужно записывать события.

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

Объект, содержащий информацию о назначении события для регистрации в Amazon Data Firehose.

IamRoleArn -> (строка)

ARN управляющей роли Identity and Access Management, которая может записывать данные событий в назначение Amazon Data Firehose.

DeliveryStreamArn -> (строка)

Amazon Resource Name (ARN) потока доставки.

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

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

TopicArn -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS, в которую нужно публиковать события.

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

Spec-Zone.ru

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