Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

получить-помощника

Описание

Получает информацию о помощнике.

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

Синтаксис

  get-assistant
--assistant-id <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]

Параметры

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

Идентификатор помощника Amazon Q in Connect. Может быть либо идентификатором, либо ARN. В URL не может содержаться ARN.

--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
  • text
  • таблица
  • 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 in Connect.

assistantArn -> (строка)

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

name -> (строка)

Имя.

type -> (строка)

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

status -> (строка)

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

description -> (строка)

Описание.

tags -> (массив)

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

key -> (строка)

value -> (строка)

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

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

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

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

kmsKeyId -> (строка)

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

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

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

topicIntegrationArn -> (строка)

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

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

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

type -> (строка)

Тип функции помощника Amazon Q in Connect.

aiAgentConfiguration -> (массив)

Конфигурация AI-агентов (отображается по типу AI-агента на версию AI-агента), настроенная для помощника Amazon Q in Connect.

key -> (строка)

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

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

aiAgentId -> (строка)

Идентификатор AI-агента, подлежащий настройке.

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

Spec-Zone.ru

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