List Executors

athena_list_executors

R Documentation

Lists, in descending order, the executors that joined a session

Description

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Usage

athena_list_executors(SessionId, ExecutorStateFilter, MaxResults,
  NextToken)

Arguments

SessionId

[required] The session ID.

ExecutorStateFilter

A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

MaxResults

The maximum number of executors to return.

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Value

A list with the following syntax:

list(
  SessionId = "string",
  NextToken = "string",
  ExecutorsSummary = list(
    list(
      ExecutorId = "string",
      ExecutorType = "COORDINATOR"|"GATEWAY"|"WORKER",
      StartDateTime = 123,
      TerminationDateTime = 123,
      ExecutorState = "CREATING"|"CREATED"|"REGISTERED"|"TERMINATING"|"TERMINATED"|"FAILED",
      ExecutorSize = 123
    )
  )
)

Request syntax

svc$list_executors(
  SessionId = "string",
  ExecutorStateFilter = "CREATING"|"CREATED"|"REGISTERED"|"TERMINATING"|"TERMINATED"|"FAILED",
  MaxResults = 123,
  NextToken = "string"
)