aws ssm describe-maintenance-window-schedule

Retrieves information about upcoming executions of a maintenance window. AWS CLI reference

3 examples 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list upcoming executions for a maintenance window

The following describe-maintenance-window-schedule example lists all upcoming executions for the specified maintenance window.

aws ssm describe-maintenance-window-schedule --window-id mw-ab12cd34efEXAMPLEIdentify

--window-idThe ID of the maintenance window to retrieve information about.

Its output

{
    "ScheduledWindowExecutions": [
        {
            "WindowId": "mw-ab12cd34efEXAMPLE",
            "Name": "My-First-Maintenance-Window",
            "ExecutionTime": "2020-02-19T16:00Z"
        },
        {
            "WindowId": "mw-ab12cd34efEXAMPLE",
            "Name": "My-First-Maintenance-Window",
            "ExecutionTime": "2020-02-26T16:00Z"
        }
    ]
}

Example 2: To list all upcoming executions for a maintenance window before a specified date

The following describe-maintenance-window-schedule example lists all upcoming executions for the specified maintenance window that occur before the specified date.

aws ssm describe-maintenance-window-schedule --window-id mw-0ecb1226dd7b2e9a6 --filters "Key=ScheduledBefore,Values=2020-02-15T06:00:00Z"

Identify

--window-idThe ID of the maintenance window to retrieve information about.

--filtersFilters used to limit the range of results.

Its output

{
    "ScheduledWindowExecutions": [
        {
            "WindowId": "mw-0ecb1226dd7b2e9a6",
            "Name": "My-Maintenance-Window",
            "ExecutionTime": "2020-02-13T16:00Z"
        },
        {
            "WindowId": "mw-0ecb1226dd7b2e9a6",
            "Name": "My-Maintenance-Window",
            "ExecutionTime": "2020-02-14T16:00Z"
        }
    ]
}

Example 3: To list all upcoming executions for a maintenance window after a specified date

The following describe-maintenance-window-schedule example lists all upcoming executions for the specified maintenance window that occur after the specified date.

aws ssm describe-maintenance-window-schedule --window-id mw-0ecb1226dd7b2e9a6 --filters "Key=ScheduledAfter,Values=2020-02-15T06:00:00Z"

Identify

--window-idThe ID of the maintenance window to retrieve information about.

--filtersFilters used to limit the range of results.

Its output

{
    "ScheduledWindowExecutions": [
        {
            "WindowId": "mw-0ecb1226dd7b2e9a6",
            "Name": "My-Maintenance-Window",
            "ExecutionTime": "2020-02-15T16:00Z"
        },
        {
            "WindowId": "mw-0ecb1226dd7b2e9a6",
            "Name": "My-Maintenance-Window",
            "ExecutionTime": "2020-02-16T16:00Z"
        }
    ]
}

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

Options

6 in the AWS CLI reference

--filtersFilters used to limit the range of results.

--max-resultsThe maximum number of items to return for this call.

--next-tokenThe token for the next set of items to return.

--resource-typeThe type of resource you want to retrieve information about.

--targetsThe managed node ID or key-value pair to retrieve information about.

--window-idThe ID of the maintenance window to retrieve information about.