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 archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway architecture.

Note:

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

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

Syntax

C#
public virtual CancelArchivalResponse CancelArchival(
         CancelArchivalRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.CancelArchivalRequest

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

Return Value
The response from the CancelArchival 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 archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.

To cancel virtual tape archiving


var response = client.CancelArchival(new CancelArchivalRequest 
{
    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