Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

Список шаблонов (list-templates)

Описание

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

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

Синтаксис

  list-templates
[--next-token <value>]
[--page-size <value>]
[--prefix <value>]
[--template-type <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]

Параметры

--next-token (строка)

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

--page-size (строка)

Максимальное количество элементов на каждой странице постраничного ответа. Этот параметр не поддерживается для метрик приложений, кампаний и маршрутов.

--prefix (строка)

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

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

Тип шаблона сообщения, который нужно включить в результаты. Допустимые значения: EMAIL, PUSH, SMS и VOICE. Для включения всех типов шаблонов в результаты не указывайте этот параметр в запросе.

--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
  • текст
  • таблица
  • 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.

Вывод

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

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

Item -> (список)

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

(структура)

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

Arn -> (строка)

Amazon Resource Name (ARN) шаблона сообщения. Это значение не включено в объект TemplateResponse. Чтобы получить ARN шаблона, используйте операцию GetEmailTemplate, GetPushTemplate, GetSmsTemplate или GetVoiceTemplate в зависимости от типа шаблона, для которого вы хотите получить ARN.

CreationDate -> (строка)

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

DefaultSubstitutions -> (строка)

JSON-объект, задающий значения по умолчанию для переменных сообщений в шаблоне сообщения. Этот объект не включён в объект TemplateResponse. Чтобы получить этот объект для шаблона, используйте операцию GetEmailTemplate, GetPushTemplate, GetSmsTemplate или GetVoiceTemplate в зависимости от типа шаблона, для которого вы хотите получить этот объект.

LastModifiedDate -> (строка)

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

tags -> (карта)

Карта пар ключ-значение, идентифицирующих теги, связанные с шаблоном сообщения. Этот объект не включён в объект TemplateResponse. Чтобы получить этот объект для шаблона, используйте операцию GetEmailTemplate, GetPushTemplate, GetSmsTemplate или GetVoiceTemplate в зависимости от типа шаблона, для которого вы хотите получить этот объект.

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

Пользовательское описание шаблона сообщения. Это значение не включено в объект TemplateResponse. Чтобы получить описание шаблона, используйте операцию GetEmailTemplate, GetPushTemplate, GetSmsTemplate или GetVoiceTemplate в зависимости от типа шаблона.

TemplateName -> (строка)

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

TemplateType -> (строка)

Тип канала, для которого предназначен шаблон сообщения. Возможные значения: EMAIL, PUSH, SMS, INAPP и VOICE.

Version -> (строка)

Уникальный идентификатор активной версии шаблона сообщения в виде целого числа.

NextToken -> (строка)

Строка для использования в последующих запросах для получения следующей страницы результатов в постраничном ответе. Это значение равно null, если дополнительных страниц нет.

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

Spec-Zone.ru

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