ListReportPlans - AWS Backup

ListReportPlans

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Request Syntax

GET /audit/report-plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ReportPlans": [ { "CreationTime": number, "DeploymentStatus": "string", "LastAttemptedExecutionTime": number, "LastSuccessfulExecutionTime": number, "ReportDeliveryChannel": { "Formats": [ "string" ], "S3BucketName": "string", "S3KeyPrefix": "string" }, "ReportPlanArn": "string", "ReportPlanDescription": "string", "ReportPlanName": "string", "ReportSetting": { "FrameworkArns": [ "string" ], "NumberOfFrameworks": number, "ReportTemplate": "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.

NextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Type: String

ReportPlans

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

Type: Array of ReportPlan objects

Errors

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

InvalidParameterValueException

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

HTTP Status Code: 400

ServiceUnavailableException

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 AWS SDKs, see the following: