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

ListIndexedRecoveryPoints

This operation returns a list of recovery points that have an associated index, belonging to the specified account.

Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

Request Syntax


GET /indexes/recovery-point/?createdAfter=CreatedAfter&createdBefore=CreatedBefore&indexStatus=IndexStatus&maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType&sourceResourceArn=SourceResourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CreatedAfter

Returns only indexed recovery points that were created after the specified date.

CreatedBefore

Returns only indexed recovery points that were created before the specified date.

IndexStatus

Include this parameter to filter the returned list by the indicated statuses.

Accepted values: PENDING | ACTIVE | FAILED | DELETING

A recovery point with an index that has the status of ACTIVE can be included in a search.

Valid Values: PENDING | ACTIVE | FAILED | DELETING

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 recovery points.

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

ResourceType

Returns a list of indexed recovery points for the specified resource type(s).

Accepted values include:

EBS for Amazon Elastic Block Store
S3 for Amazon Simple Storage Service (Amazon S3)

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

SourceResourceArn

A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IndexedRecoveryPoints": [ 
      { 
         "BackupCreationDate": number,
         "BackupVaultArn": "string",
         "IamRoleArn": "string",
         "IndexCreationDate": number,
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "RecoveryPointArn": "string",
         "ResourceType": "string",
         "SourceResourceArn": "string"
      }
   ],
   "NextToken": "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.

IndexedRecoveryPoints

This is a list of recovery points that have an associated index, belonging to the specified account.

Type: Array of IndexedRecoveryPoint objects

NextToken

The next item following a partial list of returned recovery points.

Type: String

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

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