ElasticTranscoder / Client / cancel_job

cancel_job#

ElasticTranscoder.Client.cancel_job(**kwargs)#

The CancelJob operation cancels an unfinished job.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job(
    Id='string'
)
Parameters:

Id (string) –

[REQUIRED]

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

Exceptions