detect_mitigation_actions_tasks

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

Overview

Name	detect_mitigation_actions_tasks
Type	Resource
Id	aws.iot.detect_mitigation_actions_tasks

Fields

The following fields are returned by SELECT queries:

list_detect_mitigation_actions_tasks

Name	Datatype	Description
actions_definition	array	The definition of the actions.
only_active_violations_included	boolean	Includes only active violations.
suppressed_alerts_included	boolean	Includes suppressed alerts.
target	object	Specifies the ML Detect findings to which the mitigation actions are applied.
task_end_time	string (date-time)	The date the task ended.
task_id	string	The unique identifier of the task. (pattern: <code>[a-zA-Z0-9_-]+</code>)
task_start_time	string (date-time)	The date the task started.
task_statistics	object	The statistics of a mitigation action task.
task_status	string	The status of the task. (IN_PROGRESS, SUCCESSFUL, FAILED, CANCELED)
violation_event_occurrence_range	object	Specifies the time period of which violation events occurred between.

describe_detect_mitigation_actions_task

Name	Datatype	Description
actions_definition	array	The definition of the actions.
only_active_violations_included	boolean	Includes only active violations.
suppressed_alerts_included	boolean	Includes suppressed alerts.
target	object	Specifies the ML Detect findings to which the mitigation actions are applied.
task_end_time	string (date-time)	The date the task ended.
task_id	string	The unique identifier of the task. (pattern: <code>[a-zA-Z0-9_-]+</code>)
task_start_time	string (date-time)	The date the task started.
task_statistics	object	The statistics of a mitigation action task.
task_status	string	The status of the task. (IN_PROGRESS, SUCCESSFUL, FAILED, CANCELED)
violation_event_occurrence_range	object	Specifies the time period of which violation events occurred between.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_detect_mitigation_actions_tasks	select	startTime, endTime, region	maxResults, nextToken	List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.
describe_detect_mitigation_actions_task	select	task_id, region		Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask 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
endTime	string (date-time)	The end of the time period for which ML Detect mitigation actions tasks are returned.
region	string	AWS region (default: us-east-1)
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.
task_id	string	The unique identifier of the task.
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.

SELECT examples

list_detect_mitigation_actions_tasks

List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.

SELECT
actions_definition,
only_active_violations_included,
suppressed_alerts_included,
target,
task_end_time,
task_id,
task_start_time,
task_statistics,
task_status,
violation_event_occurrence_range
FROM aws.iot.detect_mitigation_actions_tasks
WHERE startTime = '{{ startTime }}' -- required
AND endTime = '{{ endTime }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

describe_detect_mitigation_actions_task

Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action.

SELECT
actions_definition,
only_active_violations_included,
suppressed_alerts_included,
target,
task_end_time,
task_id,
task_start_time,
task_statistics,
task_status,
violation_event_occurrence_range
FROM aws.iot.detect_mitigation_actions_tasks
WHERE task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;