Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

обновить-план-отчёта

Описание

Обновляет указанный план отчёта.

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

Синтаксис

  update-report-plan
--report-plan-name <value>
[--report-plan-description <value>]
[--report-delivery-channel <value>]
[--report-setting <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 -> (список)

Имена ресурсов (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", ...]
}

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

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

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

--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено значение NULL или 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.

Вывод

ReportPlanName -> (строка)

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

ReportPlanArn -> (строка)

Идентификатор ресурса (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