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

DescribeRecoveryInstances

Lists all Recovery Instances or multiple Recovery Instances by ID.

Request Syntax


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

{
   "filters": { 
      "recoveryInstanceIDs": [ "string" ],
      "sourceServerIDs": [ "string" ]
   },
   "maxResults": number,
   "nextToken": "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 Instances.

Type: DescribeRecoveryInstancesRequestFilters object

Required: No

maxResults

Maximum number of Recovery Instances to retrieve.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

nextToken

The token of the next Recovery Instance to retrieve.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "dataReplicationInfo": { 
            "dataReplicationError": { 
               "error": "string",
               "rawError": "string"
            },
            "dataReplicationInitiation": { 
               "startDateTime": "string",
               "steps": [ 
                  { 
                     "name": "string",
                     "status": "string"
                  }
               ]
            },
            "dataReplicationState": "string",
            "etaDateTime": "string",
            "lagDuration": "string",
            "replicatedDisks": [ 
               { 
                  "backloggedStorageBytes": number,
                  "deviceName": "string",
                  "replicatedStorageBytes": number,
                  "rescannedStorageBytes": number,
                  "totalStorageBytes": number
               }
            ],
            "stagingAvailabilityZone": "string"
         },
         "ec2InstanceID": "string",
         "ec2InstanceState": "string",
         "failback": { 
            "agentLastSeenByServiceDateTime": "string",
            "elapsedReplicationDuration": "string",
            "failbackClientID": "string",
            "failbackClientLastSeenByServiceDateTime": "string",
            "failbackInitiationTime": "string",
            "failbackJobID": "string",
            "failbackLaunchType": "string",
            "failbackToOriginalServer": boolean,
            "firstByteDateTime": "string",
            "state": "string"
         },
         "isDrill": boolean,
         "jobID": "string",
         "originAvailabilityZone": "string",
         "originEnvironment": "string",
         "pointInTimeSnapshotDateTime": "string",
         "recoveryInstanceID": "string",
         "recoveryInstanceProperties": { 
            "cpus": [ 
               { 
                  "cores": number,
                  "modelName": "string"
               }
            ],
            "disks": [ 
               { 
                  "bytes": number,
                  "ebsVolumeID": "string",
                  "internalDeviceName": "string"
               }
            ],
            "identificationHints": { 
               "awsInstanceID": "string",
               "fqdn": "string",
               "hostname": "string",
               "vmWareUuid": "string"
            },
            "lastUpdatedDateTime": "string",
            "networkInterfaces": [ 
               { 
                  "ips": [ "string" ],
                  "isPrimary": boolean,
                  "macAddress": "string"
               }
            ],
            "os": { 
               "fullString": "string"
            },
            "ramBytes": number
         },
         "sourceServerID": "string",
         "tags": { 
            "string" : "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 Instances.

Type: Array of RecoveryInstance objects

nextToken

The token of the next Recovery Instance 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