Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

create-task-template

Описание

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

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

Синтаксис

  create-task-template
--instance-id <value>
--name <value>
[--description <value>]
[--contact-flow-id <value>]
[--self-assign-flow-id <value>]
[--constraints <value>]
[--defaults <value>]
[--status <value>]
--fields <value>
[--client-token <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. Вы можете найти идентификатор экземпляра в Amazon Resource Name (ARN) экземпляра.

--name (строка)

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

--description (строка)

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

--contact-flow-id (строка)

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

--self-assign-flow-id (строка)

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

--constraints (структура)

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

RequiredFields -> (список)

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

(структура)

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

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

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

Name -> (строка)

Имя поля шаблона задачи.

ReadOnlyFields -> (список)

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

(структура)

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

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

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

Name -> (строка)

Имя поля шаблона задачи.

InvisibleFields -> (список)

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

(структура)

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

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

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

Name -> (строка)

Имя поля шаблона задачи.

Синтаксис JSON:

{
  "RequiredFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ],
  "ReadOnlyFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ],
  "InvisibleFields": [
    {
      "Id": {
        "Name": "string"
      }
    }
    ...
  ]
}

--defaults (структура)

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

DefaultFieldValues -> (список)

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

(структура)

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

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

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

Name -> (строка)

Имя поля шаблона задачи.

DefaultValue -> (строка)

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

Синтаксис JSON:

{
  "DefaultFieldValues": [
    {
      "Id": {
        "Name": "string"
      },
      "DefaultValue": "string"
    }
    ...
  ]
}

--status (строка)

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

Возможные значения:

  • ACTIVE
  • INACTIVE

--fields (список)

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

(структура)

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

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

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

Name -> (строка)

Имя поля шаблона задачи.

Description -> (строка)

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

Type -> (строка)

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

SingleSelectOptions -> (список)

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

(строка)

Сокращённый синтаксис:

Id={Name=string},Description=string,Type=string,SingleSelectOptions=string,string ...

Синтаксис JSON:

[
  {
    "Id": {
      "Name": "string"
    },
    "Description": "string",
    "Type": "NAME"|"DESCRIPTION"|"SCHEDULED_TIME"|"QUICK_CONNECT"|"URL"|"NUMBER"|"TEXT"|"TEXT_AREA"|"DATE_TIME"|"BOOLEAN"|"SINGLE_SELECT"|"EMAIL"|"SELF_ASSIGN"|"EXPIRY_DURATION",
    "SingleSelectOptions": ["string", ...]
  }
  ...
]

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не предоставлено, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

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

Вывод

Id -> (строка)

Идентификатор ресурса шаблона задачи.

Arn -> (строка)

Amazon Resource Name (ARN) для ресурса шаблона задачи.

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

Spec-Zone.ru

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