StorageGateway / Client / retrieve_tape_archive

retrieve_tape_archive#

StorageGateway.Client.retrieve_tape_archive(**kwargs)#

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

See also: AWS API Documentation

Request Syntax

response = client.retrieve_tape_archive(
    TapeARN='string',
    GatewayARN='string'
)
Parameters:

  • TapeARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

  • GatewayARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

Return type:

dict

Returns:

Response Syntax

{
    'TapeARN': 'string'
}

Response Structure

  • (dict) –

    RetrieveTapeArchiveOutput

    • TapeARN (string) –

      The Amazon Resource Name (ARN) of the retrieved virtual tape.

Exceptions

Examples

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.

response = client.retrieve_tape_archive(
    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': {
        '...': '...',
    },
}