UpdateReportPlan - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Request Syntax

PUT /audit/report-plans/reportPlanName HTTP/1.1 Content-type: application/json { "IdempotencyToken": "string", "ReportDeliveryChannel": { "Formats": [ "string" ], "S3BucketName": "string", "S3KeyPrefix": "string" }, "ReportPlanDescription": "string", "ReportSetting": { "Accounts": [ "string" ], "FrameworkArns": [ "string" ], "NumberOfFrameworks": number, "OrganizationUnits": [ "string" ], "Regions": [ "string" ], "ReportTemplate": "string" } }

URI Request Parameters

The request uses the following URI parameters.


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 (_).

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z][_a-zA-Z0-9]*

Required: Yes

Request Body

The request accepts the following data in JSON format.


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.

Type: String

Required: No


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.

Type: ReportDeliveryChannel object

Required: No


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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

Required: No


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


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.

Type: ReportSetting object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "ReportPlanArn": "string", "ReportPlanName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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.

Type: Timestamp


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

Type: String


The unique name of the report plan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z][_a-zA-Z0-9]*


For information about the errors that are common to all actions, see Common Errors.


Amazon Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

HTTP Status Code: 400


Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400


Indicates that a required parameter is missing.

HTTP Status Code: 400


A resource that is required for the action doesn't exist.

HTTP Status Code: 400


The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: