Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

list-data-source-sync-jobs

Описание

Получение информации о синхронизации подключения к источнику данных Amazon Q Business.

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

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

Синтаксис

  list-data-source-sync-jobs
--data-source-id <value>
--application-id <value>
--index-id <value>
[--start-time <value>]
[--end-time <value>]
[--status-filter <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]

Параметры

--data-source-id (строка)

Идентификатор подключения к источнику данных.

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

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

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

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

--start-time (метка времени)

Начальное время синхронизации подключения к источнику данных.

--end-time (метка времени)

Конечное время синхронизации подключения к источнику данных.

--status-filter (строка)

Возвращает только задания синхронизации с полем Status, равным указанному статусу.

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

  • FAILED
  • SUCCEEDED
  • SYNCING
  • INCOMPLETE
  • STOPPING
  • ABORTED
  • SYNCING_INDEXING

--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
  • текст
  • таблица
  • 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.

Вывод

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

История заданий синхронизации для подключения к источнику данных.

(структура)

Предоставляет информацию о задании синхронизации подключения к источнику данных Amazon Q Business.

executionId -> (строка)

Идентификатор задания синхронизации источника данных.

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

Маркер Unix времени начала задания синхронизации источника данных.

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

Маркер Unix времени завершения задания синхронизации.

status -> (строка)

Статус задания синхронизации. Когда поле Status установлено в значение SUCCEEDED, задание синхронизации выполнено. Если код состояния — FAILED, поля ErrorCode и ErrorMessage указывают причину ошибки.

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

Если поле Status установлено в значение FAILED, поле ErrorCode указывает причину сбоя синхронизации.

errorMessage -> (строка)

Сообщение, объясняющее ошибку запроса Amazon Q Business.

errorCode -> (строка)

Код, связанный с ошибкой запроса Amazon Q Business.

dataSourceErrorCode -> (строка)

Если причина сбоя синхронизации связана с ошибкой в подключенном источнике данных, это поле содержит код, идентифицирующий ошибку.

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

Сопоставляет запрос batch delete document с конкретным заданием синхронизации источника данных. Это необязательно и должно указываться только при удалении документов подключением к источнику данных.

documentsAdded -> (строка)

Текущее количество добавленных документов из источника данных во время синхронизации.

documentsModified -> (строка)

Текущее количество измененных документов в источнике данных во время синхронизации.

documentsDeleted -> (строка)

Текущее количество удаленных документов из источника данных во время синхронизации.

documentsFailed -> (строка)

Текущее количество документов, которые не удалось синхронизировать из источника данных во время синхронизации.

documentsScanned -> (строка)

Текущее количество документов, просмотренных текущим заданием синхронизации в источнике данных.

nextToken -> (строка)

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

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

Spec-Zone.ru

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