/ - Amazon Simple Systems Manager (SSM)

Retrieves information about upcoming executions of a 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", "Targets": [], "ResourceType": "INSTANCE", "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

optional

The ID of the maintenance window to retrieve information about.

>= 20 characters<= 20 characters

Match pattern:

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

Targets

array [object]

optional

The managed node ID or key-value pair to retrieve information about.

>= 0 items<= 5 items

ResourceType

enum<string>

optional

The type of resource you want to retrieve information about. For example, INSTANCE.

Allowed values:

INSTANCERESOURCE_GROUP

Filters

array[object (PatchOrchestratorFilter) {2}]

optional

Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

>= 0 items<= 5 items

Key

string

optional

The key for the filter.

>= 1 characters<= 128 characters

Values

array[string]

optional

The value for the filter.

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.

>= 1

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

ScheduledWindowExecutions

array[object (ScheduledWindowExecution) {3}]

optional

Information about maintenance window executions scheduled for the specified time range.

WindowId

string

optional

The ID of the maintenance window to be run.

>= 20 characters<= 20 characters

Match pattern:

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

Name

string

optional

The name of the maintenance window to be run.

>= 3 characters<= 128 characters

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

ExecutionTime

string

optional

The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.

NextToken

string

optional

The token for the next set of items to return. (You use this token in the next call.)

🟠480InternalServerError

🟠481DoesNotExistException