[ aws . ssm ]

describe-maintenance-window-execution-tasks

Description

For a given maintenance window execution, lists the tasks that were run.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-maintenance-window-execution-tasks 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: WindowExecutionTaskIdentities

Synopsis

  describe-maintenance-window-execution-tasks
--window-execution-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-execution-id (string)

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

--filters (list)

Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

(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

To list all tasks associated with a maintenance window execution

The following ssm describe-maintenance-window-execution-tasks example lists the tasks associated with the specified maintenance window execution.

aws ssm describe-maintenance-window-execution-tasks \
    --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Output:

{
    "WindowExecutionTaskIdentities": [
        {
            "Status": "SUCCESS",
            "TaskArn": "AWS-RunShellScript",
            "StartTime": 1487692834.684,
            "TaskType": "RUN_COMMAND",
            "EndTime": 1487692835.005,
            "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE",
            "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"
        }
    ]
}

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

Output

WindowExecutionTaskIdentities -> (list)

Information about the task executions.

(structure)

Information about a task execution performed as part of a maintenance window execution.

WindowExecutionId -> (string)

The ID of the maintenance window execution that ran the task.

TaskExecutionId -> (string)

The ID of the specific task execution in the maintenance window execution.

Status -> (string)

The status of the task execution.

StatusDetails -> (string)

The details explaining the status of the task execution. Only available for certain status values.

StartTime -> (timestamp)

The time the task execution started.

EndTime -> (timestamp)

The time the task execution finished.

TaskArn -> (string)

The ARN of the task that ran.

TaskType -> (string)

The type of task that ran.

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.