/

The Amazon SSM multi-region endpoint

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

POST

Updates an existing maintenance window. Only specified parameters are modified.

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 '{
    "WindowId": "string",
    "Name": "string",
    "Description": "string",
    "StartDate": "string",
    "EndDate": "string",
    "Schedule": "string",
    "ScheduleTimezone": "string",
    "ScheduleOffset": 0,
    "Duration": 0,
    "Cutoff": 0,
    "AllowUnassociatedTargets": true,
    "Enabled": true,
    "Replace": true
}'

Response Example

200 - Example 1

{
    "WindowId": "string",
    "Name": "string",
    "Description": "string",
    "StartDate": "string",
    "EndDate": "string",
    "Schedule": "string",
    "ScheduleTimezone": "string",
    "ScheduleOffset": 0,
    "Duration": 0,
    "Cutoff": 0,
    "AllowUnassociatedTargets": true,
    "Enabled": true
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The ID of the maintenance window to update.

>= 20 characters<= 20 characters

Match pattern:

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

Name

string

optional

The name of the maintenance window.

>= 3 characters<= 128 characters

Match pattern:

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

Description

string <password>

optional

An optional description for the update request.

>= 1 characters<= 128 characters

StartDate

string

optional

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

EndDate

string

optional

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Schedule

string

optional

The schedule of the maintenance window in the form of a cron or rate expression.

>= 1 characters<= 256 characters

ScheduleTimezone

string

optional

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

ScheduleOffset

integer

optional

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

>= 1<= 6

Duration

integer

optional

The duration of the maintenance window in hours.

>= 1<= 24

Cutoff

integer

optional

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

>= 0<= 23

AllowUnassociatedTargets

boolean

optional

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Enabled

boolean

optional

Whether the maintenance window is enabled.

Replace

boolean

optional

If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

Examples

Responses

🟢200Success

application/json

Body

WindowId

string

optional

The ID of the created maintenance window.

>= 20 characters<= 20 characters

Match pattern:

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

Name

string

optional

The name of the maintenance window.

>= 3 characters<= 128 characters

Match pattern:

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

Description

string <password>

optional

An optional description of the update.

>= 1 characters<= 128 characters

StartDate

string

optional

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

EndDate

string

optional

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

Schedule

string

optional

The schedule of the maintenance window in the form of a cron or rate expression.

>= 1 characters<= 256 characters

ScheduleTimezone

string

optional

ScheduleOffset

integer

optional

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

>= 1<= 6

Duration

integer

optional

The duration of the maintenance window in hours.

>= 1<= 24

Cutoff

integer

optional

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

>= 0<= 23

AllowUnassociatedTargets

boolean

optional

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Enabled

boolean

optional

Whether the maintenance window is enabled.

🟠480DoesNotExistException

🟠481InternalServerError