Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

обновить-шаблон-sms

Описание

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

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

Синтаксис

  update-sms-template
[--create-new-version | --no-create-new-version]
--sms-template-request <value>
--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]

Параметры

--create-new-version | --no-create-new-version (boolean)

Указывает, следует ли сохранить обновления в виде новой версии шаблона сообщения. Допустимые значения: true, сохранить обновления как новую версию; false, сохранить обновления в (перезаписать) последнюю существующую версию шаблона.

Если вы не укажете значение для этого параметра, Amazon Pinpoint сохранит обновления в (перезапишет) последнюю существующую версию шаблона. Если вы укажете значение true для этого параметра, не указывайте значение для параметра version. В противном случае произойдет ошибка.

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

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

Body -> (строка)

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

DefaultSubstitutions -> (строка)

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

RecommenderId -> (строка)

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

tags -> (массив)

Примечание

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

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

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

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

Сокращенная синтаксическая запись:

Body=string,DefaultSubstitutions=string,RecommenderId=string,tags={KeyName1=string,KeyName2=string},TemplateDescription=string

Синтаксис JSON:

{
  "Body": "string",
  "DefaultSubstitutions": "string",
  "RecommenderId": "string",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string"
}

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

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

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

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

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

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

  • Для операции get получает информацию об активной версии шаблона.
  • Для операции обновления сохраняет обновления в (перезаписывает) последнюю существующую версию шаблона, если параметр 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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

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

Message -> (строка)

Сообщение, возвращенное API.

RequestID -> (строка)

Уникальный идентификатор запроса или ответа.

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

Spec-Zone.ru

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