Skip to content

ImportNotebookInput

Source code in docs_src/capo_athena/types/import_notebook_input.py
class ImportNotebookInput(TypedDict, closed=True):
    work_group: "capo_athena.types.work_group_name.WorkGroupName"
    """<p>The name of the Spark enabled workgroup to import the notebook to.</p>"""
    name: "capo_athena.types.notebook_name.NotebookName"
    """<p>The name of the notebook to import.</p>"""
    payload: NotRequired["capo_athena.types.payload.Payload"]
    """<p>The notebook content to be imported. The payload must be in <code>ipynb</code> format.</p>"""
    type: "capo_athena.types.notebook_type.NotebookType"
    """<p>The notebook content type. Currently, the only valid type is <code>IPYNB</code>.</p>"""
    notebook_s3_location_uri: NotRequired["capo_athena.types.s3_uri.S3Uri"]
    """<p>A URI that specifies the Amazon S3 location of a notebook file in <code>ipynb</code> format.</p>"""
    client_request_token: NotRequired[
        "capo_athena.types.client_request_token.ClientRequestToken"
    ]
    """<p>A unique case-sensitive string used to ensure the request to import 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 import 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.

name instance-attribute

The name of the notebook to import.

notebook_s3_location_uri instance-attribute

notebook_s3_location_uri: NotRequired[S3Uri]

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

payload instance-attribute

payload: NotRequired[Payload]

The notebook content to be imported. The payload must be in ipynb format.

type instance-attribute

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

work_group instance-attribute

work_group: WorkGroupName

The name of the Spark enabled workgroup to import the notebook to.