Skip to content

update_notebook_metadata async

update_notebook_metadata(
    notebook_id: NotebookId,
    name: NotebookName,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> UpdateNotebookMetadataOutput

Updates the metadata for a notebook.

Parameters:

  • notebook_id (NotebookId) –

    The ID of the notebook to update the metadata for.

  • 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.

  • name (NotebookName) –

    The name to update the notebook to.

Raises:

Source code in docs_src/capo_athena/_services/async_athena.py
async def update_notebook_metadata(
    self,
    notebook_id: "capo_athena.types.notebook_id.NotebookId",
    name: "capo_athena.types.notebook_name.NotebookName",
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    client_request_token: Optional[
        "capo_athena.types.client_request_token.ClientRequestToken"
    ] = None,
) -> (
    "capo_athena.types.update_notebook_metadata_output.UpdateNotebookMetadataOutput"
):
    """<p>Updates the metadata for a notebook.</p>

    Args:
        notebook_id: <p>The ID of the notebook to update the metadata for.</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>
        name: <p>The name to update the notebook to.</p>

    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_metadata_input.UpdateNotebookMetadataInput]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.update_notebook_metadata_output.UpdateNotebookMetadataOutput"
    ]:
        import capo_athena._operations.amazon_athena.update_notebook_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateNotebookMetadata")
    )
    input_: capo_athena.types.update_notebook_metadata_input.UpdateNotebookMetadataInput = {
        "notebook_id": notebook_id,
        "name": name,
    }
    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