Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

get-template

Описание

Возвращает детали запрошенного шаблона. Другие API шаблонов:

  • CreateTemplate
  • DeleteTemplate
  • ListTemplates
  • UpdateTemplate

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

Синтаксис

  get-template
--domain-id <value>
--template-id <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]

Параметры

--domain-id (строка)

Уникальный идентификатор домена случаев.

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

Уникальный идентификатор шаблона.

--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 (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

createdTime -> (метка времени)

Метка времени создания ресурса.

deleted -> (логическое значение)

Указывает, был ли ресурс удален.

description -> (строка)

Краткое описание шаблона.

lastModifiedTime -> (метка времени)

Метка времени создания или последнего изменения ресурса.

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

Настройка макетов, связанных с шаблоном.

defaultLayout -> (строка)

Уникальный идентификатор макета.

name -> (строка)

Название шаблона.

requiredFields -> (список)

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

(структура)

Список полей, которые должны иметь предоставленное значение для создания случая.

fieldId -> (строка)

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

rules -> (список)

Список правил случаев (также известных как условия полей случаев) в шаблоне.

(структура)

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

caseRuleId -> (строка)

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

fieldId -> (строка)

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

status -> (строка)

Статус шаблона.

tags -> (карта)

Карта пар ключ-значение, представляющих теги ресурса. Теги используются для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

templateArn -> (строка)

Amazon Resource Name (ARN) шаблона.

templateId -> (строка)

Уникальный идентификатор шаблона.

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

Spec-Zone.ru

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