Spec-Zone.ru › AWS CLI v2

[ aws . backupsearch ]

list-search-result-export-jobs

Описание

Данная операция экспортирует результаты поиска задания поиска в указанный целевой ведро S3.

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

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

Синтаксис

  list-search-result-export-jobs
[--status <value>]
[--search-job-identifier <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]

Параметры

--status (строка)

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

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

  • RUNNING
  • FAILED
  • COMPLETED

--search-job-identifier (строка)

Уникальная строка, определяющая задание поиска.

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

Вывод

ExportJobs -> (список)

Операция возвращает включенные задания экспорта.

(структура)

Это сводка задания экспорта.

ExportJobIdentifier -> (строка)

Это уникальная строка, которая идентифицирует конкретное задание экспорта.

ExportJobArn -> (строка)

Это уникальный ARN (имя ресурса Amazon), принадлежащий новому заданию экспорта.

Статус -> (строка)

Статус задания экспорта один из следующих:

CREATED ; RUNNING ; FAILED ; или COMPLETED .

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

Это метка времени создания задания экспорта.

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

Это метка времени завершения задания экспорта.

StatusMessage -> (строка)

Сообщение состояния — это строка, возвращаемая для задания экспорта.

Сообщение состояния включается для любого статуса, кроме COMPLETED без проблем.

SearchJobArn -> (строка)

Уникальная строка, идентифицирующая Amazon Resource Name (ARN) указанного задания поиска.

NextToken -> (строка)

Следующий элемент после частичного списка возвращенных резервных копий, включенных в задание поиска.

Например, если запрос выполняется для возврата MaxResults количества резервных копий, NextToken позволяет вернуть больше элементов в вашем списке, начиная с места, указанного маркером.

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

Spec-Zone.ru

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