Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

list-assistants

Описание

Выводит информацию об ассистентах.

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

list-assistants это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих запросов: assistantSummaries

Синтаксис

  list-assistants
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, так как строка будет интерпретироваться буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

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

Токен для указания начальной точки постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для запроса в службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов службы AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

assistantSummaries -> (список)

Информация об ассистентах.

(структура)

Сводная информация об ассистенте.

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 -> (массив)

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

key -> (строка)

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

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

aiAgentId -> (строка)

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

nextToken -> (строка)

Если существуют дополнительные результаты, это токен для следующего набора результатов.

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

Spec-Zone.ru

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