describe-maintenance-windows¶

Description¶

Retrieves the maintenance windows in an Amazon Web Services account.

Synopsis¶

  describe-maintenance-windows
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled . For example, Name=MyMaintenanceWindow and Enabled=True .

(structure)

Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:

DescribeMaintenanceWindowExecutions

DescribeMaintenanceWindowExecutionTaskInvocations

DescribeMaintenanceWindowExecutionTasks

DescribeMaintenanceWindows

DescribeMaintenanceWindowTargets

DescribeMaintenanceWindowTasks

Key -> (string)

The name of the filter.

Values -> (list)

The filter values.

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To list all maintenance windows

The following describe-maintenance-windows example lists all maintenance windows in your AWS account in the current Region.

aws ssm describe-maintenance-windows

Output:

{
    "WindowIdentities": [
        {
            "WindowId": "mw-0ecb1226ddEXAMPLE",
            "Name": "MyMaintenanceWindow-1",
            "Enabled": true,
            "Duration": 2,
            "Cutoff": 1,
            "Schedule": "rate(180 minutes)",
            "NextExecutionTime": "2020-02-12T23:19:20.596Z"
        },
        {
            "WindowId": "mw-03eb9db428EXAMPLE",
            "Name": "MyMaintenanceWindow-2",
            "Enabled": true,
            "Duration": 3,
            "Cutoff": 1,
            "Schedule": "rate(7 days)",
            "NextExecutionTime": "2020-02-17T23:22:00.956Z"
        },
    ]
}

Example 2: To list all enabled maintenance windows

The following describe-maintenance-windows example lists all enabled maintenance windows.

aws ssm describe-maintenance-windows \
    --filters "Key=Enabled,Values=true"

Example 3: To list maintenance windows matching a specific name

This describe-maintenance-windows example lists all maintenance windows with the specified name.

aws ssm describe-maintenance-windows \
    --filters "Key=Name,Values=MyMaintenanceWindow"

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

Output¶

WindowIdentities -> (list)

Information about the maintenance windows.

(structure)

Information about the maintenance window.

WindowId -> (string)

The ID of the maintenance window.

Name -> (string)

The name of the maintenance window.

Description -> (string)

A description of the maintenance window.

Enabled -> (boolean)

Indicates whether the maintenance window is enabled.

Duration -> (integer)

The duration of the maintenance window in hours.

Cutoff -> (integer)

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

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.

ScheduleOffset -> (integer)

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

EndDate -> (string)

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

StartDate -> (string)

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

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.

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Table of Contents

Feedback

User Guide