Amazonka.Batch.TerminateJob

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Creating a Request

data TerminateJob

Contains the parameters for TerminateJob.

See: newTerminateJob smart constructor.

Constructors

TerminateJob'

Fields

• jobId :: Text

  The Batch job ID of the job to terminate.

• 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 TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

toJSON :: TerminateJob -> Value

toEncoding :: TerminateJob -> Encoding

toJSONList :: [TerminateJob] -> Value

toEncodingList :: [TerminateJob] -> Encoding

ToHeaders TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

toHeaders :: TerminateJob -> [Header]

ToPath TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

toPath :: TerminateJob -> ByteString

ToQuery TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

toQuery :: TerminateJob -> QueryString

AWSRequest TerminateJob

Defined in Amazonka.Batch.TerminateJob

Associated Types

type AWSResponse TerminateJob

Methods

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

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

Generic TerminateJob

Defined in Amazonka.Batch.TerminateJob

Associated Types

type Rep TerminateJob :: Type -> Type

Methods

from :: TerminateJob -> Rep TerminateJob x

to :: Rep TerminateJob x -> TerminateJob

Read TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

readsPrec :: Int -> ReadS TerminateJob

readList :: ReadS [TerminateJob]

readPrec :: ReadPrec TerminateJob

readListPrec :: ReadPrec [TerminateJob]

Show TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

showsPrec :: Int -> TerminateJob -> ShowS

show :: TerminateJob -> String

showList :: [TerminateJob] -> ShowS

NFData TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

rnf :: TerminateJob -> ()

Eq TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

(==) :: TerminateJob -> TerminateJob -> Bool

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

Hashable TerminateJob

Defined in Amazonka.Batch.TerminateJob

Methods

hashWithSalt :: Int -> TerminateJob -> Int

hash :: TerminateJob -> Int

type AWSResponse TerminateJob

Defined in Amazonka.Batch.TerminateJob

type AWSResponse TerminateJob = TerminateJobResponse

type Rep TerminateJob

Defined in Amazonka.Batch.TerminateJob

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

newTerminateJob

Arguments

:: Text

TerminateJob

-> Text

TerminateJob

-> TerminateJob

Create a value of TerminateJob 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:

TerminateJob, terminateJob_jobId - The Batch job ID of the job to terminate.

TerminateJob, terminateJob_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

terminateJob_jobId :: Lens' TerminateJob Text

The Batch job ID of the job to terminate.

terminateJob_reason :: Lens' TerminateJob 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 TerminateJobResponse

See: newTerminateJobResponse smart constructor.

Constructors

TerminateJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

Associated Types

type Rep TerminateJobResponse :: Type -> Type

Methods

from :: TerminateJobResponse -> Rep TerminateJobResponse x

to :: Rep TerminateJobResponse x -> TerminateJobResponse

Read TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

Methods

readsPrec :: Int -> ReadS TerminateJobResponse

readList :: ReadS [TerminateJobResponse]

readPrec :: ReadPrec TerminateJobResponse

readListPrec :: ReadPrec [TerminateJobResponse]

Show TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

Methods

showsPrec :: Int -> TerminateJobResponse -> ShowS

show :: TerminateJobResponse -> String

showList :: [TerminateJobResponse] -> ShowS

NFData TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

Methods

rnf :: TerminateJobResponse -> ()

Eq TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

Methods

(==) :: TerminateJobResponse -> TerminateJobResponse -> Bool

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

type Rep TerminateJobResponse

Defined in Amazonka.Batch.TerminateJob

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

newTerminateJobResponse

Arguments

:: Int

$sel:httpStatus:TerminateJobResponse'

-> TerminateJobResponse

Create a value of TerminateJobResponse 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:TerminateJobResponse', terminateJobResponse_httpStatus - The response's http status code.

Response Lenses

terminateJobResponse_httpStatus :: Lens' TerminateJobResponse Int

The response's http status code.