StorageGateway / Client / retrieve_tape_recovery_point

retrieve_tape_recovery_point¶

StorageGateway.Client.retrieve_tape_recovery_point(**kwargs)¶

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

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

Note

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

Request Syntax

response = client.retrieve_tape_recovery_point(
    TapeARN='string',
    GatewayARN='string'
)

Parameters:

TapeARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
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.

Return type:

dict

Returns:

Response Syntax

{
    'TapeARN': 'string'
}

Response Structure

(dict) –

RetrieveTapeRecoveryPointOutput
- TapeARN (string) –
  
  The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError

Examples

Retrieves the recovery point for the specified virtual tape.

response = client.retrieve_tape_recovery_point(
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
)

print(response)

Expected Output:

{
    'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
    'ResponseMetadata': {
        '...': '...',
    },
}