Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

создать-помощника

Описание

Создаёт помощника Amazon Connect Wisdom.

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

Синтаксис

  create-assistant
[--client-token <value>]
[--description <value>]
--name <value>
[--server-side-encryption-configuration <value>]
[--tags <value>]
--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]

Параметры

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

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

--description (строка)

Описание помощника.

--name (строка)

Имя помощника.

--server-side-encryption-configuration (структура)

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

Ключ управляемого клиентом должен иметь политику, которая разрешает kms:CreateGrant , kms:DescribeKey , и kms:Decrypt/kms:GenerateDataKey разрешения IAM-сущности, использующей ключ для вызова Wisdom. Для использования Wisdom с чатом политика ключа также должна разрешать kms:Decrypt , kms:GenerateDataKey* , и kms:DescribeKey разрешения для сервисного принципала connect.amazonaws.com.

Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашей инстанции.

kmsKeyId -> (строка)

Ключ управляемого клиентом, используемый для шифрования. Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашей инстанции. Сведения о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId).

Краткая форма синтаксиса:

kmsKeyId=string

Синтаксис JSON:

{
  "kmsKeyId": "string"
}

--tags (массив)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--type (строка)

Тип помощника.

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

  • AGENT

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

Вывод

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

Сведения о помощнике.

assistantArn -> (строка)

Amazon Resource Name (ARN) помощника Wisdom.

assistantId -> (строка)

Идентификатор помощника Wisdom.

description -> (строка)

Описание.

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

Сведения о конфигурации интеграции помощника Wisdom.

topicIntegrationArn -> (строка)

Amazon Resource Name (ARN) интегрированной темы Amazon SNS, используемой для потоковой передачи сообщений чата.

name -> (строка)

Имя.

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

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

Ключ KMS должен иметь политику, которая разрешает kms:CreateGrant , kms:DescribeKey , и kms:Decrypt/kms:GenerateDataKey разрешения для IAM-сущности, использующей ключ для вызова Wisdom. Для использования Wisdom с чатом политика ключа также должна разрешать kms:Decrypt , kms:GenerateDataKey* , и kms:DescribeKey разрешения для сервисного принципала connect.amazonaws.com.

Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашей инстанции.

kmsKeyId -> (строка)

Ключ управляемого клиентом, используемый для шифрования. Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашей инстанции. Сведения о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId).

status -> (строка)

Статус помощника.

tags -> (массив)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

type -> (строка)

Тип помощника.

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

Spec-Zone.ru

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