/audit/mitigationactions/tasks/{taskId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

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 Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/audit/mitigationactions/tasks/'

Response Example

200 - Example 1

{
    "taskStatus": "IN_PROGRESS",
    "startTime": "string",
    "endTime": "string",
    "taskStatistics": {
        "property1": {
            "totalFindingsCount": 0,
            "failedFindingsCount": 0,
            "succeededFindingsCount": 0,
            "skippedFindingsCount": 0,
            "canceledFindingsCount": 0
        }
    },
    "target": {
        "auditTaskId": "string",
        "findingIds": [],
        "auditCheckToReasonCodeFilter": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        }
    },
    "auditCheckToActionsMapping": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "actionsDefinition": []
}

Request

Path Params

taskId

string

required

The unique identifier for the audit mitigation task.

Responses

🟢200Success

application/json

Body

taskStatus

enum<string>

optional

The current status of the task.

Allowed values:

IN_PROGRESSCOMPLETEDFAILEDCANCELED

startTime

string <date-time>

optional

The date and time when the task was started.

endTime

string <date-time>

optional

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

taskStatistics

object

optional

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

target

object

optional

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

auditTaskId

string

optional

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

>= 1 characters<= 40 characters

Match pattern:

[a-zA-Z0-9\-]+

findingIds

array[string]

optional

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

>= 1 items<= 25 items

auditCheckToReasonCodeFilter

object

optional

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

auditCheckToActionsMapping

object

optional

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

actionsDefinition

array[object (MitigationAction) {4}]

optional

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

name

string

optional

A user-friendly name for the mitigation action.

<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

string

optional

A unique identifier for the mitigation action.

roleArn

string

optional

The IAM role ARN used to apply this mitigation action.

>= 20 characters<= 2048 characters

actionParams

object

optional

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException

Modified at 2022-09-10 23:12:16

/audit/findings/{findingId}

/audit/mitigationactions/tasks/{taskId}