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

DescribeReportJob

Returns the details associated with creating a report as specified by its ReportJobId.

Request Syntax

GET /audit/report-jobs/reportJobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

reportJobId

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.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ReportJob": { "CompletionTime": number, "CreationTime": number, "ReportDestination": { "S3BucketName": "string", "S3Keys": [ "string" ] }, "ReportJobId": "string", "ReportPlanArn": "string", "ReportTemplate": "string", "Status": "string", "StatusMessage": "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.

ReportJob

A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

Type: ReportJob object

Errors

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

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

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

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