Describe Maintenance Window Tasks

ssm_describe_maintenance_window_tasks

R Documentation

Lists the tasks in a maintenance window

Description

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

Usage

ssm_describe_maintenance_window_tasks(WindowId, Filters, MaxResults,
  NextToken)

Arguments

WindowId

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

Filters

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

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Value

A list with the following syntax:

list(
  Tasks = list(
    list(
      WindowId = "string",
      WindowTaskId = "string",
      TaskArn = "string",
      Type = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA",
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      TaskParameters = list(
        list(
          Values = list(
            "string"
          )
        )
      ),
      Priority = 123,
      LoggingInfo = list(
        S3BucketName = "string",
        S3KeyPrefix = "string",
        S3Region = "string"
      ),
      ServiceRoleArn = "string",
      MaxConcurrency = "string",
      MaxErrors = "string",
      Name = "string",
      Description = "string",
      CutoffBehavior = "CONTINUE_TASK"|"CANCEL_TASK",
      AlarmConfiguration = list(
        IgnorePollAlarmFailure = TRUE|FALSE,
        Alarms = list(
          list(
            Name = "string"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_maintenance_window_tasks(
  WindowId = "string",
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)