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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

Synopsis

data CreateMitigationAction = CreateMitigationAction' {
- tags :: Maybe [Tag]
- actionName :: Text
- roleArn :: Text
- actionParams :: MitigationActionParams
}
newCreateMitigationAction :: Text -> Text -> MitigationActionParams -> CreateMitigationAction
createMitigationAction_tags :: Lens' CreateMitigationAction (Maybe [Tag])
createMitigationAction_actionName :: Lens' CreateMitigationAction Text
createMitigationAction_roleArn :: Lens' CreateMitigationAction Text
createMitigationAction_actionParams :: Lens' CreateMitigationAction MitigationActionParams
data CreateMitigationActionResponse = CreateMitigationActionResponse' {
- actionId :: Maybe Text
- actionArn :: Maybe Text
- httpStatus :: Int
}
newCreateMitigationActionResponse :: Int -> CreateMitigationActionResponse
createMitigationActionResponse_actionId :: Lens' CreateMitigationActionResponse (Maybe Text)
createMitigationActionResponse_actionArn :: Lens' CreateMitigationActionResponse (Maybe Text)
createMitigationActionResponse_httpStatus :: Lens' CreateMitigationActionResponse Int

Creating a Request

data CreateMitigationAction Source #

See: newCreateMitigationAction smart constructor.

Constructors

CreateMitigationAction'

Fields

tags :: Maybe [Tag]
Metadata that can be used to manage the mitigation action.
actionName :: Text
A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
roleArn :: Text
The ARN of the IAM role that is used to apply the mitigation action.
actionParams :: MitigationActionParams
Defines the type of action and the parameters for that action.

Instances

Instances details

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

newCreateMitigationAction Source #

Arguments

:: Text	`$sel:actionName:CreateMitigationAction'`
-> Text	`$sel:roleArn:CreateMitigationAction'`
-> MitigationActionParams	`$sel:actionParams:CreateMitigationAction'`
-> CreateMitigationAction

Create a value of CreateMitigationAction 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:tags:CreateMitigationAction', createMitigationAction_tags - Metadata that can be used to manage the mitigation action.

$sel:actionName:CreateMitigationAction', createMitigationAction_actionName - A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

$sel:roleArn:CreateMitigationAction', createMitigationAction_roleArn - The ARN of the IAM role that is used to apply the mitigation action.

$sel:actionParams:CreateMitigationAction', createMitigationAction_actionParams - Defines the type of action and the parameters for that action.

Request Lenses

createMitigationAction_tags :: Lens' CreateMitigationAction (Maybe [Tag]) Source #

Metadata that can be used to manage the mitigation action.

createMitigationAction_actionName :: Lens' CreateMitigationAction Text Source #

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

createMitigationAction_roleArn :: Lens' CreateMitigationAction Text Source #

The ARN of the IAM role that is used to apply the mitigation action.

createMitigationAction_actionParams :: Lens' CreateMitigationAction MitigationActionParams Source #

Defines the type of action and the parameters for that action.

Destructuring the Response

data CreateMitigationActionResponse Source #

See: newCreateMitigationActionResponse smart constructor.

Constructors

CreateMitigationActionResponse'
Fields actionId :: Maybe Text A unique identifier for the new mitigation action. actionArn :: Maybe Text The ARN for the new mitigation action. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateMitigationActionResponse Source #

Arguments

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

Create a value of CreateMitigationActionResponse 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:actionId:CreateMitigationActionResponse', createMitigationActionResponse_actionId - A unique identifier for the new mitigation action.

$sel:actionArn:CreateMitigationActionResponse', createMitigationActionResponse_actionArn - The ARN for the new mitigation action.

$sel:httpStatus:CreateMitigationActionResponse', createMitigationActionResponse_httpStatus - The response's http status code.

Response Lenses

createMitigationActionResponse_actionId :: Lens' CreateMitigationActionResponse (Maybe Text) Source #

A unique identifier for the new mitigation action.

createMitigationActionResponse_actionArn :: Lens' CreateMitigationActionResponse (Maybe Text) Source #

The ARN for the new mitigation action.

createMitigationActionResponse_httpStatus :: Lens' CreateMitigationActionResponse Int Source #

The response's http status code.