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 the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned.

Note:

For PCL 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

C#
public abstract CancelJobResponse CancelJob(
         CancelJobRequest request
)
Parameters
request
Type: Amazon.Snowball.Model.CancelJobRequest

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

Return Value
The response from the CancelJob 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 job. You can only cancel a job before its JobState value changes to PreparingAppliance.

To cancel a job for a Snowball device


var response = client.CancelJob(new CancelJobRequest 
{
    JobId = "JID123e4567-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