Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backup ]

update-report-plan

Description

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-report-plan
--report-plan-name <value>
[--report-plan-description <value>]
[--report-delivery-channel <value>]
[--report-setting <value>]
[--idempotency-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--report-plan-name (string)

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

--report-plan-description (string)

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

--report-delivery-channel (structure)

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

S3BucketName -> (string)

The unique name of the S3 bucket that receives your reports.

S3KeyPrefix -> (string)

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

Formats -> (list)

A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--report-setting (structure)

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.

ReportTemplate -> (string)

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

FrameworkArns -> (list)

The Amazon Resource Names (ARNs) of the frameworks a report covers.

(string)

NumberOfFrameworks -> (integer)

The number of frameworks a report covers.

Shorthand Syntax:

ReportTemplate=string,FrameworkArns=string,string,NumberOfFrameworks=integer

JSON Syntax:

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

--idempotency-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ReportPlanName -> (string)

The unique name of the report plan.

ReportPlanArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

CreationTime -> (timestamp)

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.