Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

GetMaintenanceWindow

Retrieves a Maintenance Window.

Request Syntax

{
   "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.

WindowId

The ID of the desired Maintenance Window.

Type: String

Length Constraints: Fixed length of 20.

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

Required: Yes

Response Syntax

{
   "AllowUnassociatedTargets": boolean,
   "CreatedDate": number,
   "Cutoff": number,
   "Description": "string",
   "Duration": number,
   "Enabled": boolean,
   "ModifiedDate": number,
   "Name": "string",
   "Schedule": "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.

AllowUnassociatedTargets

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

Type: Boolean

CreatedDate

The date the Maintenance Window was created.

Type: Timestamp

Cutoff

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 23.

Description

The description of the Maintenance Window.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Duration

The duration of the Maintenance Window in hours.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 24.

Enabled

Whether the Maintenance Windows is enabled.

Type: Boolean

ModifiedDate

The date the Maintenance Window was last modified.

Type: Timestamp

Name

The name of the Maintenance Window.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

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

Schedule

The schedule of the Maintenance Window in the form of a cron or rate expression.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

WindowId

The ID of the created Maintenance Window.

Type: String

Length Constraints: Fixed length of 20.

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

Errors

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

DoesNotExistException

Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

See Also

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