Athena / Client / update_notebook

update_notebook#

Athena.Client.update_notebook(**kwargs)#

Updates the contents of a Spark notebook.

See also: AWS API Documentation

Request Syntax

response = client.update_notebook(
    NotebookId='string',
    Payload='string',
    Type='IPYNB',
    SessionId='string',
    ClientRequestToken='string'
)
Parameters:

  • NotebookId (string) –

    [REQUIRED]

    The ID of the notebook to update.

  • Payload (string) –

    [REQUIRED]

    The updated content for the notebook.

  • Type (string) –

    [REQUIRED]

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

  • SessionId (string) – The active notebook session ID. Required if the notebook has an active session.

  • 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

{}

Response Structure

  • (dict) –

Exceptions

  • Athena.Client.exceptions.InternalServerException

  • Athena.Client.exceptions.InvalidRequestException

  • Athena.Client.exceptions.TooManyRequestsException