audit_mitigation_actions_tasks

Creates, updates, deletes, gets or lists an audit_mitigation_actions_tasks resource.

Overview

Name	audit_mitigation_actions_tasks
Type	Resource
Id	aws.iot.audit_mitigation_actions_tasks

Fields

The following fields are returned by SELECT queries:

list_audit_mitigation_actions_tasks

Name	Datatype	Description
start_time	string (date-time)	The time at which the audit mitigation actions task was started.
task_id	string	The unique identifier for the task. (pattern: <code>[a-zA-Z0-9_-]+</code>)
task_status	string	The current state of the audit mitigation actions task. (IN_PROGRESS, COMPLETED, FAILED, CANCELED)

describe_audit_mitigation_actions_task

Name	Datatype	Description
actions_definition	array	Specifies the mitigation actions and their parameters that are applied as part of this task.
audit_check_to_actions_mapping	object	Specifies the mitigation actions that should be applied to specific audit checks.
end_time	string (date-time)	The date and time when the task was completed or canceled.
start_time	string (date-time)	The date and time when the task was started.
target	object	Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
task_statistics	object	Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
task_status	string	The current status of the task. (IN_PROGRESS, COMPLETED, FAILED, CANCELED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_audit_mitigation_actions_tasks	select	startTime, endTime, region	auditTaskId, findingId, taskStatus, maxResults, nextToken	Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.
describe_audit_mitigation_actions_task	select	task_id, region		Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

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)	Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
region	string	AWS region (default: us-east-1)
startTime	string (date-time)	Specify this filter to limit results to tasks that began on or after a specific date and time.
task_id	string	The unique identifier for the audit mitigation task.
auditTaskId	string	Specify this filter to limit results to tasks that were applied to results for a specific audit.
findingId	string	Specify this filter to limit results to tasks that were applied to a specific audit finding.
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.
taskStatus	string	Specify this filter to limit results to tasks that are in a specific state.

SELECT examples

list_audit_mitigation_actions_tasks

Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.

SELECT
start_time,
task_id,
task_status
FROM aws.iot.audit_mitigation_actions_tasks
WHERE startTime = '{{ startTime }}' -- required
AND endTime = '{{ endTime }}' -- required
AND region = '{{ region }}' -- required
AND auditTaskId = '{{ auditTaskId }}'
AND findingId = '{{ findingId }}'
AND taskStatus = '{{ taskStatus }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

describe_audit_mitigation_actions_task

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

SELECT
actions_definition,
audit_check_to_actions_mapping,
end_time,
start_time,
target,
task_statistics,
task_status
FROM aws.iot.audit_mitigation_actions_tasks
WHERE task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;