Describe Maintenance Window Execution Tasks

ssm_describe_maintenance_window_execution_tasks

R Documentation

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

Description¶

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

Usage¶

ssm_describe_maintenance_window_execution_tasks(WindowExecutionId,
  Filters, MaxResults, NextToken)

Arguments¶

WindowExecutionId

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

Filters

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.

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(
  WindowExecutionTaskIdentities = list(
    list(
      WindowExecutionId = "string",
      TaskExecutionId = "string",
      Status = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"TIMED_OUT"|"CANCELLING"|"CANCELLED"|"SKIPPED_OVERLAPPING",
      StatusDetails = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      TaskArn = "string",
      TaskType = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA",
      AlarmConfiguration = list(
        IgnorePollAlarmFailure = TRUE|FALSE,
        Alarms = list(
          list(
            Name = "string"
          )
        )
      ),
      TriggeredAlarms = list(
        list(
          Name = "string",
          State = "UNKNOWN"|"ALARM"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_maintenance_window_execution_tasks(
  WindowExecutionId = "string",
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)