backup_create_report_plan: Creates a report plan

View source: R/backup_operations.R

backup_create_report_planR Documentation

Creates a report plan

Description

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

See https://www.paws-r-sdk.com/docs/backup_create_report_plan/ for full documentation.

Usage

backup_create_report_plan(
  ReportPlanName,
  ReportPlanDescription = NULL,
  ReportDeliveryChannel,
  ReportSetting,
  ReportPlanTags = NULL,
  IdempotencyToken = NULL
)

Arguments

ReportPlanName

[required] The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportPlanDescription

An optional description of the report plan with a maximum of 1,024 characters.

ReportDeliveryChannel

[required] A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportSetting

[required] Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

ReportPlanTags

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.


paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.