Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSearchJobBackups

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

Request Syntax


GET /search-jobs/SearchJobIdentifier/backups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of resource list items to be returned.

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

NextToken

The next item following a partial list of returned backups included in a search job.

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

SearchJobIdentifier

The unique string that specifies the search job.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "BackupCreationTime": number,
         "BackupResourceArn": "string",
         "IndexCreationTime": number,
         "ResourceType": "string",
         "SourceResourceArn": "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

The next item following a partial list of returned backups included in a search job.

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

Type: String

Results

The recovery points returned the results of a search job

Type: Array of SearchJobBackupsResult objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400