Describe Maintenance Window Execution Task Invocations

ssm_describe_maintenance_window_execution_task_invocations

R Documentation

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution¶

Description¶

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

Usage¶

ssm_describe_maintenance_window_execution_task_invocations(
  WindowExecutionId, TaskId, Filters, MaxResults, NextToken)

Arguments¶

WindowExecutionId

[required] The ID of the maintenance window execution the task is part of.

TaskId

[required] The ID of the specific task in the maintenance window task that should be retrieved.

Filters

Optional filters used to scope down the returned task invocations. 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(
  WindowExecutionTaskInvocationIdentities = list(
    list(
      WindowExecutionId = "string",
      TaskExecutionId = "string",
      InvocationId = "string",
      ExecutionId = "string",
      TaskType = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA",
      Parameters = "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"
      ),
      OwnerInformation = "string",
      WindowTargetId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

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