AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RetrieveTapeArchive operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.RetrieveTapeArchiveRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public class RetrieveTapeArchiveRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The RetrieveTapeArchiveRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property GatewayARN System.String

Gets and sets the property GatewayARN.

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.

Public Property TapeARN System.String

Gets and sets the property TapeARN.

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

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.

To retrieve an archived tape from the VTS


var client = new AmazonStorageGatewayClient();
var response = client.RetrieveTapeArchive(new RetrieveTapeArchiveRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
    TapeARN = "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
});

string tapeARN = response.TapeARN;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5