Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElasticTranscoder.CancelJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CancelJob = CancelJob' {
- id :: Text
}
newCancelJob :: Text -> CancelJob
cancelJob_id :: Lens' CancelJob Text
data CancelJobResponse = CancelJobResponse' {
- httpStatus :: Int
}
newCancelJobResponse :: Int -> CancelJobResponse
cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int

Creating a Request

data CancelJob Source #

The CancelJobRequest structure.

See: newCancelJob smart constructor.

Constructors

CancelJob'
Fields id :: 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.

Instances

Instances details

Eq CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods (==) :: CancelJob -> CancelJob -> Bool # (/=) :: CancelJob -> CancelJob -> Bool #
Read CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods readsPrec :: Int -> ReadS CancelJob # readList :: ReadS [CancelJob] # readPrec :: ReadPrec CancelJob # readListPrec :: ReadPrec [CancelJob] #
Show CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods showsPrec :: Int -> CancelJob -> ShowS # show :: CancelJob -> String # showList :: [CancelJob] -> ShowS #
Generic CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Associated Types type Rep CancelJob :: Type -> Type # Methods from :: CancelJob -> Rep CancelJob x # to :: Rep CancelJob x -> CancelJob #
NFData CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods rnf :: CancelJob -> () #
Hashable CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods hashWithSalt :: Int -> CancelJob -> Int # hash :: CancelJob -> Int #
AWSRequest CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Associated Types type AWSResponse CancelJob # Methods request :: CancelJob -> Request CancelJob # response :: MonadResource m => Logger -> Service -> Proxy CancelJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelJob))) #
ToHeaders CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods toHeaders :: CancelJob -> [Header] #
ToPath CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods toPath :: CancelJob -> ByteString #
ToQuery CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods toQuery :: CancelJob -> QueryString #
type Rep CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob type Rep CancelJob = D1 ('MetaData "CancelJob" "Amazonka.ElasticTranscoder.CancelJob" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "CancelJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob type AWSResponse CancelJob = CancelJobResponse

newCancelJob Source #

Arguments

:: Text	`$sel:id:CancelJob'`
-> CancelJob

Create a value of CancelJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:CancelJob', cancelJob_id - 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.

Request Lenses

cancelJob_id :: Lens' CancelJob Text Source #

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

data CancelJobResponse Source #

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

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods (==) :: CancelJobResponse -> CancelJobResponse -> Bool # (/=) :: CancelJobResponse -> CancelJobResponse -> Bool #
Read CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods readsPrec :: Int -> ReadS CancelJobResponse # readList :: ReadS [CancelJobResponse] # readPrec :: ReadPrec CancelJobResponse # readListPrec :: ReadPrec [CancelJobResponse] #
Show CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods showsPrec :: Int -> CancelJobResponse -> ShowS # show :: CancelJobResponse -> String # showList :: [CancelJobResponse] -> ShowS #
Generic CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Associated Types type Rep CancelJobResponse :: Type -> Type # Methods from :: CancelJobResponse -> Rep CancelJobResponse x # to :: Rep CancelJobResponse x -> CancelJobResponse #
NFData CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob Methods rnf :: CancelJobResponse -> () #
type Rep CancelJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CancelJob type Rep CancelJobResponse = D1 ('MetaData "CancelJobResponse" "Amazonka.ElasticTranscoder.CancelJob" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "CancelJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CancelJobResponse'`
-> CancelJobResponse

Create a value of CancelJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CancelJobResponse', cancelJobResponse_httpStatus - The response's http status code.

Response Lenses

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #

The response's http status code.