detect_mitigation_actions_executions

Creates, updates, deletes, gets or lists a detect_mitigation_actions_executions resource.

Overview

Name	detect_mitigation_actions_executions
Type	Resource
Id	aws.iot.detect_mitigation_actions_executions

Fields

The following fields are returned by SELECT queries:

list_detect_mitigation_actions_executions

Name	Datatype	Description
action_name	string	The friendly name that uniquely identifies the mitigation action. (pattern: <code>[a-zA-Z0-9_-]+</code>)
error_code	string	The error code of a mitigation action.
execution_end_date	string (date-time)	The date a mitigation action ended.
execution_start_date	string (date-time)	The date a mitigation action was started.
message	string	The message of a mitigation action.
status	string	The status of a mitigation action. (IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED)
task_id	string	The unique identifier of the task. (pattern: <code>[a-zA-Z0-9_-]+</code>)
thing_name	string	The name of the thing.
violation_id	string	The unique identifier of the violation. (pattern: <code>[a-zA-Z0-9-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_detect_mitigation_actions_executions	select	region	taskId, violationId, thingName, startTime, endTime, maxResults, nextToken	Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
endTime	string (date-time)	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.
startTime	string (date-time)	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.
taskId	string	The unique identifier of the task.
thingName	string	The name of the thing whose mitigation actions are listed.
violationId	string	The unique identifier of the violation.

SELECT examples

list_detect_mitigation_actions_executions

Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.

SELECT
action_name,
error_code,
execution_end_date,
execution_start_date,
message,
status,
task_id,
thing_name,
violation_id
FROM aws.iot.detect_mitigation_actions_executions
WHERE region = '{{ region }}' -- required
AND taskId = '{{ taskId }}'
AND violationId = '{{ violationId }}'
AND thingName = '{{ thingName }}'
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;