обновить-шаблон-голоса
Описание
Обновляет существующий шаблон сообщения для сообщений, отправляемых через голосовую каналы.
См. также: Документация API AWS
Синтаксис
update-voice-template
[--create-new-version | --no-create-new-version]
--template-name <value>
--voice-template-request <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]
Параметры
--create-new-version | --no-create-new-version (boolean)
Указывает, следует ли сохранить обновления в качестве новой версии шаблона сообщения. Допустимые значения: true — сохранить обновления в виде новой версии; false — сохранить обновления в (перезаписать) последнюю существующую версию шаблона.
Если вы не укажете значение для этого параметра, Amazon Pinpoint сохранит обновления в (перезапишет) последнюю существующую версию шаблона. Если вы укажете значение true для этого параметра, не указывайте значение для параметра version. В противном случае произойдёт ошибка.
--template-name (string)
--voice-template-request (структура)
Определяет содержимое и настройки шаблона сообщения, который может использоваться в сообщениях, отправляемых через голосовую каналы.
Body -> (строка)
DefaultSubstitutions -> (строка)
LanguageCode -> (строка)
tags -> (массив)
Примечание
По состоянию на 22-05-2023 теги были устарели для операций обновления. После этой даты любые значения в тегах не обрабатываются, и код ошибки не возвращается. Для управления тегами рекомендуется использовать теги в справочнике API Amazon Pinpoint, команды resourcegroupstaggingapi в документации AWS Command Line Interface или resourcegroupstaggingapi в AWS SDK.(Устарело) Массив пар «ключ-значение» строк, определяющий теги, которые необходимо связать с шаблоном сообщения. Каждый тег состоит из требуемого ключа тега и соответствующего значения тега.
key -> (строка)
value -> (строка)
TemplateDescription -> (строка)
VoiceId -> (строка)
Краткая запись:
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"
}
--template-version (строка)
Уникальный идентификатор версии шаблона сообщения для обновления, получения информации или удаления. Для получения идентификаторов и другой информации обо всех версиях шаблона используйте ресурс Template Versions.
Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Если указано для операции обновления, это значение должно соответствовать идентификатору последней существующей версии шаблона. Это ограничение помогает предотвратить возникновение условий гонки.
Если вы не укажете значение для этого параметра, Amazon Pinpoint выполнит следующие действия:
- Для операции получения — получит информацию о текущей версии шаблона.
- Для операции обновления — сохранит обновления в (перезапишет) последнюю существующую версию шаблона, если параметр create-new-version не используется или установлен в 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 (boolean)
Включить отладку.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- включить
- выключить
- автоматически
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запрошение параметров ввода CLI.
Вывод
MessageBody -> (структура)
Предоставляет информацию о запросе или ответе API.
Message -> (строка)
RequestID -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.