Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

put-keyword

Описание

Создаёт или обновляет конфигурацию ключевого слова для номера телефона или пула исходящих сообщений.

Ключевое слово — это слово, которое можно искать в определённом номере телефона или пуле. Это также конкретное слово или фраза, которое конечный пользователь может отправить на ваш номер, чтобы получить ответ, например, информационное сообщение или специальное предложение. Когда ваш номер получает сообщение, начинающееся с ключевого слова, AWS End User Messaging SMS и Voice отвечает настраиваемым сообщением.

Если вы укажете неверное ключевое слово, будет возвращена ошибка.

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

Синтаксис

  put-keyword
--origination-identity <value>
--keyword <value>
--keyword-message <value>
[--keyword-action <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]

Параметры

--origination-identity (строка)

Идентификатор исходящего номера, например, PhoneNumberId, PhoneNumberArn, SenderId или SenderIdArn. Для получения значений PhoneNumberId и PhoneNumberArn можно использовать DescribePhoneNumbers, а для получения значений SenderId и SenderIdArn — DescribeSenderIds.

Предупреждение

Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то должны использовать полное имя ресурса Amazon (ARN).

--keyword (строка)

Новое ключевое слово для добавления.

--keyword-message (строка)

Сообщение, связанное с ключевым словом.

--keyword-action (строка)

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

  • AUTOMATIC_RESPONSE: получателю отправляется сообщение.
  • OPT_OUT: получатель больше не будет получать будущие сообщения.
  • OPT_IN: получатель хочет получать будущие сообщения.

Возможные значения:

  • AUTOMATIC_RESPONSE
  • OPT_OUT
  • OPT_IN

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

OriginationIdentityArn -> (строка)

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

OriginationIdentity -> (строка)

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

Keyword -> (строка)

Добавленное ключевое слово.

KeywordMessage -> (строка)

Сообщение, связанное с ключевым словом.

KeywordAction -> (строка)

Действие, которое должно быть выполнено при использовании ключевого слова.

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

Spec-Zone.ru

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