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

DescribeRecoverySnapshots

Lists all Recovery Snapshots for a single Source Server.

Request Syntax


POST /DescribeRecoverySnapshots HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "fromDateTime": "string",
      "toDateTime": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "order": "string",
   "sourceServerID": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

A set of filters by which to return Recovery Snapshots.

Type: DescribeRecoverySnapshotsRequestFilters object

Required: No

maxResults

Maximum number of Recovery Snapshots to retrieve.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

nextToken

The token of the next Recovery Snapshot to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

order

The sorted ordering by which to return Recovery Snapshots.

Type: String

Valid Values: ASC | DESC

Required: No

sourceServerID

Filter Recovery Snapshots by Source Server ID.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^s-[0-9a-zA-Z]{17}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "ebsSnapshots": [ "string" ],
         "expectedTimestamp": "string",
         "snapshotID": "string",
         "sourceServerID": "string",
         "timestamp": "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.

items

An array of Recovery Snapshots.

Type: Array of RecoverySnapshot objects

nextToken

The token of the next Recovery Snapshot to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UninitializedAccountException

The account performing the request has not been initialized.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400