get-maintenance-window¶

Description¶

Retrieves a maintenance window.

Synopsis¶

  get-maintenance-window
--window-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--window-id (string)

The ID of the maintenance window for which you want to retrieve information.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get information about a maintenance window

The following get-maintenance-window example retrieves details about the specified maintenance window.

aws ssm get-maintenance-window \
    --window-id "mw-03eb9db428EXAMPLE"

Output:

{
    "Cutoff": 1,
    "Name": "TestMaintWin",
    "Schedule": "cron(0 */30 * * * ? *)",
    "Enabled": true,
    "AllowUnassociatedTargets": false,
    "WindowId": "mw-03eb9db428EXAMPLE",
    "ModifiedDate": 1487614445.527,
    "CreatedDate": 1487614445.527,
    "Duration": 2
}

For more information, see View Information About Maintenance Windows (AWS CLI) in the AWS Systems Manager User Guide.

Output¶

WindowId -> (string)

The ID of the created maintenance window.

Name -> (string)

The name of the maintenance window.

Description -> (string)

The description of the maintenance window.

StartDate -> (string)

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

EndDate -> (string)

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

Schedule -> (string)

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”, “etc/UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

ScheduleOffset -> (integer)

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

NextExecutionTime -> (string)

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

Duration -> (integer)

The duration of the maintenance window in hours.

Cutoff -> (integer)

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

AllowUnassociatedTargets -> (boolean)

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

Enabled -> (boolean)

Indicates whether the maintenance window is enabled.

CreatedDate -> (timestamp)

The date the maintenance window was created.

ModifiedDate -> (timestamp)

The date the maintenance window was last modified.

Table of Contents

Feedback

User Guide