/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Retrieves details about a specific a maintenance window execution.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "WindowExecutionId": "string"
}'

Response Example

200 - Example 1

{
    "WindowExecutionId": "string",
    "TaskIds": [],
    "Status": "PENDING",
    "StatusDetails": "string",
    "StartTime": "string",
    "EndTime": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowExecutionId

string

required

The ID of the maintenance window execution that includes the task.

>= 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}$

Examples

Responses

🟢200Success

application/json

Body

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

TaskIds

array[string]

optional

The ID of the task executions from the maintenance window execution.

Status

enum<string>

optional

The status of the maintenance window 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 maintenance window started running.

EndTime

string <date-time>

optional

The time the maintenance window finished running.

🟠480DoesNotExistException

🟠481InternalServerError