Skip to content

List Notebook Sessions

athena_list_notebook_sessions R Documentation

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY

Description

Lists, in descending order, the sessions that have been created in a notebook 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_notebook_sessions(NotebookId, MaxResults, NextToken)

Arguments

NotebookId

[required] The ID of the notebook to list sessions for.

MaxResults

The maximum number of notebook 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(
  NotebookSessionsList = list(
    list(
      SessionId = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_notebook_sessions(
  NotebookId = "string",
  MaxResults = 123,
  NextToken = "string"
)