Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

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

Описание

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

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

Синтаксис

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

--name (строка)

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

--type (строка)

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

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

  • AGENT

--description (строка)

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

--tags (массив)

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

ключ -> (строка)

значение -> (строка)

Синтаксис сокращенной записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

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

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

kmsKeyId -> (строка)

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

Синтаксис сокращенной записи:

kmsKeyId=string

Синтаксис JSON:

{
  "kmsKeyId": "string"
}

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

Вывод

помощник -> (структура)

Информация о помощнике.

assistantId -> (строка)

Идентификатор помощника Amazon Q в Connect.

assistantArn -> (строка)

Amazon Resource Name (ARN) помощника Amazon Q в Connect.

имя -> (строка)

Имя.

тип -> (строка)

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

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

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

описание -> (строка)

Описание.

теги -> (массив)

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

ключ -> (строка)

значение -> (строка)

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

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

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

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

kmsKeyId -> (строка)

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

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

Конфигурационная информация для интеграции помощника Amazon Q в Connect.

topicIntegrationArn -> (строка)

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

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

Конфигурационная информация для возможности помощника Amazon Q в Connect.

тип -> (строка)

Тип возможности помощника Amazon Q в Connect.

aiAgentConfiguration -> (массив)

Настройка агентов ИИ (сопоставленная по типу агента ИИ с версией агента ИИ), установленная для помощника Amazon Q в Connect.

ключ -> (строка)

значение -> (структура)

Тип, который указывает данные конфигурации ID агента ИИ при сопоставлении агентов ИИ для использования для типа агента ИИ в сессии или помощнике.

aiAgentId -> (строка)

Идентификатор конфигурируемого агента ИИ.

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

Spec-Zone.ru

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