Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

create-voice-template

Описание

Создает шаблон сообщения для сообщений, отправляемых через голосовой канал.

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

Синтаксис

  create-voice-template
--template-name <value>
--voice-template-request <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]

Параметры

--template-name (строка)

Имя шаблона сообщения. Имя шаблона должно начинаться с буквенно-цифрового символа и может содержать не более 128 символов. Символы могут быть буквенно-цифровыми, символами подчеркивания (_) или дефисами (-). Имена шаблонов чувствительны к регистру.

--voice-template-request (структура)

Указывает содержимое и настройки шаблона сообщения, который может использоваться в сообщениях, отправляемых через голосовой канал.

Body -> (строка)

Текст скрипта для использования в сообщениях, основанных на шаблоне сообщения, в формате простого текста.

DefaultSubstitutions -> (строка)

Объект JSON, который указывает значения по умолчанию для переменных сообщения в шаблоне сообщения. Этот объект представляет собой набор пар ключ-значение. Каждый ключ определяет переменную сообщения в шаблоне. Соответствующее значение определяет значение по умолчанию для этой переменной. При создании сообщения, основанного на шаблоне, вы можете переопределить эти значения по умолчанию с помощью переменных и значений, специфичных для сообщения и адреса.

LanguageCode -> (строка)

Код языка, который следует использовать при синтезировании текста скрипта в сообщениях, основанных на шаблоне сообщения. Список поддерживаемых языков и соответствующих кодов см. в руководстве разработчика Amazon Polly.

tags -> (карта)

Примечание

Начиная с 22-05-2023, параметр tags устарел для операций обновления. После этой даты любые значения в tags не обрабатываются, и код ошибки не возвращается. Для управления тегами рекомендуется использовать теги в разделе Ссылка на API Amazon Pinpoint, команды resourcegroupstaggingapi в Документации AWS Command Line Interface или resourcegroupstaggingapi в AWS SDK.

(Устарело) Карта пар ключ-значение, определяющая теги, которые следует связать с шаблоном сообщения. Каждый тег состоит из требуемого ключа тега и соответствующего значения тега.

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

Пользовательское описание шаблона сообщения.

VoiceId -> (строка)

Имя голоса, которое следует использовать при передаче сообщений, основанных на шаблоне сообщения. Список поддерживаемых голосов см. в руководстве разработчика Amazon Polly.

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

Body=string,DefaultSubstitutions=string,LanguageCode=string,tags={KeyName1=string,KeyName2=string},TemplateDescription=string,VoiceId=string

Синтаксис JSON:

{
  "Body": "string",
  "DefaultSubstitutions": "string",
  "LanguageCode": "string",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string",
  "VoiceId": "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
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

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

Предоставляет информацию о запросе на создание шаблона сообщения.

Arn -> (строка)

Amazon Resource Name (ARN) шаблона сообщения, который был создан.

Message -> (строка)

Сообщение, возвращаемое API для запроса создания шаблона сообщения.

RequestID -> (строка)

Уникальный идентификатор запроса на создание шаблона сообщения.

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

Spec-Zone.ru

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