Athena / Client / get_notebook_metadata

get_notebook_metadata#

Athena.Client.get_notebook_metadata(**kwargs)#

Retrieves notebook metadata for the specified notebook ID.

See also: AWS API Documentation

Request Syntax

response = client.get_notebook_metadata(
    NotebookId='string'
)
Parameters:

NotebookId (string) –

[REQUIRED]

The ID of the notebook whose metadata is to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'NotebookMetadata': {
        'NotebookId': 'string',
        'Name': 'string',
        'WorkGroup': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'Type': 'IPYNB',
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • NotebookMetadata (dict) –

      The metadata that is returned for the specified notebook ID.

      • 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