Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

list-data-source-sync-jobs

Описание

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

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

Синтаксис

  list-data-source-sync-jobs
--id <value>
--index-id <value>
[--next-token <value>]
[--max-results <value>]
[--start-time-filter <value>]
[--status-filter <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]

Параметры

--id (строка)

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

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

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

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

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

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

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

--start-time-filter (структура)

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

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

Маркер Unix для начала временного интервала.

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

Маркер Unix для конца временного интервала.

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

StartTime=timestamp,EndTime=timestamp

Синтаксис JSON:

{
  "StartTime": timestamp,
  "EndTime": timestamp
}

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

--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 для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запрошенчие параметров ввода CLI.

Вывод

History -> (список)

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

(структура)

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

ExecutionId -> (строка)

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

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

Маркер Unix, когда началась задача синхронизации.

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

Маркер Unix, когда завершилась задача синхронизации.

Status -> (строка)

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

ErrorMessage -> (строка)

Если поле Status установлено в ERROR, поле ErrorMessage содержит описание ошибки, из-за которой синхронизация не удалась.

ErrorCode -> (строка)

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

DataSourceErrorCode -> (строка)

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

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

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

DocumentsAdded -> (строка)

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

DocumentsModified -> (строка)

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

DocumentsDeleted -> (строка)

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

DocumentsFailed -> (строка)

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

DocumentsScanned -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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