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

ListRestoreJobSummaries

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Request Syntax

GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountId

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

Pattern: ^[0-9]{12}$

AggregationPeriod

This is the period that sets the boundaries for returned results.

Acceptable values include

  • ONE_DAY for daily job count for the prior 14 days.

  • SEVEN_DAYS for the aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS for aggregated job count for prior 14 days.

Valid Values: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

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

NextToken

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ResourceType

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

State

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Valid Values: CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AggregationPeriod": "string", "NextToken": "string", "RestoreJobSummaries": [ { "AccountId": "string", "Count": number, "EndTime": number, "Region": "string", "ResourceType": "string", "StartTime": number, "State": "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.

AggregationPeriod

This is the period that sets the boundaries for returned results.

  • ONE_DAY for daily job count for the prior 14 days.

  • SEVEN_DAYS for the aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS for aggregated job count for prior 14 days.

Type: String

NextToken

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Type: String

RestoreJobSummaries

This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Type: Array of RestoreJobSummary 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 Amazon SDKs, see the following: