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

ListDetectMitigationActionsTasks

List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

Request Syntax


GET /detect/mitigationactions/tasks?endTime=endTime&maxResults=maxResults&nextToken=nextToken&startTime=startTime HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

endTime

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

Required: Yes

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token for the next set of results.

startTime

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.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "tasks": [ 
      { 
         "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.

nextToken

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

Type: String

tasks

The collection of ML Detect mitigation tasks that matched the filter criteria.

Type: Array of DetectMitigationActionsTaskSummary objects

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400