Skip to content

UpdateNotebookInput

Source code in docs_src/capo_athena/types/update_notebook_input.py
class UpdateNotebookInput(TypedDict, closed=True):
    notebook_id: "capo_athena.types.notebook_id.NotebookId"
    """<p>The ID of the notebook to update.</p>"""
    payload: "capo_athena.types.payload.Payload"
    """<p>The updated content for the notebook.</p>"""
    type: "capo_athena.types.notebook_type.NotebookType"
    """<p>The notebook content type. Currently, the only valid type is <code>IPYNB</code>.</p>"""
    session_id: NotRequired["capo_athena.types.session_id.SessionId"]
    """<p>The active notebook session ID. Required if the notebook has an active session.</p>"""
    client_request_token: NotRequired[
        "capo_athena.types.client_request_token.ClientRequestToken"
    ]
    """<p>A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).</p> <important> <p>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.</p> </important>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

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

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.

notebook_id instance-attribute

notebook_id: NotebookId

The ID of the notebook to update.

payload instance-attribute

payload: Payload

The updated content for the notebook.

session_id instance-attribute

session_id: NotRequired[SessionId]

The active notebook session ID. Required if the notebook has an active session.

type instance-attribute

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