Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.CancelJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a job.

Requires permission to access the CancelJob action.

Synopsis

data CancelJob = CancelJob' {
- comment :: Maybe Text
- force :: Maybe Bool
- reasonCode :: Maybe Text
- jobId :: Text
}
newCancelJob :: Text -> CancelJob
cancelJob_comment :: Lens' CancelJob (Maybe Text)
cancelJob_force :: Lens' CancelJob (Maybe Bool)
cancelJob_reasonCode :: Lens' CancelJob (Maybe Text)
cancelJob_jobId :: Lens' CancelJob Text
data CancelJobResponse = CancelJobResponse' {
- description :: Maybe Text
- jobArn :: Maybe Text
- jobId :: Maybe Text
- httpStatus :: Int
}
newCancelJobResponse :: Int -> CancelJobResponse
cancelJobResponse_description :: Lens' CancelJobResponse (Maybe Text)
cancelJobResponse_jobArn :: Lens' CancelJobResponse (Maybe Text)
cancelJobResponse_jobId :: Lens' CancelJobResponse (Maybe Text)
cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int

Creating a Request

data CancelJob Source #

See: newCancelJob smart constructor.

Constructors

CancelJob'

Fields

comment :: Maybe Text
An optional comment string describing why the job was canceled.
force :: Maybe Bool
(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.
Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
reasonCode :: Maybe Text
(Optional)A reason code string that explains why the job was canceled.
jobId :: Text
The unique identifier you assigned to this job when it was created.

Instances

Instances details

ToJSON CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods toJSON :: CancelJob -> Value # toEncoding :: CancelJob -> Encoding # toJSONList :: [CancelJob] -> Value # toEncodingList :: [CancelJob] -> Encoding #
ToHeaders CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods toHeaders :: CancelJob -> [Header] #
ToPath CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods toPath :: CancelJob -> ByteString #
ToQuery CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods toQuery :: CancelJob -> QueryString #
AWSRequest CancelJob Source #
Instance details Defined in Amazonka.IoT.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 Source #
Instance details Defined in Amazonka.IoT.CancelJob Associated Types type Rep CancelJob :: Type -> Type # Methods from :: CancelJob -> Rep CancelJob x # to :: Rep CancelJob x -> CancelJob #
Read CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods readsPrec :: Int -> ReadS CancelJob # readList :: ReadS [CancelJob] # readPrec :: ReadPrec CancelJob # readListPrec :: ReadPrec [CancelJob] #
Show CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods showsPrec :: Int -> CancelJob -> ShowS # show :: CancelJob -> String # showList :: [CancelJob] -> ShowS #
NFData CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods rnf :: CancelJob -> () #
Eq CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods (==) :: CancelJob -> CancelJob -> Bool # (/=) :: CancelJob -> CancelJob -> Bool #
Hashable CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods hashWithSalt :: Int -> CancelJob -> Int # hash :: CancelJob -> Int #
type AWSResponse CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob type AWSResponse CancelJob = CancelJobResponse
type Rep CancelJob Source #
Instance details Defined in Amazonka.IoT.CancelJob type Rep CancelJob = D1 ('MetaData "CancelJob" "Amazonka.IoT.CancelJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CancelJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "reasonCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCancelJob Source #

Arguments

:: 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_comment - An optional comment string describing why the job was canceled.

$sel:force:CancelJob', cancelJob_force - (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

CancelJob, cancelJob_reasonCode - (Optional)A reason code string that explains why the job was canceled.

CancelJob, cancelJob_jobId - The unique identifier you assigned to this job when it was created.

Request Lenses

cancelJob_comment :: Lens' CancelJob (Maybe Text) Source #

An optional comment string describing why the job was canceled.

cancelJob_force :: Lens' CancelJob (Maybe Bool) Source #

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

cancelJob_reasonCode :: Lens' CancelJob (Maybe Text) Source #

(Optional)A reason code string that explains why the job was canceled.

cancelJob_jobId :: Lens' CancelJob Text Source #

The unique identifier you assigned to this job when it was created.

Destructuring the Response

data CancelJobResponse Source #

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse'
Fields description :: Maybe Text A short text description of the job. jobArn :: Maybe Text The job ARN. jobId :: Maybe Text The unique identifier you assigned to this job when it was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob Associated Types type Rep CancelJobResponse :: Type -> Type # Methods from :: CancelJobResponse -> Rep CancelJobResponse x # to :: Rep CancelJobResponse x -> CancelJobResponse #
Read CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods readsPrec :: Int -> ReadS CancelJobResponse # readList :: ReadS [CancelJobResponse] # readPrec :: ReadPrec CancelJobResponse # readListPrec :: ReadPrec [CancelJobResponse] #
Show CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods showsPrec :: Int -> CancelJobResponse -> ShowS # show :: CancelJobResponse -> String # showList :: [CancelJobResponse] -> ShowS #
NFData CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods rnf :: CancelJobResponse -> () #
Eq CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob Methods (==) :: CancelJobResponse -> CancelJobResponse -> Bool # (/=) :: CancelJobResponse -> CancelJobResponse -> Bool #
type Rep CancelJobResponse Source #
Instance details Defined in Amazonka.IoT.CancelJob type Rep CancelJobResponse = D1 ('MetaData "CancelJobResponse" "Amazonka.IoT.CancelJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CancelJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

CancelJobResponse, cancelJobResponse_description - A short text description of the job.

CancelJobResponse, cancelJobResponse_jobArn - The job ARN.

CancelJob, cancelJobResponse_jobId - The unique identifier you assigned to this job when it was created.

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

Response Lenses

cancelJobResponse_description :: Lens' CancelJobResponse (Maybe Text) Source #

A short text description of the job.

cancelJobResponse_jobArn :: Lens' CancelJobResponse (Maybe Text) Source #

The job ARN.

cancelJobResponse_jobId :: Lens' CancelJobResponse (Maybe Text) Source #

The unique identifier you assigned to this job when it was created.

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #

The response's http status code.