maintenance_window_execution_tasks

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

Overview

Name	maintenance_window_execution_tasks
Type	Resource
Id	aws.ssm.maintenance_window_execution_tasks

Fields

The following fields are returned by SELECT queries:

get_maintenance_window_execution_task

Name	Datatype	Description
alarm_configuration	object	The details for the CloudWatch alarm you want to apply to an automation or command.
end_time	string (date-time)	The time the task execution completed.
max_concurrency	string	The defined maximum number of task executions that could be run in parallel. (pattern: <code>^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$</code>)
max_errors	string	The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped. (pattern: <code>^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$</code>)
priority	integer	The priority of the task.
service_role	string	The role that was assumed when running the task.
start_time	string (date-time)	The time the task execution started.
status	string	The status of the task. (PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, CANCELLED, SKIPPED_OVERLAPPING)
status_details	string	The details explaining the status. Not available for all status values.
task_arn	string	The Amazon Resource Name (ARN) of the task that ran.
task_execution_id	string	The ID of the specific task execution in the maintenance window task that was retrieved. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)
task_parameters	array	The parameters passed to the task when it was run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each between 1 and 255 characters
triggered_alarms	array	The CloudWatch alarms that were invoked by the maintenance window task.
type	string	The type of task that was run. (RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA)
window_execution_id	string	The ID of the maintenance window execution that includes the task. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)

describe_maintenance_window_execution_tasks

Name	Datatype	Description
alarm_configuration	object	The details for the CloudWatch alarm you want to apply to an automation or command.
end_time	string (date-time)	The time the task execution finished.
start_time	string (date-time)	The time the task execution started.
status	string	The status of the task execution. (PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, CANCELLED, SKIPPED_OVERLAPPING)
status_details	string	The details explaining the status of the task execution. Not available for all status values.
task_arn	string	The Amazon Resource Name (ARN) of the task that ran.
task_execution_id	string	The ID of the specific task execution in the maintenance window execution. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)
task_type	string	The type of task that ran. (RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA)
triggered_alarms	array	The CloudWatch alarm that was invoked by the maintenance window task.
window_execution_id	string	The ID of the maintenance window execution that ran the task. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_maintenance_window_execution_task	select	region		Retrieves the details about a specific task run as part of a maintenance window execution.
describe_maintenance_window_execution_tasks	select	region		For a given maintenance window execution, lists the tasks that were run.

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)

SELECT examples

get_maintenance_window_execution_task

Retrieves the details about a specific task run as part of a maintenance window execution.

SELECT
alarm_configuration,
end_time,
max_concurrency,
max_errors,
priority,
service_role,
start_time,
status,
status_details,
task_arn,
task_execution_id,
task_parameters,
triggered_alarms,
type,
window_execution_id
FROM aws.ssm.maintenance_window_execution_tasks
WHERE region = '{{ region }}' -- required
;

describe_maintenance_window_execution_tasks

For a given maintenance window execution, lists the tasks that were run.

SELECT
alarm_configuration,
end_time,
start_time,
status,
status_details,
task_arn,
task_execution_id,
task_type,
triggered_alarms,
window_execution_id
FROM aws.ssm.maintenance_window_execution_tasks
WHERE region = '{{ region }}' -- required
;