List Sessions

athena_list_sessions

R Documentation

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY

Description

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Usage

athena_list_sessions(WorkGroup, StateFilter, MaxResults, NextToken)

Arguments

WorkGroup

[required] The workgroup to which the session belongs.

StateFilter

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

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

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

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

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

MaxResults

The maximum number of sessions 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(
  NextToken = "string",
  Sessions = list(
    list(
      SessionId = "string",
      Description = "string",
      EngineVersion = list(
        SelectedEngineVersion = "string",
        EffectiveEngineVersion = "string"
      ),
      NotebookVersion = "string",
      Status = list(
        StartDateTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedDateTime = as.POSIXct(
          "2015-01-01"
        ),
        EndDateTime = as.POSIXct(
          "2015-01-01"
        ),
        IdleSinceDateTime = as.POSIXct(
          "2015-01-01"
        ),
        State = "CREATING"|"CREATED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"DEGRADED"|"FAILED",
        StateChangeReason = "string"
      )
    )
  )
)

Request syntax

svc$list_sessions(
  WorkGroup = "string",
  StateFilter = "CREATING"|"CREATED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"DEGRADED"|"FAILED",
  MaxResults = 123,
  NextToken = "string"
)