DescribeMaintenanceWindowExecutions
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.
Request Syntax
{
"Filters": [
{
"Key": "string
",
"Values": [ "string
" ]
}
],
"MaxResults": number
,
"NextToken": "string
",
"WindowId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
Each entry in the array is a structure containing:
-
Key. A string between 1 and 128 characters. Supported keys include
ExecutedBefore
andExecutedAfter
. -
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
2024-11-04T05:00:00Z
.
Type: Array of MaintenanceWindowFilter objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
-
- MaxResults
-
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.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Required: No
- WindowId
-
The ID of the maintenance window whose executions should be retrieved.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
^mw-[0-9a-f]{17}$
Required: Yes
Response Syntax
{
"NextToken": "string",
"WindowExecutions": [
{
"EndTime": number,
"StartTime": number,
"Status": "string",
"StatusDetails": "string",
"WindowExecutionId": "string",
"WindowId": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Type: String
- WindowExecutions
-
Information about the maintenance window executions.
Type: Array of MaintenanceWindowExecution objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribeMaintenanceWindowExecutions.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 36
X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutions
X-Amz-Date: 20240312T204551Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
{
"WindowId": "mw-0c50858d01EXAMPLE"
}
Sample Response
{
"NextToken": "AAEABbrXFUcgJpmXZxxu+AD17F+5bzlsAyqrig1EXAMPLE...pYY",
"WindowExecutions": [
{
"WindowId": "mw-0c50858d01EXAMPLE",
"WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE",
"Status": "IN_PROGRESS",
"StartTime": "2024-08-04T11:00:00.000000-07:00"
},
{
"WindowId": "mw-0c50858d01EXAMPLE",
"WindowExecutionId": "ff75b750-4834-4377-8f61-b3cadEXAMPLE",
"Status": "SUCCESS",
"StartTime": "2024-08-03T11:00:00.000000-07:00",
"EndTime": "2024-08-03T11:37:21.450000-07:00"
},
{
"WindowId": "mw-0c50858d01EXAMPLE",
"WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE",
"Status": "FAILED",
"StatusDetails": "One or more tasks in the orchestration failed.",
"StartTime": "2024-08-02T11:00:00.000000-07:00",
"EndTime": "2024-08-02T11:22:36.190000-07:00"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: