Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

describe-maintenance-windows

Description

Retrieves the maintenance windows in an AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-maintenance-windows is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: WindowIdentities

Synopsis

  describe-maintenance-windows
[--filters <value>]
[--cli-input-json <value>]
[--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 .

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To list all Maintenance Windows

This example lists all Maintenance Windows on your account.

Command:

aws ssm describe-maintenance-windows

Output:

{
  "WindowIdentities": [
      {
          "Duration": 2,
          "Cutoff": 1,
          "WindowId": "mw-03eb9db42890fb82d",
          "Enabled": true,
          "Name": "TestMaintWin"
      },
  ]
}

To list all enabled Maintenance Windows

This example lists all enabled Maintenance Windows.

Command:

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

To list Maintenance Windows matching a specific name

This example lists all Maintenance Windows with a specific name value.

Command:

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

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

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.