/detect/mitigationactions/tasks/{taskId}

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

curl --location -g --request PUT 'https://api.iotwireless.{region}.amazonaws.com/detect/mitigationactions/tasks/' \ --header 'Content-Type: application/json' \ --data-raw '{ "target": { "violationIds": [], "securityProfileName": "string", "behaviorName": "string" }, "actions": [ "string" ], "violationEventOccurrenceRange": { "startTime": "string", "endTime": "string" }, "includeOnlyActiveViolations": true, "includeSuppressedAlerts": true, "clientRequestToken": "string" }'

Request

Path Params

taskId

string

required

The unique identifier of the task.

Body Params application/json

target

object

required

The target of a mitigation action task.

violationIds

array[string]

optional

The unique identifiers of the violations.

>= 1 items<= 25 items

securityProfileName

string

optional

The name of the security profile.

>= 1 characters<= 128 characters

Match pattern:

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

behaviorName

string

optional

The name of the behavior.

>= 1 characters<= 128 characters

Match pattern:

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

actions

array[string]

required

The actions to be performed when a device has unexpected behavior.

>= 1 items<= 5 items

violationEventOccurrenceRange

object

optional

Specifies the time period of which violation events occurred between.

startTime

string <date-time>

optional

The start date and time of a time period in which violation events occurred.

endTime

string <date-time>

optional

The end date and time of a time period in which violation events occurred.

includeOnlyActiveViolations

boolean

optional

Specifies to list only active violations.

includeSuppressedAlerts

boolean

optional

Specifies to include suppressed alerts.

clientRequestToken

string

required

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

>= 1 characters<= 64 characters

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

taskId

string

optional

The unique identifier of the task.

>= 1 characters<= 128 characters

Match pattern:

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

🟠480InvalidRequestException

🟠481TaskAlreadyExistsException

🟠482LimitExceededException

🟠483ThrottlingException

🟠484InternalFailureException