Network.AWS.ElasticTranscoder.CancelJob

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.

See: AWS API Reference for CancelJob.

Creating a Request

cancelJob

Arguments

:: Text

cjId

-> CancelJob

Creates a value of CancelJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjId

data CancelJob

The CancelJobRequest structure.

See: cancelJob smart constructor.

Instances

Eq CancelJob

Data CancelJob

Read CancelJob

Show CancelJob

Generic CancelJob

AWSRequest CancelJob

ToPath CancelJob

ToHeaders CancelJob

ToQuery CancelJob

Typeable * CancelJob

type Rep CancelJob

type Rs CancelJob = CancelJobResponse

Request Lenses

cjId :: Lens' CancelJob Text

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.

Destructuring the Response

cancelJobResponse

Arguments

:: Int

canrsResponseStatus

-> CancelJobResponse

Creates a value of CancelJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• canrsResponseStatus

data CancelJobResponse

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

See: cancelJobResponse smart constructor.

Instances

Eq CancelJobResponse

Data CancelJobResponse

Read CancelJobResponse

Show CancelJobResponse

Generic CancelJobResponse

Typeable * CancelJobResponse

type Rep CancelJobResponse

Response Lenses

canrsResponseStatus :: Lens' CancelJobResponse Int

The response status code.