audit_mitigation_actions_executions

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

Overview

Name	audit_mitigation_actions_executions
Type	Resource
Id	aws.iot.audit_mitigation_actions_executions

Fields

The following fields are returned by SELECT queries:

list_audit_mitigation_actions_executions

Name	Datatype	Description
action_id	string	The unique identifier for the mitigation action being applied by the task.
action_name	string	The friendly name of the mitigation action being applied by the task. (pattern: <code>[a-zA-Z0-9_-]+</code>)
end_time	string (date-time)	The date and time when the task was completed or canceled. Blank if the task is still running.
error_code	string	If an error occurred, the code that indicates which type of error occurred.
finding_id	string	The unique identifier for the findings to which the task and associated mitigation action are applied. (pattern: <code>[a-zA-Z0-9_-]+</code>)
message	string	If an error occurred, a message that describes the error.
start_time	string (date-time)	The date and time when the task was started.
status	string	The current status of the task being executed. (IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED, PENDING)
task_id	string	The unique identifier for the task that applies the mitigation action. (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_audit_mitigation_actions_executions	select	taskId, findingId, region	actionStatus, maxResults, nextToken	Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions 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
findingId	string	Specify this filter to limit results to those that were applied to a specific audit finding.
region	string	AWS region (default: us-east-1)
taskId	string	Specify this filter to limit results to actions for a specific audit mitigation actions task.
actionStatus	string	Specify this filter to limit results to those with a specific status.
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_audit_mitigation_actions_executions

Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.

SELECT
action_id,
action_name,
end_time,
error_code,
finding_id,
message,
start_time,
status,
task_id
FROM aws.iot.audit_mitigation_actions_executions
WHERE taskId = '{{ taskId }}' -- required
AND findingId = '{{ findingId }}' -- required
AND region = '{{ region }}' -- required
AND actionStatus = '{{ actionStatus }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;