maintenance_window_executions
Creates, updates, deletes, gets or lists a maintenance_window_executions resource.
Overview
| Name | maintenance_window_executions |
| Type | Resource |
| Id | aws.ssm.maintenance_window_executions |
Fields
The following fields are returned by SELECT queries:
- describe_maintenance_window_executions
- get_maintenance_window_execution
| Name | Datatype | Description |
|---|---|---|
end_time | string (date-time) | The time the execution finished. |
start_time | string (date-time) | The time the execution started. |
status | string | The status of the execution. (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. |
window_execution_id | string | The ID of 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>) |
window_id | string | The ID of the maintenance window. (pattern: <code>^mw-[0-9a-f]{17}$</code>) |
| Name | Datatype | Description |
|---|---|---|
end_time | string (date-time) | The time the maintenance window finished running. |
start_time | string (date-time) | The time the maintenance window started running. |
status | string | The status of the maintenance window execution. (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_ids | array | The ID of the task executions from the maintenance window execution. |
window_execution_id | string | The ID of 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>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_maintenance_window_executions | select | region | Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window. | |
get_maintenance_window_execution | select | region | Retrieves details about a specific 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
- describe_maintenance_window_executions
- get_maintenance_window_execution
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
SELECT
end_time,
start_time,
status,
status_details,
window_execution_id,
window_id
FROM aws.ssm.maintenance_window_executions
WHERE region = '{{ region }}' -- required
;
Retrieves details about a specific a maintenance window execution.
SELECT
end_time,
start_time,
status,
status_details,
task_ids,
window_execution_id
FROM aws.ssm.maintenance_window_executions
WHERE region = '{{ region }}' -- required
;