/

The Amazon SSM multi-region endpoint

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

POST

Creates a new maintenance window.

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 '{
    "Name": "string",
    "Description": "string",
    "StartDate": "string",
    "EndDate": "string",
    "Schedule": "string",
    "ScheduleTimezone": "string",
    "ScheduleOffset": 0,
    "Duration": 0,
    "Cutoff": 0,
    "AllowUnassociatedTargets": true,
    "ClientToken": "string",
    "Tags": []
}'

Response Example

200 - Example 1

{
    "WindowId": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

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 maintenance window. We recommend specifying a description to help you organize your maintenance windows.

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

required

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 on 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

required

The duration of the maintenance window in hours.

>= 1<= 24

Cutoff

integer

required

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

required

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

ClientToken

string

optional

User-provided idempotency token.

>= 1 characters<= 64 characters

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

🟠480IdempotentParameterMismatch

🟠481ResourceLimitExceededException

🟠482InternalServerError