Athena / Client / list_notebook_metadata

list_notebook_metadata#

Athena.Client.list_notebook_metadata(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_notebook_metadata(
    Filters={
        'Name': 'string'
    },
    NextToken='string',
    MaxResults=123,
    WorkGroup='string'
)
Parameters:

  • Filters (dict) –

    Search filter string.

    • Name (string) –

      The name of the notebook to search for.

  • NextToken (string) – A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

  • MaxResults (integer) – Specifies the maximum number of results to return.

  • WorkGroup (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'NotebookMetadataList': [
        {
            'NotebookId': 'string',
            'Name': 'string',
            'WorkGroup': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Type': 'IPYNB',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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.

    • NotebookMetadataList (list) –

      The list of notebook metadata for the specified workgroup.

      • (dict) –

        Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

        • NotebookId (string) –

          The notebook ID.

        • Name (string) –

          The name of the notebook.

        • WorkGroup (string) –

          The name of the Spark enabled workgroup to which the notebook belongs.

        • CreationTime (datetime) –

          The time when the notebook was created.

        • Type (string) –

          The type of notebook. Currently, the only valid type is IPYNB.

        • LastModifiedTime (datetime) –

          The time when the notebook was last modified.

Exceptions