Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

описание-фреймворка

Описание

Возвращает сведения о фреймворке для указанного FrameworkName.

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

Синтаксис

  describe-framework
--framework-name <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]

Параметры

--framework-name (строка)

Уникальное имя фреймворка.

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

Вывод

FrameworkName -> (строка)

Уникальное имя фреймворка.

FrameworkArn -> (строка)

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

FrameworkDescription -> (строка)

Необязательное описание фреймворка.

FrameworkControls -> (список)

Контроли, составляющие фреймворк. Каждый контроль в списке имеет имя, параметры ввода и область.

(структура)

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

ControlName -> (строка)

Имя контроля. Это имя имеет длину от 1 до 256 символов.

ControlInputParameters -> (список)

Пара имен/значений.

(структура)

Параметры для контроля. Контроль может иметь ноль, одно или более параметров. Пример контроля с двумя параметрами: «частота плана резервного копирования не менее daily, а срок хранения не менее 1 year». Первый параметр — daily. Второй параметр — 1 year.

ParameterName -> (строка)

Имя параметра, например, BackupPlanFrequency.

ParameterValue -> (строка)

Значение параметра, например, hourly.

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

Область контроля. Область контроля определяет, что будет оцениваться контролем. Три примера областей контроля: конкретный план резервного копирования, все планы резервного копирования с определенным тегом или все планы резервного копирования.

Для получения дополнительной информации см. ` ControlScope . <https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html>`__

ComplianceResourceIds -> (список)

Идентификатор единственного ресурса Amazon Web Services, который вы хотите, чтобы область контроля содержала.

(строка)

ComplianceResourceTypes -> (список)

Описывает, включает ли область контроля один или несколько типов ресурсов, таких как EFS или RDS.

(строка)

Tags -> (карта)

Пара ключи-значения тегов, применяемые к этим ресурсам Amazon Web Services, которые вы хотите использовать для запуска оценки правила. Можно предоставить не более одной пары ключ-значение. Значение тега необязательно, но оно не может быть пустой строкой, если вы создаете или редактируете фреймворк из консоли (хотя значение может быть пустой строкой, если оно включено в шаблон CloudFormation).

Структура для назначения тега: [{"Key":"string","Value":"string"}].

key -> (строка)

value -> (строка)

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

Дата и время создания фреймворка в представлении ISO 8601. Значение CreationTime точно до миллисекунд. Например, 2020-07-10T15:00:00.000-08:00 соответствует 10 июля 2020 года в 15:00 по времени, отстающему от UTC на 8 часов.

DeploymentStatus -> (строка)

Статус развертывания фреймворка. Статусы:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

FrameworkStatus -> (строка)

Фреймворк состоит из одного или нескольких контролей. Каждый контроль управляет ресурсом, таким как планы резервного копирования, резервные копии, резервные хранилища или точки восстановления. Вы также можете включать или отключать запись Config для каждого ресурса. Статусы:

  • ACTIVE при включении записи для всех ресурсов, управляемых фреймворком.
  • PARTIALLY_ACTIVE при отключении записи для по крайней мере одного ресурса, управляемого фреймворком.
  • INACTIVE при отключении записи для всех ресурсов, управляемых фреймворком.
  • UNAVAILABLE при невозможности проверки состояния записи Backup в данный момент.

IdempotencyToken -> (строка)

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

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

Spec-Zone.ru

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