Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-restore-jobs-by-protected-resource

Описание

Возвращает задания восстановления, содержащие указанный защищённый ресурс.

Вы должны включить ResourceArn . Вы можете также включить NextToken , ByStatus , MaxResults , ByRecoveryPointCreationDateAfter и ByRecoveryPointCreationDateBefore .

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

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

Синтаксис

  list-restore-jobs-by-protected-resource
--resource-arn <value>
[--by-status <value>]
[--by-recovery-point-creation-date-after <value>]
[--by-recovery-point-creation-date-before <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]

Параметры

--resource-arn (строка)

Возвращает только задания восстановления, соответствующие указанному ресурсу Amazon Resource Name (ARN).

--by-status (строка)

Возвращает только задания восстановления, связанные с указанным статусом задания.

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

  • PENDING
  • RUNNING
  • COMPLETED
  • ABORTED
  • FAILED

--by-recovery-point-creation-date-after (отметка времени)

Возвращает только задания восстановления точек восстановления, созданных после указанной даты.

--by-recovery-point-creation-date-before (отметка времени)

Возвращает только задания восстановления точек восстановления, созданных до указанной даты.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

RestoreJobs -> (список)

Массив объектов, содержащих подробную информацию о заданиях восстановления сохраненных ресурсов.

(структура)

Содержит метаданные о задании восстановления.

AccountId -> (строка)

Идентификатор учетной записи, владеющей заданием восстановления.

RestoreJobId -> (строка)

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

RecoveryPointArn -> (строка)

ARN, уникально идентифицирующий точку восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

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

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

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

Status -> (строка)

Код состояния, указывающий состояние задания, инициированного Backup для восстановления точки восстановления.

StatusMessage -> (строка)

Подробное сообщение, объясняющее состояние задания восстановления точки восстановления.

PercentDone -> (строка)

Содержит оценочный процент завершения задания на момент запроса статуса задания.

BackupSizeInBytes -> (длинное целое)

Размер восстановленного ресурса в байтах.

IamRoleArn -> (строка)

IAM роль ARN, использованная для создания целевой точки восстановления; например, arn:aws:iam::123456789012:role/S3Access.

ExpectedCompletionTimeMinutes -> (длинное целое)

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

CreatedResourceArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий ресурс. Формат ARN зависит от типа ресурса.

ResourceType -> (строка)

Тип ресурса перечисленных заданий восстановления; например, том Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS). Для резервных копий Windows Volume Shadow Copy Service (VSS) поддерживается только тип ресурса Amazon EC2.

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

Дата создания точки восстановления.

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

Содержит идентифицирующую информацию о создании задания восстановления.

RestoreTestingPlanArn -> (строка)

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

ValidationStatus -> (строка)

Статус выполнения проверки на указанном задании восстановления.

ValidationStatusMessage -> (строка)

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

DeletionStatus -> (строка)

Это отмечает состояние данных, сгенерированных тестом восстановления. Состояние может быть Deleting , Failed или Successful.

DeletionStatusMessage -> (строка)

Это описывает состояние удаления задания восстановления.

NextToken -> (строка)

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

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

Spec-Zone.ru

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