IoT / Client / list_detect_mitigation_actions_executions
list_detect_mitigation_actions_executions#
- IoT.Client.list_detect_mitigation_actions_executions(**kwargs)#
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
See also: AWS API Documentation
Request Syntax
response = client.list_detect_mitigation_actions_executions( taskId='string', violationId='string', thingName='string', startTime=datetime(2015, 1, 1), endTime=datetime(2015, 1, 1), maxResults=123, nextToken='string' )
- Parameters:
taskId (string) – The unique identifier of the task.
violationId (string) – The unique identifier of the violation.
thingName (string) – The name of the thing whose mitigation actions are listed.
startTime (datetime) – 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 (datetime) – The end of the time period for which ML Detect mitigation actions executions are returned.
maxResults (integer) – The maximum number of results to return at one time. The default is 25.
nextToken (string) – The token for the next set of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'actionsExecutions': [ { 'taskId': 'string', 'violationId': 'string', 'actionName': 'string', 'thingName': 'string', 'executionStartDate': datetime(2015, 1, 1), 'executionEndDate': datetime(2015, 1, 1), 'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'SKIPPED', 'errorCode': 'string', 'message': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
actionsExecutions (list) –
List of actions executions.
(dict) –
Describes which mitigation actions should be executed.
taskId (string) –
The unique identifier of the task.
violationId (string) –
The unique identifier of the violation.
actionName (string) –
The friendly name that uniquely identifies the mitigation action.
thingName (string) –
The name of the thing.
executionStartDate (datetime) –
The date a mitigation action was started.
executionEndDate (datetime) –
The date a mitigation action ended.
status (string) –
The status of a mitigation action.
errorCode (string) –
The error code of a mitigation action.
message (string) –
The message of a mitigation action.
nextToken (string) –
A token that can be used to retrieve the next set of results, or
null
if there are no additional results.
Exceptions
IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.InternalFailureException