Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

list-ingestion-jobs

Описание

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

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

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

Синтаксис

  list-ingestion-jobs
--data-source-id <value>
[--filters <value>]
--knowledge-base-id <value>
[--sort-by <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 (строка)

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

--filters (список)

Содержит информацию о фильтрах для фильтрации данных.

(структура)

Определение фильтра для фильтрации данных.

attribute -> (строка)

Имя поля или атрибута для применения фильтра.

operator -> (строка)

Операция для применения к полю или атрибуту.

values -> (список)

Список значений, относящихся к полю или атрибуту.

(строка)

Краткая форма синтаксиса:

attribute=string,operator=string,values=string,string ...

Синтаксис JSON:

[
  {
    "attribute": "STATUS",
    "operator": "EQ",
    "values": ["string", ...]
  }
  ...
]

--knowledge-base-id (строка)

Уникальный идентификатор базы знаний для списка заданий по загрузке данных.

--sort-by (структура)

Содержит сведения о порядке сортировки данных.

attribute -> (строка)

Имя поля или атрибута для сортировки данных.

order -> (строка)

Порядок сортировки данных.

Краткая форма синтаксиса:

attribute=string,order=string

Синтаксис JSON:

{
  "attribute": "STATUS"|"STARTED_AT",
  "order": "ASCENDING"|"DESCENDING"
}

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

ingestionJobSummaries -> (список)

Список заданий по загрузке данных с информацией о каждом задании.

(структура)

Содержит сведения о задании загрузки данных.

dataSourceId -> (строка)

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

description -> (строка)

Описание задания загрузки данных.

ingestionJobId -> (строка)

Уникальный идентификатор задания загрузки данных.

knowledgeBaseId -> (строка)

Уникальный идентификатор базы знаний для задания загрузки данных.

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

Время начала задания загрузки данных.

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

Содержит статистику по заданию загрузки данных.

numberOfDocumentsDeleted -> (длинное целое число)

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

numberOfDocumentsFailed -> (длинное целое число)

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

numberOfDocumentsScanned -> (длинное целое число)

Общее количество исходных документов, которые были просканированы. Включает новые, обновленные и неизмененные документы.

numberOfMetadataDocumentsModified -> (длинное целое число)

Количество файлов метаданных, которые были обновлены или удалены.

numberOfMetadataDocumentsScanned -> (длинное целое число)

Общее количество файлов метаданных, которые были просканированы. Включает новые, обновленные и неизмененные файлы.

numberOfModifiedDocumentsIndexed -> (длинное целое число)

Количество измененных исходных документов в источнике данных, которые были успешно проиндексированы.

numberOfNewDocumentsIndexed -> (длинное целое число)

Количество новых исходных документов в источнике данных, которые были успешно проиндексированы.

status -> (строка)

Статус задания загрузки данных.

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

Время последнего обновления задания загрузки данных.

nextToken -> (строка)

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

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

Spec-Zone.ru

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