Skip to content

List Notebook Metadata

athena_list_notebook_metadata R Documentation

Displays the notebook files for the specified workgroup in paginated format

Description

Displays the notebook files for the specified workgroup in paginated format.

Usage

athena_list_notebook_metadata(Filters, NextToken, MaxResults, WorkGroup)

Arguments

Filters

Search filter string.

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

MaxResults

Specifies the maximum number of results to return.

WorkGroup

[required] The name of the Spark enabled workgroup to retrieve notebook metadata for.

Value

A list with the following syntax:

list(
  NextToken = "string",
  NotebookMetadataList = list(
    list(
      NotebookId = "string",
      Name = "string",
      WorkGroup = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      Type = "IPYNB",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_notebook_metadata(
  Filters = list(
    Name = "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  WorkGroup = "string"
)