Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

get-task-template

Описание

Получает подробную информацию о конкретной шаблоне задачи в указанном экземпляре Amazon Connect.

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

Синтаксис

  get-task-template
--instance-id <value>
--task-template-id <value>
[--snapshot-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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Вы можете найти ID экземпляра в Amazon Resource Name (ARN) экземпляра.

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

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

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

Сгенерированная системой версия шаблона задачи, связанная с задачей при её создании.

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

InstanceId -> (строка)

Идентификатор экземпляра Amazon Connect. Вы можете найти ID экземпляра в Amazon Resource Name (ARN) экземпляра.

Id -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN).

Name -> (строка)

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

Description -> (строка)

Описание шаблона задачи.

ContactFlowId -> (строка)

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

SelfAssignFlowId -> (строка)

ContactFlowId для потока, который будет выполняться, если этот шаблон используется для создания самоназначенной задачи

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

Ограничения, которые применимы к указанным полям.

RequiredFields -> (список)

Список полей, которые должны быть заполнены агентами.

(структура)

Информация об обязательном поле.

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

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

Name -> (строка)

Название поля шаблона задачи.

ReadOnlyFields -> (список)

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

(структура)

Указывает поле, которое является только для чтения для агента.

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

Идентификатор поля только для чтения.

Name -> (строка)

Название поля шаблона задачи.

InvisibleFields -> (список)

Список полей, которые невидимы для агентов.

(структура)

Поле, которое невидимо для агента.

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

Идентификатор невидимого поля.

Name -> (строка)

Название поля шаблона задачи.

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

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

DefaultFieldValues -> (список)

Значение по умолчанию для поля.

(структура)

Описание поля по умолчанию и соответствующего значения.

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

Идентификатор поля.

Name -> (строка)

Название поля шаблона задачи.

DefaultValue -> (строка)

Значение по умолчанию для поля.

Fields -> (список)

Поля, которые являются частью шаблона.

(структура)

Описание одного поля шаблона задачи.

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

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

Name -> (строка)

Название поля шаблона задачи.

Description -> (строка)

Описание поля.

Type -> (строка)

Указывает тип поля.

SingleSelectOptions -> (список)

Список вариантов для поля с единственным выбором.

(строка)

Status -> (строка)

Отмечает шаблон как ACTIVE или INACTIVE для ссылки на него задачей. Задачи могут быть созданы только с помощью ACTIVE шаблонов. Если шаблон помечен как INACTIVE, то задача, ссылающаяся на этот шаблон, не может быть создана.

LastModifiedTime -> (временная метка)

Временная метка последнего изменения шаблона задачи.

CreatedTime -> (временная метка)

Временная метка создания шаблона задачи.

Tags -> (словарь)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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