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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCancelCluster and EndCancelCluster.

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

Syntax

C#
public abstract Task<CancelClusterResponse> CancelClusterAsync(
         CancelClusterRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Snowball.Model.CancelClusterRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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 Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also