Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-backup-plans

Описание

Отображает активные планы резервного копирования для учетной записи.

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

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

Синтаксис

  list-backup-plans
[--include-deleted | --no-include-deleted]
[--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]

Параметры

--include-deleted | --no-include-deleted (boolean)

Булево значение по умолчанию FALSE, которое возвращает удаленные планы резервного копирования при установке в значение TRUE .

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (string)

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

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--page-size (integer)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--max-items (integer)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выводит пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включает отладку логов.

--endpoint-url (string)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключает автоматический постраничный вывод. Если автоматический постраничный вывод отключен, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использование определенного профиля из файла учетных данных.

--region (string)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных данных. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

NextToken -> (string)

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

BackupPlansList -> (list)

Информация о планах резервного копирования.

(структура)

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

BackupPlanArn -> (string)

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

BackupPlanId -> (string)

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

CreationDate -> (timestamp)

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

DeletionDate -> (timestamp)

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

VersionId -> (string)

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

BackupPlanName -> (string)

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

CreatorRequestId -> (string)

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

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

LastExecutionDate -> (timestamp)

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

AdvancedBackupSettings -> (list)

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

(структура)

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

ResourceType -> (string)

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

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

BackupOptions -> (map)

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

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

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

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

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

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

ключ -> (string)

значение -> (string)

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

Spec-Zone.ru

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