Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-backup-plan-versions

Описание

Возвращает метаданные версий ваших планов резервного копирования, включая Amazon Resource Names (ARN), идентификаторы планов резервного копирования, даты создания и удаления, имена планов и идентификаторы версий.

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

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

Синтаксис

  list-backup-plan-versions
--backup-plan-id <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]

Параметры

--backup-plan-id (строка)

Уникально идентифицирует план резервного копирования.

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

Вывод

NextToken -> (строка)

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

BackupPlanVersionsList -> (список)

Массив элементов списка версий, содержащих метаданные о ваших планах резервного копирования.

(структура)

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

BackupPlanArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий план резервного копирования; например, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanId -> (строка)

Уникально идентифицирует план резервного копирования.

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

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

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

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

VersionId -> (строка)

Уникальные, случайным образом сгенерированные, кодированные в Unicode, UTF-8 строки длиной не более 1024 байтов. Идентификаторы версий не могут быть изменены.

BackupPlanName -> (строка)

Имя для отображения сохраненного плана резервного копирования.

CreatorRequestId -> (строка)

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

Если используется, этот параметр должен содержать от 1 до 50 буквенно-цифровых символов или символов «-_.»

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

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

AdvancedBackupSettings -> (список)

Содержит список BackupOptions для типа ресурса.

(структура)

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

ResourceType -> (строка)

Указывает объект, содержащий тип ресурса и параметры резервного копирования. Единственный поддерживаемый тип ресурса — экземпляры Amazon EC2 с Windows Volume Shadow Copy Service (VSS). Пример CloudFormation см. в образце шаблона CloudFormation для включения Windows VSS в Руководстве пользователя Backup.

Допустимые значения: EC2.

BackupOptions -> (словарь)

Указывает параметр резервного копирования для выбранного ресурса. Этот параметр доступен только для задач резервного копирования Windows VSS.

Допустимые значения:

Установите значение "WindowsVSS":"enabled", чтобы включить параметр резервного копирования WindowsVSS и создать резервную копию Windows VSS.

Установите значение "WindowsVSS":"disabled", чтобы создать обычную резервную копию. Параметр WindowsVSS по умолчанию не включен.

Если вы укажете недопустимый параметр, получите исключение InvalidParameterValueException.

Дополнительную информацию о резервных копиях Windows VSS см. в разделе Создание резервной копии Windows с поддержкой VSS.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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