ListReportJobs - AWS Backup

ListReportJobs

Returns details about your report jobs.

Request Syntax

GET /audit/report-jobs?CreationAfter=ByCreationAfter&CreationBefore=ByCreationBefore&MaxResults=MaxResults&NextToken=NextToken&ReportPlanName=ByReportPlanName&Status=ByStatus HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ByCreationAfter

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

ByCreationBefore

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

ByReportPlanName

Returns only report jobs with the specified report plan name.

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

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

ByStatus

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

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", "ReportJobs": [ { "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.

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

ReportJobs

Details about your report jobs in JSON format.

Type: Array of ReportJob 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: