Table Of Contents

Feedback

User Guide

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

[ aws . ssm ]

describe-maintenance-window-tasks

Description

Lists the tasks in a maintenance window.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

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

Synopsis

  describe-maintenance-window-tasks
--window-id <value>
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--window-id (string)

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

--filters (list)

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

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 tasks for a Maintenance Window

This example lists all of the tasks for a Maintenance Window.

Command:

aws ssm describe-maintenance-window-tasks --window-id "mw-06cf17cbefcb4bf4f"

Output:

{
  "Tasks": [
      {
          "ServiceRoleArn": "arn:aws:iam::<aws_account_id>:role/MaintenanceWindowsRole",
          "MaxErrors": "1",
          "TaskArn": "AWS-RunShellScript",
          "MaxConcurrency": "1",
          "WindowTaskId": "a23e338d-ff30-4398-8aa3-09cd052ebf17",
          "TaskParameters": {
              "commands": {
                  "Values": [
                      "df"
                  ]
              }
          },
          "Priority": 10,
          "WindowId": "mw-06cf17cbefcb4bf4f",
          "Type": "RUN_COMMAND",
          "Targets": [
              {
                  "Values": [
                      "i-0000293ffd8c57862"
                  ],
                  "Key": "InstanceIds"
              }
          ]
      }
  ]
}

To list all tasks for a Maintenance Window that invoke the AWS-RunPowerShellScript Run Command

This example lists all of the tasks for a Maintenance Window that invoke the AWS-RunPowerShellScript Run Command.

Command:

aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=TaskArn,Values=AWS-RunPowerShellScript"

To list all tasks for a Maintenance Window that have a Priority of 3

This example lists all of the tasks for a Maintenance Window that have a Priority of 3.

Command:

aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=Priority,Values=3"

To list all tasks for a Maintenance Window that have a Priority of 1 and use Run Command

This example lists all of the tasks for a Maintenance Window that have a Priority of 1 and use Run Command.

Command:

aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND"

Output

Tasks -> (list)

Information about the tasks in the maintenance window.

(structure)

Information about a task defined for a maintenance window.

WindowId -> (string)

The ID of the maintenance window where the task is registered.

WindowTaskId -> (string)

The task ID.

TaskArn -> (string)

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

Type -> (string)

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.

Targets -> (list)

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=tag name,Values=tag value.

(structure)

An array of search criteria that targets instances using a Key,Value combination that you specify.

Supported formats include the following.

  • ``Key=InstanceIds,Values=*instance-id-1* ,*instance-id-2* ,*instance-id-3* ``
  • ``Key=tag:my-tag-key ,Values=*my-tag-value-1* ,*my-tag-value-2* ``
  • ``Key=tag-key,Values=*my-tag-key-1* ,*my-tag-key-2* ``
  • (Maintenance window targets only) ``Key=resource-groups:Name,Values=*resource-group-name* ``
  • (Maintenance window targets only) ``Key=resource-groups:ResourceTypeFilters,Values=*resource-type-1* ,*resource-type-2* ``

For example:

  • Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
  • Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
  • Key=tag-key,Values=Name,Instance-Type,CostCenter
  • (Maintenance window targets only) Key=resource-groups:Name,Values=ProductionResourceGroup
  • (Maintenance window targets only) ``Key=resource-groups:ResourceTypeFilters,Values=*AWS::EC2::INSTANCE* ,*AWS::EC2::VPC* ``

For information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide .

Key -> (string)

User-defined criteria for sending commands that target instances that meet the criteria.

Values -> (list)

User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer .

(string)

TaskParameters -> (map)

The parameters that should be passed to the task when it is run.

Note

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .

key -> (string)

value -> (structure)

Defines the values for a task parameter.

Values -> (list)

This field contains an array of 0 or more strings, each 1 to 255 characters in length.

(string)

Priority -> (integer)

The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

LoggingInfo -> (structure)

Information about an Amazon S3 bucket to write task-level logs to.

Note

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .

S3BucketName -> (string)

The name of an Amazon S3 bucket where execution logs are stored .

S3KeyPrefix -> (string)

(Optional) The Amazon S3 bucket subfolder.

S3Region -> (string)

The region where the Amazon S3 bucket is located.

ServiceRoleArn -> (string)

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

MaxConcurrency -> (string)

The maximum number of targets this task can be run for, in parallel.

MaxErrors -> (string)

The maximum number of errors allowed before this task stops being scheduled.

Name -> (string)

The task name.

Description -> (string)

A description of the task.

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.