Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

создать-шаблон

Описание

Создает шаблон в домене Случаев. Этот шаблон используется для определения модели объекта случая (то есть для определения данных, которые могут быть зафиксированы в случае) в домене Случаев. Шаблон должен иметь уникальное имя в рамках домена и должен ссылаться на существующие идентификаторы полей и макетов. Кроме того, несколько полей с одинаковыми идентификаторами не допускаются в одном шаблоне. Шаблон может быть либо Активным, либо Неактивным, что определяется его статусом. Неактивные шаблоны нельзя использовать для создания случаев.

Другие API шаблонов:

  • DeleteTemplate
  • GetTemplate
  • ListTemplates
  • UpdateTemplate

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

Синтаксис

  create-template
[--description <value>]
--domain-id <value>
[--layout-configuration <value>]
--name <value>
[--required-fields <value>]
[--rules <value>]
[--status <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]

Параметры

--description (строка)

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

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

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

--layout-configuration (структура)

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

defaultLayout -> (строка)

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

Упрощенный синтаксис:

defaultLayout=string

Синтаксис JSON:

{
  "defaultLayout": "string"
}

--name (строка)

Имя шаблона. Оно должно быть уникальным для каждого домена.

--required-fields (список)

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

(структура)

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

fieldId -> (строка)

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

Упрощенный синтаксис:

fieldId=string ...

Синтаксис JSON:

[
  {
    "fieldId": "string"
  }
  ...
]

--rules (список)

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

(структура)

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

caseRuleId -> (строка)

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

fieldId -> (строка)

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

Упрощенный синтаксис:

caseRuleId=string,fieldId=string ...

Синтаксис JSON:

[
  {
    "caseRuleId": "string",
    "fieldId": "string"
  }
  ...
]

--status (строка)

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

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

  • Active
  • Inactive

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

Вывод

templateArn -> (строка)

Amazon Resource Name (ARN) вновь созданного шаблона.

templateId -> (строка)

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

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

Spec-Zone.ru

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