maintenance_window_execution_task_invocations

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

Overview

Name	maintenance_window_execution_task_invocations
Type	Resource
Id	aws.ssm.maintenance_window_execution_task_invocations

Fields

The following fields are returned by SELECT queries:

get_maintenance_window_execution_task_invocation

Name	Datatype	Description
end_time	string (date-time)	The time that the task finished running on the target.
execution_id	string	The execution ID.
invocation_id	string	The invocation ID. (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>)
owner_information	string	User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.
parameters	string	The parameters used at the time that the task ran.
start_time	string (date-time)	The time that the task started running on the target.
status	string	The task status for an invocation. (PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, CANCELLED, SKIPPED_OVERLAPPING)
status_details	string	The details explaining the status. Details are only available for certain status values.
task_execution_id	string	The task execution ID. (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	Retrieves the task type for a maintenance window. (RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA)
window_execution_id	string	The maintenance window execution ID. (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>)
window_target_id	string	The maintenance window target ID.

describe_maintenance_window_execution_task_invocations

Name	Datatype	Description
end_time	string (date-time)	The time the invocation finished.
execution_id	string	The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
invocation_id	string	The ID of the task invocation. (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>)
owner_information	string	User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.
parameters	string	The parameters that were provided for the invocation when it was run.
start_time	string (date-time)	The time the invocation started.
status	string	The status of the task invocation. (PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, CANCELLED, SKIPPED_OVERLAPPING)
status_details	string	The details explaining the status of the task invocation. Not available for all status values.
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 task type. (RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA)
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>)
window_target_id	string	The ID of the target definition in this maintenance window the invocation was performed for.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_maintenance_window_execution_task_invocation	select	region		Retrieves information about a specific task running on a specific target.
describe_maintenance_window_execution_task_invocations	select	region		Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

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_invocation

Retrieves information about a specific task running on a specific target.

SELECT
end_time,
execution_id,
invocation_id,
owner_information,
parameters,
start_time,
status,
status_details,
task_execution_id,
task_type,
window_execution_id,
window_target_id
FROM aws.ssm.maintenance_window_execution_task_invocations
WHERE region = '{{ region }}' -- required
;

describe_maintenance_window_execution_task_invocations

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

SELECT
end_time,
execution_id,
invocation_id,
owner_information,
parameters,
start_time,
status,
status_details,
task_execution_id,
task_type,
window_execution_id,
window_target_id
FROM aws.ssm.maintenance_window_execution_task_invocations
WHERE region = '{{ region }}' -- required
;