Amazonka.IoT.StartAuditMitigationActionsTask

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

Creating a Request

data StartAuditMitigationActionsTask

See: newStartAuditMitigationActionsTask smart constructor.

Constructors

StartAuditMitigationActionsTask'

Fields

• taskId :: Text

  A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

• target :: AuditMitigationActionsTaskTarget

  Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

• auditCheckToActionsMapping :: HashMap Text (NonEmpty Text)

  For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

• clientRequestToken :: Text

  Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

Instances

ToJSON StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

toJSON :: StartAuditMitigationActionsTask -> Value

toEncoding :: StartAuditMitigationActionsTask -> Encoding

toJSONList :: [StartAuditMitigationActionsTask] -> Value

toEncodingList :: [StartAuditMitigationActionsTask] -> Encoding

ToHeaders StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

toHeaders :: StartAuditMitigationActionsTask -> [Header]

ToPath StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

toPath :: StartAuditMitigationActionsTask -> ByteString

ToQuery StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

toQuery :: StartAuditMitigationActionsTask -> QueryString

AWSRequest StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Associated Types

type AWSResponse StartAuditMitigationActionsTask

Methods

request :: (Service -> Service) -> StartAuditMitigationActionsTask -> Request StartAuditMitigationActionsTask

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

Generic StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Associated Types

type Rep StartAuditMitigationActionsTask :: Type -> Type

Methods

from :: StartAuditMitigationActionsTask -> Rep StartAuditMitigationActionsTask x

to :: Rep StartAuditMitigationActionsTask x -> StartAuditMitigationActionsTask

Read StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

readsPrec :: Int -> ReadS StartAuditMitigationActionsTask

readList :: ReadS [StartAuditMitigationActionsTask]

readPrec :: ReadPrec StartAuditMitigationActionsTask

readListPrec :: ReadPrec [StartAuditMitigationActionsTask]

Show StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

showsPrec :: Int -> StartAuditMitigationActionsTask -> ShowS

show :: StartAuditMitigationActionsTask -> String

showList :: [StartAuditMitigationActionsTask] -> ShowS

NFData StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

rnf :: StartAuditMitigationActionsTask -> ()

Eq StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

(==) :: StartAuditMitigationActionsTask -> StartAuditMitigationActionsTask -> Bool

(/=) :: StartAuditMitigationActionsTask -> StartAuditMitigationActionsTask -> Bool

Hashable StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

hashWithSalt :: Int -> StartAuditMitigationActionsTask -> Int

hash :: StartAuditMitigationActionsTask -> Int

type AWSResponse StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

type AWSResponse StartAuditMitigationActionsTask = StartAuditMitigationActionsTaskResponse

type Rep StartAuditMitigationActionsTask

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

type Rep StartAuditMitigationActionsTask = D1 ('MetaData "StartAuditMitigationActionsTask" "Amazonka.IoT.StartAuditMitigationActionsTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "StartAuditMitigationActionsTask'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuditMitigationActionsTaskTarget)) :*: (S1 ('MetaSel ('Just "auditCheckToActionsMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text (NonEmpty Text))) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartAuditMitigationActionsTask

Arguments

:: Text

StartAuditMitigationActionsTask

-> AuditMitigationActionsTaskTarget

StartAuditMitigationActionsTask

-> Text

$sel:clientRequestToken:StartAuditMitigationActionsTask'

-> StartAuditMitigationActionsTask

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

StartAuditMitigationActionsTask, startAuditMitigationActionsTask_taskId - A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

StartAuditMitigationActionsTask, startAuditMitigationActionsTask_target - Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

$sel:auditCheckToActionsMapping:StartAuditMitigationActionsTask', startAuditMitigationActionsTask_auditCheckToActionsMapping - For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

$sel:clientRequestToken:StartAuditMitigationActionsTask', startAuditMitigationActionsTask_clientRequestToken - Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

Request Lenses

startAuditMitigationActionsTask_taskId :: Lens' StartAuditMitigationActionsTask Text

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

startAuditMitigationActionsTask_target :: Lens' StartAuditMitigationActionsTask AuditMitigationActionsTaskTarget

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

startAuditMitigationActionsTask_auditCheckToActionsMapping :: Lens' StartAuditMitigationActionsTask (HashMap Text (NonEmpty Text))

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

startAuditMitigationActionsTask_clientRequestToken :: Lens' StartAuditMitigationActionsTask Text

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

Destructuring the Response

data StartAuditMitigationActionsTaskResponse

See: newStartAuditMitigationActionsTaskResponse smart constructor.

Constructors

StartAuditMitigationActionsTaskResponse'

Fields

• taskId :: Maybe Text

  The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Associated Types

type Rep StartAuditMitigationActionsTaskResponse :: Type -> Type

Methods

from :: StartAuditMitigationActionsTaskResponse -> Rep StartAuditMitigationActionsTaskResponse x

to :: Rep StartAuditMitigationActionsTaskResponse x -> StartAuditMitigationActionsTaskResponse

Read StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

readsPrec :: Int -> ReadS StartAuditMitigationActionsTaskResponse

readList :: ReadS [StartAuditMitigationActionsTaskResponse]

readPrec :: ReadPrec StartAuditMitigationActionsTaskResponse

readListPrec :: ReadPrec [StartAuditMitigationActionsTaskResponse]

Show StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

showsPrec :: Int -> StartAuditMitigationActionsTaskResponse -> ShowS

show :: StartAuditMitigationActionsTaskResponse -> String

showList :: [StartAuditMitigationActionsTaskResponse] -> ShowS

NFData StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

rnf :: StartAuditMitigationActionsTaskResponse -> ()

Eq StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

Methods

(==) :: StartAuditMitigationActionsTaskResponse -> StartAuditMitigationActionsTaskResponse -> Bool

(/=) :: StartAuditMitigationActionsTaskResponse -> StartAuditMitigationActionsTaskResponse -> Bool

type Rep StartAuditMitigationActionsTaskResponse

Defined in Amazonka.IoT.StartAuditMitigationActionsTask

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

newStartAuditMitigationActionsTaskResponse

Arguments

:: Int

$sel:httpStatus:StartAuditMitigationActionsTaskResponse'

-> StartAuditMitigationActionsTaskResponse

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

StartAuditMitigationActionsTask, startAuditMitigationActionsTaskResponse_taskId - The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

$sel:httpStatus:StartAuditMitigationActionsTaskResponse', startAuditMitigationActionsTaskResponse_httpStatus - The response's http status code.

Response Lenses

startAuditMitigationActionsTaskResponse_taskId :: Lens' StartAuditMitigationActionsTaskResponse (Maybe Text)

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

startAuditMitigationActionsTaskResponse_httpStatus :: Lens' StartAuditMitigationActionsTaskResponse Int

The response's http status code.