| 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.StartAuditMitigationActionsTask
Description
Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
Synopsis
- data StartAuditMitigationActionsTask = StartAuditMitigationActionsTask' {}
- newStartAuditMitigationActionsTask :: Text -> AuditMitigationActionsTaskTarget -> Text -> StartAuditMitigationActionsTask
- startAuditMitigationActionsTask_taskId :: Lens' StartAuditMitigationActionsTask Text
- startAuditMitigationActionsTask_target :: Lens' StartAuditMitigationActionsTask AuditMitigationActionsTaskTarget
- startAuditMitigationActionsTask_auditCheckToActionsMapping :: Lens' StartAuditMitigationActionsTask (HashMap Text (NonEmpty Text))
- startAuditMitigationActionsTask_clientRequestToken :: Lens' StartAuditMitigationActionsTask Text
- data StartAuditMitigationActionsTaskResponse = StartAuditMitigationActionsTaskResponse' {
- taskId :: Maybe Text
- httpStatus :: Int
- newStartAuditMitigationActionsTaskResponse :: Int -> StartAuditMitigationActionsTaskResponse
- startAuditMitigationActionsTaskResponse_taskId :: Lens' StartAuditMitigationActionsTaskResponse (Maybe Text)
- startAuditMitigationActionsTaskResponse_httpStatus :: Lens' StartAuditMitigationActionsTaskResponse Int
Creating a Request
data StartAuditMitigationActionsTask Source #
See: newStartAuditMitigationActionsTask smart constructor.
Constructors
| StartAuditMitigationActionsTask' | |
Fields
| |
Instances
newStartAuditMitigationActionsTask Source #
Arguments
| :: Text | |
| -> AuditMitigationActionsTaskTarget | |
| -> Text | |
| -> 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:
$sel:taskId: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.
$sel:target: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 Source #
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 Source #
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)) Source #
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 Source #
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 Source #
See: newStartAuditMitigationActionsTaskResponse smart constructor.
Constructors
| StartAuditMitigationActionsTaskResponse' | |
Fields
| |
Instances
newStartAuditMitigationActionsTaskResponse Source #
Arguments
| :: Int | |
| -> 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:
$sel:taskId: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) Source #
The unique identifier for the audit mitigation task. This matches the
taskId that you specified in the request.
startAuditMitigationActionsTaskResponse_httpStatus :: Lens' StartAuditMitigationActionsTaskResponse Int Source #
The response's http status code.