Amazonka.Batch.CancelJob

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Creating a Request

data CancelJob

Contains the parameters for CancelJob.

See: newCancelJob smart constructor.

Constructors

CancelJob'

Fields

• jobId :: Text

  The Batch job ID of the job to cancel.

• reason :: Text

  A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Instances

ToJSON CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

toJSON :: CancelJob -> Value

toEncoding :: CancelJob -> Encoding

toJSONList :: [CancelJob] -> Value

toEncodingList :: [CancelJob] -> Encoding

ToHeaders CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

toHeaders :: CancelJob -> [Header]

ToPath CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

toPath :: CancelJob -> ByteString

ToQuery CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

toQuery :: CancelJob -> QueryString

AWSRequest CancelJob

Defined in Amazonka.Batch.CancelJob

Associated Types

type AWSResponse CancelJob

Methods

request :: (Service -> Service) -> CancelJob -> Request CancelJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelJob)))

Generic CancelJob

Defined in Amazonka.Batch.CancelJob

Associated Types

type Rep CancelJob :: Type -> Type

Methods

from :: CancelJob -> Rep CancelJob x

to :: Rep CancelJob x -> CancelJob

Read CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

readsPrec :: Int -> ReadS CancelJob

readList :: ReadS [CancelJob]

readPrec :: ReadPrec CancelJob

readListPrec :: ReadPrec [CancelJob]

Show CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

showsPrec :: Int -> CancelJob -> ShowS

show :: CancelJob -> String

showList :: [CancelJob] -> ShowS

NFData CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

rnf :: CancelJob -> ()

Eq CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

(==) :: CancelJob -> CancelJob -> Bool

(/=) :: CancelJob -> CancelJob -> Bool

Hashable CancelJob

Defined in Amazonka.Batch.CancelJob

Methods

hashWithSalt :: Int -> CancelJob -> Int

hash :: CancelJob -> Int

type AWSResponse CancelJob

Defined in Amazonka.Batch.CancelJob

type AWSResponse CancelJob = CancelJobResponse

type Rep CancelJob

Defined in Amazonka.Batch.CancelJob

type Rep CancelJob = D1 ('MetaData "CancelJob" "Amazonka.Batch.CancelJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CancelJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelJob

Arguments

:: Text

CancelJob

-> Text

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:

CancelJob, cancelJob_jobId - The Batch job ID of the job to cancel.

CancelJob, cancelJob_reason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Request Lenses

cancelJob_jobId :: Lens' CancelJob Text

The Batch job ID of the job to cancel.

cancelJob_reason :: Lens' CancelJob Text

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Destructuring the Response

data CancelJobResponse

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelJobResponse

Defined in Amazonka.Batch.CancelJob

Associated Types

type Rep CancelJobResponse :: Type -> Type

Methods

from :: CancelJobResponse -> Rep CancelJobResponse x

to :: Rep CancelJobResponse x -> CancelJobResponse

Read CancelJobResponse

Defined in Amazonka.Batch.CancelJob

Methods

readsPrec :: Int -> ReadS CancelJobResponse

readList :: ReadS [CancelJobResponse]

readPrec :: ReadPrec CancelJobResponse

readListPrec :: ReadPrec [CancelJobResponse]

Show CancelJobResponse

Defined in Amazonka.Batch.CancelJob

Methods

showsPrec :: Int -> CancelJobResponse -> ShowS

show :: CancelJobResponse -> String

showList :: [CancelJobResponse] -> ShowS

NFData CancelJobResponse

Defined in Amazonka.Batch.CancelJob

Methods

rnf :: CancelJobResponse -> ()

Eq CancelJobResponse

Defined in Amazonka.Batch.CancelJob

Methods

(==) :: CancelJobResponse -> CancelJobResponse -> Bool

(/=) :: CancelJobResponse -> CancelJobResponse -> Bool

type Rep CancelJobResponse

Defined in Amazonka.Batch.CancelJob

type Rep CancelJobResponse = D1 ('MetaData "CancelJobResponse" "Amazonka.Batch.CancelJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CancelJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelJobResponse

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

The response's http status code.