AmazonSnowballClient.CancelJob Method (CancelJobRequest)

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CancelJobAsync.

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

Syntax

public virtual CancelJobResponse CancelJob(
         CancelJobRequest request
)

Parameters

request: Type: Amazon.Snowball.Model.CancelJobRequest

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

Return Value

Type: CancelJobResponse

The response from the CancelJob service method, as returned by Snowball.

Exceptions

Exception	Condition
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.

Examples

This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.

To cancel a job for a Snowball device


var client = new AmazonSnowballClient();
var response = client.CancelJob(new CancelJobRequest 
{
    JobId = "JID123e4567-e89b-12d3-a456-426655440000"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonSnowballClient.CancelJob (CancelJobRequest)

Method