Skip to content

describe_notebook_instance_lifecycle_config

describe_notebook_instance_lifecycle_config(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    notebook_instance_lifecycle_config_name: Optional[
        NotebookInstanceLifecycleConfigName
    ] = None,
) -> DescribeNotebookInstanceLifecycleConfigOutput

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_notebook_instance_lifecycle_config(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    notebook_instance_lifecycle_config_name: Optional[
        "capo_sagemaker.types.notebook_instance_lifecycle_config_name.NotebookInstanceLifecycleConfigName"
    ] = None,
) -> "capo_sagemaker.types.describe_notebook_instance_lifecycle_config_output.DescribeNotebookInstanceLifecycleConfigOutput":
    """<p>Returns a description of a notebook instance lifecycle configuration.</p> <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>

    Args:
        notebook_instance_lifecycle_config_name: <p>The name of the lifecycle configuration to describe.</p>

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

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_notebook_instance_lifecycle_config_input.DescribeNotebookInstanceLifecycleConfigInput]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_notebook_instance_lifecycle_config_output.DescribeNotebookInstanceLifecycleConfigOutput"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_notebook_instance_lifecycle_config

        output, http_response = (
            capo_sagemaker._operations.sage_maker.describe_notebook_instance_lifecycle_config.describe_notebook_instance_lifecycle_config(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeNotebookInstanceLifecycleConfig"),
    )
    input_: capo_sagemaker.types.describe_notebook_instance_lifecycle_config_input.DescribeNotebookInstanceLifecycleConfigInput = {}
    if notebook_instance_lifecycle_config_name is not None:
        input_["notebook_instance_lifecycle_config_name"] = (
            notebook_instance_lifecycle_config_name
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output