Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

получить-шаблон-голоса

Описание

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

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

Синтаксис

  get-voice-template
--template-name <value>
[--template-version <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 символов. Символы могут быть буквенно-цифровыми, символами подчеркивания (_) или дефисами (-). Имена шаблонов чувствительны к регистру.

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

Уникальный идентификатор версии шаблона сообщения для обновления, получения информации или удаления. Чтобы получить идентификаторы и другую информацию обо всех версиях шаблона, используйте ресурс «Шаблоны версий».

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

Если вы не указываете значение для этого параметра, Amazon Pinpoint выполняет следующие действия:

  • Для операции получения извлекает информацию об активной версии шаблона.
  • Для операции обновления сохраняет обновления в (заменяет) последней существующей версии шаблона, если параметр создать-новую-версию не используется или имеет значение false.
  • Для операции удаления удаляет шаблон, включая все версии шаблона.

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

Вывод

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

Предоставляет информацию о содержимом и настройках шаблона сообщения, который может использоваться в сообщениях, отправляемых по голосовому каналу.

Arn -> (строка)

Amazon Resource Name (ARN) шаблона сообщения.

Body -> (строка)

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

CreationDate -> (строка)

Дата создания шаблона сообщения в формате ISO 8601.

DefaultSubstitutions -> (строка)

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

LanguageCode -> (строка)

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

LastModifiedDate -> (строка)

Дата последнего изменения шаблона сообщения в формате ISO 8601.

tags -> (карта)

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

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

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

TemplateName -> (строка)

Имя шаблона сообщения.

TemplateType -> (строка)

Тип канала, для которого предназначен шаблон сообщения. Для шаблона голоса это значение равно VOICE.

Version -> (строка)

Уникальный идентификатор, как целое число, для активной версии шаблона сообщения или версии шаблона, указанной вами с помощью параметра version в вашем запросе.

VoiceId -> (строка)

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

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

Spec-Zone.ru

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