DescribeMaintenanceWindowSchedule - AWS Systems Manager


Retrieves information about upcoming executions of a maintenance window.

Request Syntax

{ "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "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 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.

Type: Array of PatchOrchestratorFilter objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No


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 1.

Required: No


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

Type: String

Required: No


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

Type: String


Required: No


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

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No


The ID of the maintenance window to retrieve information about.

Type: String

Length Constraints: Fixed length of 20.

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

Required: No

Response Syntax

{ "NextToken": "string", "ScheduledWindowExecutions": [ { "ExecutionTime": "string", "Name": "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.


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

Type: String


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

Type: Array of ScheduledWindowExecution objects


For information about the errors that are common to all actions, see Common Errors.


Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400


An error occurred on the server side.

HTTP Status Code: 500



This example illustrates one usage of DescribeMaintenanceWindowSchedule.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowSchedule Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20200224T235938Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200224/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 36 { "WindowId": "mw-0c50858d01EXAMPLE" }

Sample Response

{ "NextToken": "EXAMPLE/39c3b3042cd2aEXAMPLEAKIAIOSFODNN7EXAMPLE==", "ScheduledWindowExecutions": [ { "ExecutionTime": "2020-02-25T00:00:15.099Z", "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "ExecutionTime": "2020-02-26T00:00:15.099Z", "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "ExecutionTime": "2020-02-27T00:00:15.099Z", "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: