AWS CLI Command Reference

[ aws . ssm ]

describe-maintenance-window-executions

Description

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-maintenance-window-executions 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: WindowExecutions

Synopsis

  describe-maintenance-window-executions
--window-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--window-id (string)

The ID of the maintenance window whose executions should be retrieved.

--filters (list)

Each entry in the array is a structure containing:

Key (string, between 1 and 128 characters)

Values (array of strings, each string is between 1 and 256 characters)

The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.

(structure)

Filter used in the request. Supported filter keys are Name and Enabled.

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.

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

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To list all executions for a maintenance window

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

aws ssm describe-maintenance-window-executions \
    --window-id "mw-ab12cd34eEXAMPLE"

Output:

{
    "WindowExecutions": [
        {
            "Status": "SUCCESS",
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "StartTime": 1487692834.595,
            "EndTime": 1487692835.051,
            "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355"
        }
    ]
}

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

The following describe-maintenance-window-executions example lists all of the executions for the specified maintenance window before the specified date.

aws ssm describe-maintenance-window-executions \
    --window-id "mw-ab12cd34eEXAMPLE" \
    --filters "Key=ExecutedBefore,Values=2020-11-04T05:00:00Z"

Output:

{
    "WindowExecutions": [
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowExecutionId": "407a2cc0-9602-4463-af87-9d94bEXAMPLE",
            "Status": "SUCCESS",
            "StartTime": 1581546172.042,
            "EndTime": 1581546172.454
        },
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowExecutionId": "a45d2571-f225-45a2-b448-bf57aEXAMPLE",
            "Status": "FAILED",
            "StatusDetails": "One or more tasks in the orchestration failed.",
            "StartTime": 1579891950.312,
            "EndTime": 1579891950.35
        }
    ]
}

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

The following describe-maintenance-window-executions example lists all of the executions for the specified maintenance window after the specified date.

aws ssm describe-maintenance-window-executions \
    --window-id "mw-ab12cd34eEXAMPLE" \
    --filters "Key=ExecutedAfter,Values=2016-11-04T17:00:00Z"

Output:

{
    "WindowExecutions": [
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowExecutionId": "f4ad7a92-d83f-4569-a437-dea8fe74e315EXAMPLE",
            "Status": "SUCCESS",
            "StartTime": 1581546531.776,
            "EndTime": 1581546532.219
        },
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowExecutionId": "0bb99ef3-c3cc-4160-bded-d3e61EXAMPLE",
            "Status": "SUCCESS",
            "StartTime": 1581546352.01,
            "EndTime": 1581546352.403
        },
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowExecutionId": "407a2cc0-9602-4463-af87-9d94bEXAMPLE",
            "Status": "SUCCESS",
            "StartTime": 1581546172.042,
            "EndTime": 1581546172.454
        }
    ]
}

For more information, see View Information About Tasks and Task Executions (AWS CLI) in the AWS Systems Manager User Guide.

Output

WindowExecutions -> (list)

Information about the maintenance window executions.

(structure)

Describes the information about an execution of a maintenance window.

WindowId -> (string)

The ID of the maintenance window.

WindowExecutionId -> (string)

The ID of the maintenance window execution.

Status -> (string)

The status of the execution.

StatusDetails -> (string)

The details explaining the Status. Only available for certain status values.

StartTime -> (timestamp)

The time the execution started.

EndTime -> (timestamp)

The time the execution finished.

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.

© Copyright 2018, Amazon Web Services. Created using Sphinx.