/detect/mitigationactions/tasks/{taskId}

The AWS IoT Wireless multi-region endpoint

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

GET

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "taskSummary": {
        "taskId": "string",
        "taskStatus": "IN_PROGRESS",
        "taskStartTime": "string",
        "taskEndTime": "string",
        "target": {
            "violationIds": [],
            "securityProfileName": "string",
            "behaviorName": "string"
        },
        "violationEventOccurrenceRange": {
            "startTime": "string",
            "endTime": "string"
        },
        "onlyActiveViolationsIncluded": true,
        "suppressedAlertsIncluded": true,
        "actionsDefinition": [],
        "taskStatistics": {
            "actionsExecuted": 0,
            "actionsSkipped": 0,
            "actionsFailed": 0
        }
    }
}

Request

Path Params

taskId

string

required

The unique identifier of the task.

Responses

🟢200Success

application/json

Body

taskSummary

object

optional

The description of a task.

taskId

string

optional

The unique identifier of the task.

>= 1 characters<= 128 characters

Match pattern:

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

taskStatus

enum<string>

optional

The status of the task.

Allowed values:

IN_PROGRESSSUCCESSFULFAILEDCANCELED

taskStartTime

string <date-time>

optional

The date the task started.

taskEndTime

string <date-time>

optional

The date the task ended.

target

object

optional

Specifies the ML Detect findings to which the mitigation actions are applied.

violationEventOccurrenceRange

object

optional

Specifies the time period of which violation events occurred between.

onlyActiveViolationsIncluded

boolean

optional

Includes only active violations.

suppressedAlertsIncluded

boolean

optional

Includes suppressed alerts.

actionsDefinition

array[object (MitigationAction) {4}]

optional

The definition of the actions.

taskStatistics

object

optional

The statistics of a mitigation action task.

🟠480ResourceNotFoundException

🟠481InvalidRequestException

🟠482ThrottlingException

🟠483InternalFailureException

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

/audit/tasks/{taskId}

/detect/mitigationactions/tasks/{taskId}