Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDetectMitigationActionsTask

Note

The AWS IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to AWS IoT Device Defender detect, see AWS IoT Device Defender detect feature availability change. There is no change to AWS IoT Device Defender audit availability.

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

Request Syntax


GET /detect/mitigationactions/tasks/taskId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

taskId

The unique identifier of the task.

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "taskSummary": { 
      "actionsDefinition": [ 
         { 
            "actionParams": { 
               "addThingsToThingGroupParams": { 
                  "overrideDynamicGroups": boolean,
                  "thingGroupNames": [ "string" ]
               },
               "enableIoTLoggingParams": { 
                  "logLevel": "string",
                  "roleArnForLogging": "string"
               },
               "publishFindingToSnsParams": { 
                  "topicArn": "string"
               },
               "replaceDefaultPolicyVersionParams": { 
                  "templateName": "string"
               },
               "updateCACertificateParams": { 
                  "action": "string"
               },
               "updateDeviceCertificateParams": { 
                  "action": "string"
               }
            },
            "id": "string",
            "name": "string",
            "roleArn": "string"
         }
      ],
      "onlyActiveViolationsIncluded": boolean,
      "suppressedAlertsIncluded": boolean,
      "target": { 
         "behaviorName": "string",
         "securityProfileName": "string",
         "violationIds": [ "string" ]
      },
      "taskEndTime": number,
      "taskId": "string",
      "taskStartTime": number,
      "taskStatistics": { 
         "actionsExecuted": number,
         "actionsFailed": number,
         "actionsSkipped": number
      },
      "taskStatus": "string",
      "violationEventOccurrenceRange": { 
         "endTime": number,
         "startTime": number
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

taskSummary

The description of a task.

Type: DetectMitigationActionsTaskSummary object

Errors

InternalFailureException

An unexpected error has occurred.

message: The message for the exception.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

message: The message for the exception.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400