DescribeAuditMitigationActionsTask
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.
Request Syntax
GET /audit/mitigationactions/tasks/taskId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- taskId
-
The unique identifier for the audit mitigation task.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionsDefinition": [
{
"actionParams": {
"addThingsToThingGroupParams": {
"overrideDynamicGroups": boolean,
"thingGroupNames": [ "string" ]
},
"enableIoTLoggingParams": {
"logLevel": "string",
"roleArnForLogging": "string"
},
"publishFindingToSnsParams": {
"topicArn": "string"
},
"replaceDefaultPolicyVersionParams": {
"templateName": "string"
},
"updateCACertificateParams": {
"action": "string"
},
"updateDeviceCertificateParams": {
"action": "string"
}
},
"id": "string",
"name": "string",
"roleArn": "string"
}
],
"auditCheckToActionsMapping": {
"string" : [ "string" ]
},
"endTime": number,
"startTime": number,
"target": {
"auditCheckToReasonCodeFilter": {
"string" : [ "string" ]
},
"auditTaskId": "string",
"findingIds": [ "string" ]
},
"taskStatistics": {
"string" : {
"canceledFindingsCount": number,
"failedFindingsCount": number,
"skippedFindingsCount": number,
"succeededFindingsCount": number,
"totalFindingsCount": number
}
},
"taskStatus": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actionsDefinition
-
Specifies the mitigation actions and their parameters that are applied as part of this task.
Type: Array of MitigationAction objects
- auditCheckToActionsMapping
-
Specifies the mitigation actions that should be applied to specific audit checks.
Type: String to array of strings map
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+ - endTime
-
The date and time when the task was completed or canceled.
Type: Timestamp
- startTime
-
The date and time when the task was started.
Type: Timestamp
- 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.
Type: AuditMitigationActionsTaskTarget object
- taskStatistics
-
Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
Type: String to TaskStatisticsForAuditCheck object map
- taskStatus
-
The current status of the task.
Type: String
Valid Values:
IN_PROGRESS | COMPLETED | FAILED | CANCELED
Errors
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
- message
-
The message for the exception.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
