SSM / Client / create_maintenance_window

create_maintenance_window#

SSM.Client.create_maintenance_window(**kwargs)#

Creates a new maintenance window.

Note

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

See also: AWS API Documentation

Request Syntax

response = client.create_maintenance_window(
    Name='string',
    Description='string',
    StartDate='string',
    EndDate='string',
    Schedule='string',
    ScheduleTimezone='string',
    ScheduleOffset=123,
    Duration=123,
    Cutoff=123,
    AllowUnassociatedTargets=True|False,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the maintenance window.

  • Description (string) – An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

  • StartDate (string) – 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) – 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.

  • ScheduleTimezone (string) – 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) –

    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.

  • Duration (integer) –

    [REQUIRED]

    The duration of the maintenance window in hours.

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

  • 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) –

    User-provided idempotency token.

    This field is autopopulated if not provided.

  • Tags (list) –

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

    • Key=TaskType,Value=AgentUpdate

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    Note

    To add tags to an existing maintenance window, use the AddTagsToResource operation.

    • (dict) –

      Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

      • Key (string) – [REQUIRED]

        The name of the tag.

      • Value (string) – [REQUIRED]

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'WindowId': 'string'
}

Response Structure

  • (dict) –

    • WindowId (string) –

      The ID of the created maintenance window.

Exceptions

  • SSM.Client.exceptions.IdempotentParameterMismatch

  • SSM.Client.exceptions.ResourceLimitExceededException

  • SSM.Client.exceptions.InternalServerError