Skip to content

Create Report Plan

backup_create_report_plan R 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.

If you call create_report_plan with a plan that already exists, you receive an AlreadyExistsException exception.

Usage

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

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

The tags to assign to the report plan.

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.

Value

A list with the following syntax: 

list(
  ReportPlanName = "string",
  ReportPlanArn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_report_plan(
  ReportPlanName = "string",
  ReportPlanDescription = "string",
  ReportDeliveryChannel = list(
    S3BucketName = "string",
    S3KeyPrefix = "string",
    Formats = list(
      "string"
    )
  ),
  ReportSetting = list(
    ReportTemplate = "string",
    FrameworkArns = list(
      "string"
    ),
    NumberOfFrameworks = 123,
    Accounts = list(
      "string"
    ),
    OrganizationUnits = list(
      "string"
    ),
    Regions = list(
      "string"
    )
  ),
  ReportPlanTags = list(
    "string"
  ),
  IdempotencyToken = "string"
)