Skip to content

update_notebook async

update_notebook(
    notebook_id: NotebookId,
    payload: Payload,
    type: NotebookType,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    session_id: Optional[SessionId] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> UpdateNotebookOutput

Updates the contents of a Spark notebook.

Parameters:

  • notebook_id (NotebookId) –

    The ID of the notebook to update.

  • payload (Payload) –

    The updated content for the notebook.

  • type (NotebookType) –

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

  • session_id (Optional[SessionId], default: None ) –

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

  • client_request_token (Optional[ClientRequestToken], default: None ) –

    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.

Raises:

Source code in docs_src/capo_athena/_services/async_athena.py
async def update_notebook(
    self,
    notebook_id: "capo_athena.types.notebook_id.NotebookId",
    payload: "capo_athena.types.payload.Payload",
    type: "capo_athena.types.notebook_type.NotebookType",
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    session_id: Optional["capo_athena.types.session_id.SessionId"] = None,
    client_request_token: Optional[
        "capo_athena.types.client_request_token.ClientRequestToken"
    ] = None,
) -> "capo_athena.types.update_notebook_output.UpdateNotebookOutput":
    """<p>Updates the contents of a Spark notebook.</p>

    Args:
        notebook_id: <p>The ID of the notebook to update.</p>
        payload: <p>The updated content for the notebook.</p>
        type: <p>The notebook content type. Currently, the only valid type is <code>IPYNB</code>.</p>
        session_id: <p>The active notebook session ID. Required if the notebook has an active session.</p>
        client_request_token: <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>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.too_many_requests_exception.TooManyRequestsException: <p>Indicates that the request was throttled.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_athena.types.update_notebook_input.UpdateNotebookInput]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.update_notebook_output.UpdateNotebookOutput"
    ]:
        import capo_athena._operations.amazon_athena.update_notebook

        (
            output,
            http_response,
        ) = await capo_athena._operations.amazon_athena.update_notebook.async_update_notebook(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateNotebook")
    )
    input_: capo_athena.types.update_notebook_input.UpdateNotebookInput = {
        "notebook_id": notebook_id,
        "payload": payload,
        "type": type,
    }
    if session_id is not None:
        input_["session_id"] = session_id
    if client_request_token is not None:
        input_["client_request_token"] = client_request_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output