/detect/mitigationactions/executions

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

Requires permission to access the ListDetectMitigationActionsExecutions action.

Request

Query Params

taskId

string

optional

The unique identifier of the task.

violationId

string

optional

The unique identifier of the violation.

thingName

string

optional

The name of the thing whose mitigation actions are listed.

startTime

string

optional

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

endTime

string

optional

The end of the time period for which ML Detect mitigation actions executions are returned.

maxResults

integer

optional

The maximum number of results to return at one time. The default is 25.

nextToken

string

optional

The token for the next set of results.

Responses

🟢200Success

application/json

Body

actionsExecutions

array[object (DetectMitigationActionExecution) {9}]

optional

List of actions executions.

taskId

string

optional

The unique identifier of the task.

>= 1 characters<= 128 characters

Match pattern:

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

violationId

string

optional

The unique identifier of the violation.

>= 1 characters<= 128 characters

Match pattern:

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

actionName

string

optional

The friendly name that uniquely identifies the mitigation action.

<= 128 characters

Match pattern:

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

thingName

string

optional

The name of the thing.

>= 1 characters<= 128 characters

executionStartDate

string <date-time>

optional

The date a mitigation action was started.

executionEndDate

string <date-time>

optional

The date a mitigation action ended.

status

enum<string>

optional

The status of a mitigation action.

Allowed values:

IN_PROGRESSSUCCESSFULFAILEDSKIPPED

errorCode

string

optional

The error code of a mitigation action.

message

string

optional

The message of a mitigation action.

<= 2048 characters

nextToken

string

optional

A token that can be used to retrieve the next set of results, or null if there are no additional results.

<= 4096 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException