describe_notebook_instance `async` ¶

describe_notebook_instance(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    notebook_instance_name: Optional[NotebookInstanceName] = None,
) -> DescribeNotebookInstanceOutput

Returns information about a notebook instance.

Parameters:

notebook_instance_name (Optional[NotebookInstanceName], default: None ) –

The name of the notebook instance that you want information about.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py

async def describe_notebook_instance(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    notebook_instance_name: Optional[
        "capo_sagemaker.types.notebook_instance_name.NotebookInstanceName"
    ] = None,
) -> "capo_sagemaker.types.describe_notebook_instance_output.DescribeNotebookInstanceOutput":
    """<p>Returns information about a notebook instance.</p>

    Args:
        notebook_instance_name: <p>The name of the notebook instance that you want information about.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_notebook_instance_input.DescribeNotebookInstanceInput]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_notebook_instance_output.DescribeNotebookInstanceOutput"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_notebook_instance

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.describe_notebook_instance.async_describe_notebook_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNotebookInstance")
    )
    input_: capo_sagemaker.types.describe_notebook_instance_input.DescribeNotebookInstanceInput = {}
    if notebook_instance_name is not None:
        input_["notebook_instance_name"] = notebook_instance_name

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

describe_notebook_instance async ¶

describe_notebook_instance `async` ¶