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 CancelRetrieval operation. Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

Inheritance Hierarchy

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

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

Syntax

C#
public class CancelRetrievalRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CancelRetrievalRequest type exposes the following members

Constructors

NameDescription
Public Method CancelRetrievalRequest()

Properties

NameTypeDescription
Public Property GatewayARN System.String

Gets and sets the property GatewayARN.

Public Property TapeARN System.String

Gets and sets the property TapeARN.

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

Examples

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.

To cancel virtual tape retrieval


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

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