Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

DescribeTapeRecoveryPoints

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

Request Syntax

{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Limit

Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Marker

An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

Response Syntax

{
   "GatewayARN": "string",
   "Marker": "string",
   "TapeRecoveryPointInfos": [ 
      { 
         "TapeARN": "string",
         "TapeRecoveryPointTime": number,
         "TapeSizeInBytes": number,
         "TapeStatus": "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.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Marker

An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

TapeRecoveryPointInfos

An array of TapeRecoveryPointInfos that are available for the specified gateway.

Type: Array of TapeRecoveryPointInfo objects

Errors

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

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: