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.CancelAuditTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

Requires permission to access the CancelAuditTask action.

Synopsis

Creating a Request

data CancelAuditTask Source #

See: newCancelAuditTask smart constructor.

Constructors

CancelAuditTask'
Fields taskId :: Text The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Instances

Instances details

ToJSON CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods toJSON :: CancelAuditTask -> Value # toEncoding :: CancelAuditTask -> Encoding # toJSONList :: [CancelAuditTask] -> Value # toEncodingList :: [CancelAuditTask] -> Encoding #
ToHeaders CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods toHeaders :: CancelAuditTask -> [Header] #
ToPath CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods toPath :: CancelAuditTask -> ByteString #
ToQuery CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods toQuery :: CancelAuditTask -> QueryString #
AWSRequest CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Associated Types type AWSResponse CancelAuditTask # Methods request :: (Service -> Service) -> CancelAuditTask -> Request CancelAuditTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelAuditTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelAuditTask))) #
Generic CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Associated Types type Rep CancelAuditTask :: Type -> Type # Methods from :: CancelAuditTask -> Rep CancelAuditTask x # to :: Rep CancelAuditTask x -> CancelAuditTask #
Read CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods readsPrec :: Int -> ReadS CancelAuditTask # readList :: ReadS [CancelAuditTask] # readPrec :: ReadPrec CancelAuditTask # readListPrec :: ReadPrec [CancelAuditTask] #
Show CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods showsPrec :: Int -> CancelAuditTask -> ShowS # show :: CancelAuditTask -> String # showList :: [CancelAuditTask] -> ShowS #
NFData CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods rnf :: CancelAuditTask -> () #
Eq CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods (==) :: CancelAuditTask -> CancelAuditTask -> Bool # (/=) :: CancelAuditTask -> CancelAuditTask -> Bool #
Hashable CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask Methods hashWithSalt :: Int -> CancelAuditTask -> Int # hash :: CancelAuditTask -> Int #
type AWSResponse CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask type AWSResponse CancelAuditTask = CancelAuditTaskResponse
type Rep CancelAuditTask Source #
Instance details Defined in Amazonka.IoT.CancelAuditTask type Rep CancelAuditTask = D1 ('MetaData "CancelAuditTask" "Amazonka.IoT.CancelAuditTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CancelAuditTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelAuditTask Source #

Arguments

:: Text	`CancelAuditTask`
-> CancelAuditTask

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

CancelAuditTask, cancelAuditTask_taskId - The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Request Lenses

cancelAuditTask_taskId :: Lens' CancelAuditTask Text Source #

The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Destructuring the Response

data CancelAuditTaskResponse Source #

See: newCancelAuditTaskResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCancelAuditTaskResponse Source #

Arguments

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

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

Response Lenses

cancelAuditTaskResponse_httpStatus :: Lens' CancelAuditTaskResponse Int Source #

The response's http status code.