Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

list-data-sources

Описание

Отображает подключенные к Amazon Q Business источники данных, которые вы создали.

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

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

Синтаксис

  list-data-sources
--application-id <value>
--index-id <value>
[--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]

Параметры

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

Идентификатор приложения Amazon Q Business, связанного с подключенными источниками данных.

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

Идентификатор индекса, используемого с одним или несколькими подключенными источниками данных.

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

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

Маркер для указания, где следует начать постраничную обработку. Это NextToken из ранее усечённого ответа.

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

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

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

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

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

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

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

--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 (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

dataSources -> (список)

Массив сводной информации об одном или нескольких подключенных источниках данных.

(структура)

Источник данных в приложении Amazon Q Business.

displayName -> (строка)

Название источника данных Amazon Q Business.

dataSourceId -> (строка)

Идентификатор источника данных Amazon Q Business.

type -> (строка)

Тип источника данных Amazon Q Business.

createdAt -> (метка времени)

Метка времени Unix, когда был создан источник данных Amazon Q Business.

updatedAt -> (метка времени)

Метка времени Unix, когда источник данных Amazon Q Business был последний раз обновлён.

status -> (строка)

Статус источника данных Amazon Q Business.

nextToken -> (строка)

Если ответ усечён, Amazon Q Business возвращает этот маркер. Вы можете использовать этот маркер в последующем запросе для получения следующего набора подключенных источников данных.

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

Spec-Zone.ru

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