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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to CancelRetrievalAsync.

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

Syntax

C#
public abstract CancelRetrievalResponse CancelRetrieval(
         CancelRetrievalRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.CancelRetrievalRequest

Container for the necessary parameters to execute the CancelRetrieval service method.

Return Value
The response from the CancelRetrieval service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

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 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 Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also