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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

Synopsis

Creating a Request

data DescribeAuditMitigationActionsTask Source #

See: newDescribeAuditMitigationActionsTask smart constructor.

Constructors

DescribeAuditMitigationActionsTask'
Fields taskId :: Text The unique identifier for the audit mitigation task.

Instances

Instances details

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

newDescribeAuditMitigationActionsTask Source #

Arguments

:: Text	`DescribeAuditMitigationActionsTask`
-> DescribeAuditMitigationActionsTask

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

DescribeAuditMitigationActionsTask, describeAuditMitigationActionsTask_taskId - The unique identifier for the audit mitigation task.

Request Lenses

describeAuditMitigationActionsTask_taskId :: Lens' DescribeAuditMitigationActionsTask Text Source #

The unique identifier for the audit mitigation task.

Destructuring the Response

data DescribeAuditMitigationActionsTaskResponse Source #

See: newDescribeAuditMitigationActionsTaskResponse smart constructor.

Constructors

DescribeAuditMitigationActionsTaskResponse'

Fields

actionsDefinition :: Maybe [MitigationAction]
Specifies the mitigation actions and their parameters that are applied as part of this task.
auditCheckToActionsMapping :: Maybe (HashMap Text (NonEmpty Text))
Specifies the mitigation actions that should be applied to specific audit checks.
endTime :: Maybe POSIX
The date and time when the task was completed or canceled.
startTime :: Maybe POSIX
The date and time when the task was started.
target :: Maybe AuditMitigationActionsTaskTarget
Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
taskStatistics :: Maybe (HashMap Text TaskStatisticsForAuditCheck)
Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
taskStatus :: Maybe AuditMitigationActionsTaskStatus
The current status of the task.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask Associated Types type Rep DescribeAuditMitigationActionsTaskResponse :: Type -> Type # Methods from :: DescribeAuditMitigationActionsTaskResponse -> Rep DescribeAuditMitigationActionsTaskResponse x # to :: Rep DescribeAuditMitigationActionsTaskResponse x -> DescribeAuditMitigationActionsTaskResponse #
Read DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask Methods readsPrec :: Int -> ReadS DescribeAuditMitigationActionsTaskResponse # readList :: ReadS [DescribeAuditMitigationActionsTaskResponse] # readPrec :: ReadPrec DescribeAuditMitigationActionsTaskResponse # readListPrec :: ReadPrec [DescribeAuditMitigationActionsTaskResponse] #
Show DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask Methods showsPrec :: Int -> DescribeAuditMitigationActionsTaskResponse -> ShowS # show :: DescribeAuditMitigationActionsTaskResponse -> String # showList :: [DescribeAuditMitigationActionsTaskResponse] -> ShowS #
NFData DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask Methods rnf :: DescribeAuditMitigationActionsTaskResponse -> () #
Eq DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask Methods (==) :: DescribeAuditMitigationActionsTaskResponse -> DescribeAuditMitigationActionsTaskResponse -> Bool # (/=) :: DescribeAuditMitigationActionsTaskResponse -> DescribeAuditMitigationActionsTaskResponse -> Bool #
type Rep DescribeAuditMitigationActionsTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditMitigationActionsTask type Rep DescribeAuditMitigationActionsTaskResponse = D1 ('MetaData "DescribeAuditMitigationActionsTaskResponse" "Amazonka.IoT.DescribeAuditMitigationActionsTask" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeAuditMitigationActionsTaskResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actionsDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MitigationAction])) :: S1 ('MetaSel ('Just "auditCheckToActionsMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (NonEmpty Text))))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditMitigationActionsTaskTarget)) :: S1 ('MetaSel ('Just "taskStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text TaskStatisticsForAuditCheck)))) :: (S1 ('MetaSel ('Just "taskStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditMitigationActionsTaskStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeAuditMitigationActionsTaskResponse Source #

Arguments

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

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

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_actionsDefinition - Specifies the mitigation actions and their parameters that are applied as part of this task.

$sel:auditCheckToActionsMapping:DescribeAuditMitigationActionsTaskResponse', describeAuditMitigationActionsTaskResponse_auditCheckToActionsMapping - Specifies the mitigation actions that should be applied to specific audit checks.

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_endTime - The date and time when the task was completed or canceled.

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_startTime - The date and time when the task was started.

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_target - Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_taskStatistics - Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

DescribeAuditMitigationActionsTaskResponse, describeAuditMitigationActionsTaskResponse_taskStatus - The current status of the task.

$sel:httpStatus:DescribeAuditMitigationActionsTaskResponse', describeAuditMitigationActionsTaskResponse_httpStatus - The response's http status code.

Response Lenses

describeAuditMitigationActionsTaskResponse_actionsDefinition :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe [MitigationAction]) Source #

Specifies the mitigation actions and their parameters that are applied as part of this task.

describeAuditMitigationActionsTaskResponse_auditCheckToActionsMapping :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe (HashMap Text (NonEmpty Text))) Source #

Specifies the mitigation actions that should be applied to specific audit checks.

describeAuditMitigationActionsTaskResponse_endTime :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe UTCTime) Source #

The date and time when the task was completed or canceled.

describeAuditMitigationActionsTaskResponse_startTime :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe UTCTime) Source #

The date and time when the task was started.

describeAuditMitigationActionsTaskResponse_target :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe AuditMitigationActionsTaskTarget) Source #

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

describeAuditMitigationActionsTaskResponse_taskStatistics :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe (HashMap Text TaskStatisticsForAuditCheck)) Source #

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

describeAuditMitigationActionsTaskResponse_taskStatus :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe AuditMitigationActionsTaskStatus) Source #

The current status of the task.

describeAuditMitigationActionsTaskResponse_httpStatus :: Lens' DescribeAuditMitigationActionsTaskResponse Int Source #

The response's http status code.