StartReportJob - 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).


Starts an on-demand report job for the specified report plan.

Request Syntax

POST /audit/report-jobs/reportPlanName HTTP/1.1 Content-type: application/json { "IdempotencyToken": "string" }

URI Request Parameters

The request uses the following URI parameters.


The unique name of a report plan.

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 StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ReportJobId": "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 identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Type: String


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


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: