Athena / Client / create_notebook

create_notebook#

Athena.Client.create_notebook(**kwargs)#

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

See also: AWS API Documentation

Request Syntax

response = client.create_notebook(
    WorkGroup='string',
    Name='string',
    ClientRequestToken='string'
)
Parameters:

  • WorkGroup (string) –

    [REQUIRED]

    The name of the Spark enabled workgroup in which the notebook will be created.

  • Name (string) –

    [REQUIRED]

    The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

  • ClientRequestToken (string) –

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

    Warning

    This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Return type:

dict

Returns:

Response Syntax

{
    'NotebookId': 'string'
}

Response Structure

  • (dict) –

    • NotebookId (string) –

      A unique identifier for the notebook.

Exceptions

  • Athena.Client.exceptions.InternalServerException

  • Athena.Client.exceptions.InvalidRequestException

  • Athena.Client.exceptions.TooManyRequestsException