Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.StartDetectMitigationActionsTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

Synopsis

Creating a Request

data StartDetectMitigationActionsTask Source #

See: newStartDetectMitigationActionsTask smart constructor.

Constructors

StartDetectMitigationActionsTask'

Fields

violationEventOccurrenceRange :: Maybe ViolationEventOccurrenceRange
Specifies the time period of which violation events occurred between.
includeOnlyActiveViolations :: Maybe Bool
Specifies to list only active violations.
includeSuppressedAlerts :: Maybe Bool
Specifies to include suppressed alerts.
taskId :: Text
The unique identifier of the task.
target :: DetectMitigationActionsTaskTarget
Specifies the ML Detect findings to which the mitigation actions are applied.
actions :: NonEmpty Text
The actions to be performed when a device has unexpected behavior.
clientRequestToken :: Text
Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Instances

Instances details

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

newStartDetectMitigationActionsTask Source #

Arguments

:: Text	`$sel:taskId:StartDetectMitigationActionsTask'`
-> DetectMitigationActionsTaskTarget	`$sel:target:StartDetectMitigationActionsTask'`
-> NonEmpty Text	`$sel:actions:StartDetectMitigationActionsTask'`
-> Text	`$sel:clientRequestToken:StartDetectMitigationActionsTask'`
-> StartDetectMitigationActionsTask

Create a value of StartDetectMitigationActionsTask 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:violationEventOccurrenceRange:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_violationEventOccurrenceRange - Specifies the time period of which violation events occurred between.

$sel:includeOnlyActiveViolations:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_includeOnlyActiveViolations - Specifies to list only active violations.

$sel:includeSuppressedAlerts:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_includeSuppressedAlerts - Specifies to include suppressed alerts.

$sel:taskId:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_taskId - The unique identifier of the task.

$sel:target:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_target - Specifies the ML Detect findings to which the mitigation actions are applied.

$sel:actions:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_actions - The actions to be performed when a device has unexpected behavior.

$sel:clientRequestToken:StartDetectMitigationActionsTask', startDetectMitigationActionsTask_clientRequestToken - Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Request Lenses

startDetectMitigationActionsTask_violationEventOccurrenceRange :: Lens' StartDetectMitigationActionsTask (Maybe ViolationEventOccurrenceRange) Source #

Specifies the time period of which violation events occurred between.

startDetectMitigationActionsTask_includeOnlyActiveViolations :: Lens' StartDetectMitigationActionsTask (Maybe Bool) Source #

Specifies to list only active violations.

startDetectMitigationActionsTask_includeSuppressedAlerts :: Lens' StartDetectMitigationActionsTask (Maybe Bool) Source #

Specifies to include suppressed alerts.

startDetectMitigationActionsTask_taskId :: Lens' StartDetectMitigationActionsTask Text Source #

The unique identifier of the task.

startDetectMitigationActionsTask_target :: Lens' StartDetectMitigationActionsTask DetectMitigationActionsTaskTarget Source #

Specifies the ML Detect findings to which the mitigation actions are applied.

startDetectMitigationActionsTask_actions :: Lens' StartDetectMitigationActionsTask (NonEmpty Text) Source #

The actions to be performed when a device has unexpected behavior.

startDetectMitigationActionsTask_clientRequestToken :: Lens' StartDetectMitigationActionsTask Text Source #

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Destructuring the Response

data StartDetectMitigationActionsTaskResponse Source #

See: newStartDetectMitigationActionsTaskResponse smart constructor.

Constructors

StartDetectMitigationActionsTaskResponse'
Fields taskId :: Maybe Text The unique identifier of the task. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartDetectMitigationActionsTaskResponse Source #

Arguments

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

Create a value of StartDetectMitigationActionsTaskResponse 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:taskId:StartDetectMitigationActionsTask', startDetectMitigationActionsTaskResponse_taskId - The unique identifier of the task.

$sel:httpStatus:StartDetectMitigationActionsTaskResponse', startDetectMitigationActionsTaskResponse_httpStatus - The response's http status code.

Response Lenses

startDetectMitigationActionsTaskResponse_taskId :: Lens' StartDetectMitigationActionsTaskResponse (Maybe Text) Source #

The unique identifier of the task.

startDetectMitigationActionsTaskResponse_httpStatus :: Lens' StartDetectMitigationActionsTaskResponse Int Source #

The response's http status code.