/ - Amazon Simple Systems Manager (SSM)

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.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "WindowId": "string", "Filters": [], "MaxResults": 0, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The ID of the maintenance window whose executions should be retrieved.

>= 20 characters<= 20 characters

Match pattern:

^mw-[0-9a-f]{17}$

Filters

array [object]

optional

Each entry in the array is a structure containing:

Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.

>= 0 items<= 5 items

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 10<= 100

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

Examples

Responses

🟢200Success

application/json

Body

WindowExecutions

array[object (MaintenanceWindowExecution) {6}]

optional

Information about the maintenance window executions.

WindowId

string

optional

The ID of the maintenance window.

>= 20 characters<= 20 characters

Match pattern:

^mw-[0-9a-f]{17}$

WindowExecutionId

string

optional

The ID of the maintenance window execution.

>= 36 characters<= 36 characters

Match pattern:

^[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}$

Status

enum<string>

optional

The status of the execution.

Allowed values:

PENDINGIN_PROGRESSSUCCESSFAILEDTIMED_OUTCANCELLINGCANCELLEDSKIPPED_OVERLAPPING

StatusDetails

string

optional

The details explaining the status. Not available for all status values.

>= 0 characters<= 250 characters

StartTime

string <date-time>

optional

The time the execution started.

EndTime

string <date-time>

optional

The time the execution finished.

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError