PUT

/detect/mitigationactions/tasks/{taskId}

http://iot.{region}.amazonaws.com/detect/mitigationactions/tasks/{taskId}

<p> Starts a Device Defender ML Detect mitigation actions task. </p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartDetectMitigationActionsTask</a> action.</p>

Access Token Required: API Key

Path Parameters

taskIdstringrequired

The unique identifier of the task.

Body Params

targetobjectrequired

The target of a mitigation action task.

actionsarrayrequired

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

clientRequestTokenstringrequired

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.

includeSuppressedAlertsboolean

Specifies to include suppressed alerts.

includeOnlyActiveViolationsboolean

Specifies to list only active violations.

violationEventOccurrenceRangeobject

Specifies the time period of which violation events occurred between.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://iot.{region}.amazonaws.com/detect/mitigationactions/tasks/{taskId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}