amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.StartOnDemandAuditTask

Description

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

Synopsis

Creating a Request

data StartOnDemandAuditTask Source #

See: newStartOnDemandAuditTask smart constructor.

Constructors

StartOnDemandAuditTask' 

Fields

  • targetCheckNames :: [Text]

    Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

Instances

Instances details
ToJSON StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

toJSON :: StartOnDemandAuditTask -> Value #

toEncoding :: StartOnDemandAuditTask -> Encoding #

toJSONList :: [StartOnDemandAuditTask] -> Value #

toEncodingList :: [StartOnDemandAuditTask] -> Encoding #

ToHeaders StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

toHeaders :: StartOnDemandAuditTask -> [Header] #

ToPath StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

toPath :: StartOnDemandAuditTask -> ByteString #

ToQuery StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

toQuery :: StartOnDemandAuditTask -> QueryString #

AWSRequest StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Associated Types

type AWSResponse StartOnDemandAuditTask #

Methods

request :: (Service -> Service) -> StartOnDemandAuditTask -> Request StartOnDemandAuditTask #

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

Generic StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Associated Types

type Rep StartOnDemandAuditTask :: Type -> Type #

Methods

from :: StartOnDemandAuditTask -> Rep StartOnDemandAuditTask x #

to :: Rep StartOnDemandAuditTask x -> StartOnDemandAuditTask #

Read StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

readsPrec :: Int -> ReadS StartOnDemandAuditTask #

readList :: ReadS [StartOnDemandAuditTask] #

readPrec :: ReadPrec StartOnDemandAuditTask #

readListPrec :: ReadPrec [StartOnDemandAuditTask] #

Show StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

showsPrec :: Int -> StartOnDemandAuditTask -> ShowS #

show :: StartOnDemandAuditTask -> String #

showList :: [StartOnDemandAuditTask] -> ShowS #

NFData StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

rnf :: StartOnDemandAuditTask -> () #

Eq StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

(==) :: StartOnDemandAuditTask -> StartOnDemandAuditTask -> Bool #

(/=) :: StartOnDemandAuditTask -> StartOnDemandAuditTask -> Bool #

Hashable StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

hashWithSalt :: Int -> StartOnDemandAuditTask -> Int #

hash :: StartOnDemandAuditTask -> Int #

type AWSResponse StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

type AWSResponse StartOnDemandAuditTask = StartOnDemandAuditTaskResponse
type Rep StartOnDemandAuditTask Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

type Rep StartOnDemandAuditTask = D1 ('MetaData "StartOnDemandAuditTask" "Amazonka.IoT.StartOnDemandAuditTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "StartOnDemandAuditTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetCheckNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newStartOnDemandAuditTask :: StartOnDemandAuditTask Source #

Create a value of StartOnDemandAuditTask 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:targetCheckNames:StartOnDemandAuditTask', startOnDemandAuditTask_targetCheckNames - Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

Request Lenses

startOnDemandAuditTask_targetCheckNames :: Lens' StartOnDemandAuditTask [Text] Source #

Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

Destructuring the Response

data StartOnDemandAuditTaskResponse Source #

See: newStartOnDemandAuditTaskResponse smart constructor.

Constructors

StartOnDemandAuditTaskResponse' 

Fields

Instances

Instances details
Generic StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Associated Types

type Rep StartOnDemandAuditTaskResponse :: Type -> Type #

Methods

from :: StartOnDemandAuditTaskResponse -> Rep StartOnDemandAuditTaskResponse x #

to :: Rep StartOnDemandAuditTaskResponse x -> StartOnDemandAuditTaskResponse #

Read StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

readsPrec :: Int -> ReadS StartOnDemandAuditTaskResponse #

readList :: ReadS [StartOnDemandAuditTaskResponse] #

readPrec :: ReadPrec StartOnDemandAuditTaskResponse #

readListPrec :: ReadPrec [StartOnDemandAuditTaskResponse] #

Show StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

showsPrec :: Int -> StartOnDemandAuditTaskResponse -> ShowS #

show :: StartOnDemandAuditTaskResponse -> String #

showList :: [StartOnDemandAuditTaskResponse] -> ShowS #

NFData StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

rnf :: StartOnDemandAuditTaskResponse -> () #

Eq StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

Methods

(==) :: StartOnDemandAuditTaskResponse -> StartOnDemandAuditTaskResponse -> Bool #

(/=) :: StartOnDemandAuditTaskResponse -> StartOnDemandAuditTaskResponse -> Bool #

type Rep StartOnDemandAuditTaskResponse Source # 
Instance details

Defined in Amazonka.IoT.StartOnDemandAuditTask

type Rep StartOnDemandAuditTaskResponse = D1 ('MetaData "StartOnDemandAuditTaskResponse" "Amazonka.IoT.StartOnDemandAuditTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "StartOnDemandAuditTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartOnDemandAuditTaskResponse Source #

Arguments

:: Int

$sel:httpStatus:StartOnDemandAuditTaskResponse'

-> StartOnDemandAuditTaskResponse 

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

StartOnDemandAuditTaskResponse, startOnDemandAuditTaskResponse_taskId - The ID of the on-demand audit you started.

$sel:httpStatus:StartOnDemandAuditTaskResponse', startOnDemandAuditTaskResponse_httpStatus - The response's http status code.

Response Lenses

startOnDemandAuditTaskResponse_taskId :: Lens' StartOnDemandAuditTaskResponse (Maybe Text) Source #

The ID of the on-demand audit you started.

startOnDemandAuditTaskResponse_httpStatus :: Lens' StartOnDemandAuditTaskResponse Int Source #

The response's http status code.