Spec-Zone.ru › AWS CLI v2

[ aws . backupsearch ]

list-search-job-results

Описание

Данная операция возвращает список заданного поиска.

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

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

Синтаксис

  list-search-job-results
--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]

Параметры

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

Вывод

Результаты -> (список)

Результаты состоят из EBSResultItem или S3ResultItem.

(структура помеченного объединения)

Это объект, представляющий элемент, возвращенный в результатах поиска определенного типа ресурса.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: S3ResultItem, EBSResultItem.

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

Это элементы, возвращаемые в результатах поиска Amazon S3.

BackupResourceArn -> (строка)

Это элементы в возвращаемых результатах, которые соответствуют введённым в ходе поиска ARN точек восстановления Amazon Resource Name (ARN) Amazon S3 резервного копирования метаданных.

SourceResourceArn -> (строка)

Это элементы в возвращаемых результатах, которые соответствуют введённым в ходе поиска ARN исходных ресурсов Amazon Resource Name (ARN) Amazon S3 резервного копирования метаданных.

BackupVaultName -> (строка)

Имя хранилища резервных копий.

ObjectKey -> (строка)

Это один или несколько элементов, возвращаемых в результатах поиска метаданных резервного копирования Amazon S3, которые соответствуют введённым значениям для ключа объекта.

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

Это элементы в возвращаемых результатах, которые соответствуют значениям для размера(ов) объекта, введенных при поиске метаданных резервного копирования Amazon S3.

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

Это один или несколько элементов в возвращаемых результатах, которые соответствуют значениям для времени создания элемента, введенным при поиске метаданных резервного копирования Amazon S3.

ETag -> (строка)

Это один или несколько элементов в возвращаемых результатах, которые соответствуют значениям для ETag, введенным при поиске метаданных резервного копирования Amazon S3.

VersionId -> (строка)

Это один или несколько элементов в возвращаемых результатах, которые соответствуют значениям для идентификаторов версий, введенным при поиске метаданных резервного копирования Amazon S3.

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

Это элементы, возвращаемые в результатах поиска Amazon EBS.

BackupResourceArn -> (строка)

Это один или несколько элементов в результатах, которые соответствуют значениям для Amazon Resource Name (ARN) точек восстановления, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

SourceResourceArn -> (строка)

Это один или несколько элементов в результатах, которые соответствуют значениям для Amazon Resource Name (ARN) исходных ресурсов, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

BackupVaultName -> (строка)

Имя хранилища резервных копий.

FileSystemIdentifier -> (строка)

Это один или несколько элементов в результатах, которые соответствуют значениям для файловых систем, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

FilePath -> (строка)

Это один или несколько элементов в результатах, которые соответствуют значениям для путей к файлам, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

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

Это один или несколько элементов в результатах, которые соответствуют значениям для размеров файлов, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

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

Это один или несколько элементов в результатах, которые соответствуют значениям для времени создания, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

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

Это один или несколько элементов в результатах, которые соответствуют значениям для времени последнего изменения, возвращаемых при поиске метаданных резервного копирования Amazon EBS.

NextToken -> (строка)

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

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

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

Spec-Zone.ru

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