Spec-Zone.ru › AWS CLI v2

[ aws . backupsearch ]

get-search-job

Описание

Этот оператор извлекает метаданные задания поиска, включая его прогресс.

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

Синтаксис

  get-search-job
--search-job-identifier <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]

Параметры

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

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

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--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-auto-prompt (булево)

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

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

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

Результат

Имя -> (строка)

Возвращает имя указанной задачи поиска.

Сводка охватываемого поиска -> (структура)

Возвращает сводку области поиска указанной задачи поиска, включая:

  • TotalBackupsToScanCount, количество точек восстановления, возвращенных по результатам поиска.
  • TotalItemsToScanCount, количество элементов, возвращенных по результатам поиска.

TotalRecoveryPointsToScanCount -> (целое число)

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

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

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

Текущий прогресс поиска -> (структура)

Возвращает числа, представляющие BackupsScannedCount, ItemsScanned и ItemsMatched.

RecoveryPointsScannedCount -> (целое число)

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

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

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

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

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

Сообщение о статусе -> (строка)

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

Например, сообщение может указывать, что поиск содержал точки восстановления, которые невозможно было просканировать из-за проблемы с правами.

EncryptionKeyArn -> (строка)

Ключ шифрования для указанной задачи поиска.

Пример: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

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

Дата и время завершения задачи поиска в формате Unix и по координированному всемирному времени (UTC). Значение CompletionTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

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

Текущий статус указанной задачи поиска.

Задача поиска может иметь один из следующих статусов: RUNNING ; COMPLETED ; STOPPED ; FAILED ; TIMED_OUT ; или EXPIRED .

Область поиска -> (структура)

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

BackupResourceTypes -> (список)

Типы ресурсов, включенные в поиск.

Допустимые типы ресурсов включают S3 и EBS.

(строка)

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

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

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

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

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

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

SourceResourceArns -> (список)

Идентификатор ресурса Amazon (ARN), уникально идентифицирующий исходные ресурсы.

(строка)

BackupResourceArns -> (список)

Идентификатор ресурса Amazon (ARN), уникально идентифицирующий ресурсы резервных копий.

(строка)

BackupResourceTags -> (карта)

Это один или несколько тегов резервной копии (точки восстановления).

ключ -> (строка)

значение -> (строка)

Фильтры элементов -> (структура)

Фильтры элементов представляют все вводимые свойства элементов, указанные при создании поиска.

S3ItemFilters -> (список)

Этот массив может содержать объекты CreationTimes, ETags, ObjectKeys, Sizes или VersionIds.

(структура)

Это содержит массивы объектов, которые могут включать ObjectKeys, Sizes, CreationTimes, VersionIds и/или Etags.

ObjectKeys -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Это содержит значение строки и может содержать один или несколько операторов.

Значение -> (строка)

Значение строки.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

Sizes -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Условие типа «длинное целое число» содержит Value и может дополнительно содержать Operator.

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

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

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

CreationTimes -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Условие времени обозначает время создания, последнее время изменения или другое время.

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

Это значение метки времени для условия времени.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

VersionIds -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Это содержит значение строки и может содержать один или несколько операторов.

Значение -> (строка)

Значение строки.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

ETags -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Это содержит значение строки и может содержать один или несколько операторов.

Значение -> (строка)

Значение строки.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

EBSItemFilters -> (список)

Этот массив может содержать объекты CreationTimes, FilePaths, LastModificationTimes или Sizes.

(структура)

Это содержит массивы объектов, которые могут включать объекты условных времен CreationTimes, строковые объекты FilePaths, объекты условного времени LastModificationTimes,

FilePaths -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Это содержит значение строки и может содержать один или несколько операторов.

Значение -> (строка)

Значение строки.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

Sizes -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Условие типа «длинное целое число» содержит Value и может дополнительно содержать Operator.

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

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

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

CreationTimes -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Условие времени обозначает время создания, последнее время изменения или другое время.

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

Это значение метки времени для условия времени.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

LastModificationTimes -> (список)

Можно включить от 1 до 10 значений.

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

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

(структура)

Условие времени обозначает время создания, последнее время изменения или другое время.

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

Это значение метки времени для условия времени.

Оператор -> (строка)

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

При включении избегайте сочетаний операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.

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

Дата и время создания задания поиска в формате Unix и по координированному всемирному времени (UTC). Значение CompletionTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

SearchJobIdentifier -> (строка)

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

SearchJobArn -> (строка)

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

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

Spec-Zone.ru

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