Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

describe-report-plan

Описание

Возвращает список всех планов отчетов для учетной записи Amazon Web Services и региона Amazon Web Services.

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

Синтаксис

  describe-report-plan
--report-plan-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]

Параметры

--report-plan-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
  • 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.

Вывод

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

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

ReportPlanArn -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN), который однозначно определяет ресурс. Формат ARN зависит от типа ресурса.

ReportPlanName -> (строка)

Уникальное имя плана отчета. Это имя состоит из 1–256 символов, начинается с буквы и состоит из букв (a-я, А-Я), цифр (0-9) и символов подчеркивания (_).

ReportPlanDescription -> (строка)

Необязательное описание плана отчета с максимальной длиной 1024 символа.

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

Определяет шаблон отчета для отчета. Отчеты создаются с использованием шаблона отчета. Шаблоны отчетов:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

Если шаблон отчета является RESOURCE_COMPLIANCE_REPORT или CONTROL_COMPLIANCE_REPORT, этот ресурс API также описывает охват отчета по регионам Amazon Web Services и фреймворкам.

ReportTemplate -> (строка)

Определяет шаблон отчета для отчета. Отчеты создаются с использованием шаблона отчета. Шаблоны отчетов:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

FrameworkArns -> (список)

Имена Amazon Resource Names (ARN) фреймворков, охватываемых отчетом.

(строка)

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

Количество фреймворков, охватываемых отчетом.

Accounts -> (список)

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

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

(строка)

OrganizationUnits -> (список)

Это организационные подразделения, которые должны быть включены в отчет.

(строка)

Regions -> (список)

Это регионы, которые должны быть включены в отчет.

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

(строка)

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

Содержит информацию о том, куда и как доставлять отчеты, а именно имя ведра Amazon S3, префикс ключа S3 и форматы отчетов.

S3BucketName -> (строка)

Уникальное имя ведра S3, которое получает отчеты.

S3KeyPrefix -> (строка)

Префикс для местоположения, в которое Backup Audit Manager доставляет отчеты в Amazon S3. Префикс — это часть следующего пути: s3://ваш-имя-ведра/prefix /Backup/us-west-2/год/месяц/день/имя-отчета. Если не указан, префикс отсутствует.

Formats -> (список)

Формат отчетов: CSV , JSON или оба. Если не указан, формат по умолчанию — CSV.

(строка)

DeploymentStatus -> (строка)

Статус развертывания плана отчета. Статусы:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

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

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

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

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

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

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

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

Spec-Zone.ru

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