StorageGateway / Client / describe_tape_recovery_points

describe_tape_recovery_points#

StorageGateway.Client.describe_tape_recovery_points(**kwargs)#

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

response = client.describe_tape_recovery_points(
    GatewayARN='string',
    Marker='string',
    Limit=123
)

Parameters:

GatewayARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Marker (string) – An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
Limit (integer) – Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'TapeRecoveryPointInfos': [
        {
            'TapeARN': 'string',
            'TapeRecoveryPointTime': datetime(2015, 1, 1),
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) –

DescribeTapeRecoveryPointsOutput
- GatewayARN (string) –
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
- TapeRecoveryPointInfos (list) –
  
  An array of TapeRecoveryPointInfos that are available for the specified gateway.
  - (dict) –
    
    Describes a recovery point.
    - TapeARN (string) –
      
      The Amazon Resource Name (ARN) of the virtual tape.
    - TapeRecoveryPointTime (datetime) –
      
      The time when the point-in-time view of the virtual tape was replicated for later recovery.
      
      The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD’T’HH:MM:SS’Z’ format.
    - TapeSizeInBytes (integer) –
      
      The size, in bytes, of the virtual tapes to recover.
    - TapeStatus (string) –
      
      The status of the virtual tapes.
- Marker (string) –
  
  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.

Exceptions

Examples

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

response = client.describe_tape_recovery_points(
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    Limit=1,
    Marker='1',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'Marker': '1',
    'TapeRecoveryPointInfos': [
        {
            'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
            'TapeRecoveryPointTime': datetime(2016, 12, 16, 13, 50, 0, 4, 351, 0),
            'TapeSizeInBytes': 1471550497,
            'TapeStatus': 'AVAILABLE',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}