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.

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

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 BeginCancelJob and EndCancelJob.

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

Syntax

C#
public virtual Task<CancelJobResponse> CancelJobAsync(
         CancelJobRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ImportExport.Model.CancelJobRequest

Container for the necessary parameters to execute the CancelJob 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 CancelJob service method, as returned by ImportExport.

Exceptions

ExceptionCondition
CanceledJobIdException The specified job ID has been canceled and is no longer valid.
ExpiredJobIdException Indicates that the specified job has expired out of the system.
InvalidAccessKeyIdException The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidJobIdException The JOBID was missing, not found, or not associated with the AWS account.
InvalidVersionException The client tool version is invalid.
UnableToCancelJobIdException AWS Import/Export cannot cancel the job

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also