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 a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Note:

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

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

Syntax

C#
public abstract CancelClusterResponse CancelCluster(
         CancelClusterRequest request
)
Parameters
request
Type: Amazon.Snowball.Model.CancelClusterRequest

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

Return Value
The response from the CancelCluster service method, as returned by Snowball.

Exceptions

ExceptionCondition
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Examples

This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.

To cancel a cluster job


var response = client.CancelCluster(new CancelClusterRequest 
{
    ClusterId = "CID123e4567-e89b-12d3-a456-426655440000"
});


            

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