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.

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

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.ElasticTranscoder
Assembly: AWSSDK.ElasticTranscoder.dll
Version: 3.x.y.z

Syntax

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

Parameters

request
Type: Amazon.ElasticTranscoder.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 ElasticTranscoder.

Exceptions

ExceptionCondition
AccessDeniedException General authentication failure. The request was not signed correctly.
IncompatibleVersionException
InternalServiceException Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ResourceInUseException The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
ResourceNotFoundException The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
ValidationException One or more required parameter values were not provided in the request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also