Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

создать-план-отчёта

Описание

Создаёт план отчёта. План отчёта — это документ, содержащий информацию о содержимом отчёта и о том, куда Backup его отправит.

Если вы вызываете CreateReportPlan с планом, который уже существует, вы получите исключение AlreadyExistsException.

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

Синтаксис

  create-report-plan
--report-plan-name <value>
[--report-plan-description <value>]
--report-delivery-channel <value>
--report-setting <value>
[--report-plan-tags <value>]
[--idempotency-token <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 (строка)

Уникальное имя плана отчёта. Имя должно быть длиной от 1 до 256 символов, начинаться с буквы и состоять из букв (a-z, A-Z), цифр (0-9) и символов подчёркивания (_).

--report-plan-description (строка)

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

--report-delivery-channel (структура)

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

S3BucketName -> (строка)

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

S3KeyPrefix -> (строка)

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

Formats -> (список)

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

(строка)

Краткая форма синтаксиса:

S3BucketName=string,S3KeyPrefix=string,Formats=string,string

Синтаксис JSON:

{
  "S3BucketName": "string",
  "S3KeyPrefix": "string",
  "Formats": ["string", ...]
}

--report-setting (структура)

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

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 (ARN) платформ, охватываемых отчётом.

(строка)

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

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

Accounts -> (список)

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

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

(строка)

OrganizationUnits -> (список)

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

(строка)

Regions -> (список)

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

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

(строка)

Краткая форма синтаксиса:

ReportTemplate=string,FrameworkArns=string,string,NumberOfFrameworks=integer,Accounts=string,string,OrganizationUnits=string,string,Regions=string,string

Синтаксис JSON:

{
  "ReportTemplate": "string",
  "FrameworkArns": ["string", ...],
  "NumberOfFrameworks": integer,
  "Accounts": ["string", ...],
  "OrganizationUnits": ["string", ...],
  "Regions": ["string", ...]
}

--report-plan-tags (отображение)

Теги, которые нужно назначить плану отчёта.

ключ -> (строка)

значение -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--idempotency-token (строка)

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

--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 версии 1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляющего двоичный блок 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.

Вывод

ReportPlanName -> (строка)

Уникальное имя плана отчёта.

ReportPlanArn -> (строка)

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

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

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

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

Spec-Zone.ru

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