Skip to content

describe_domain

describe_domain(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    domain_id: Optional[DomainId] = None,
) -> DescribeDomainResponse

The description of the domain.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_domain(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    domain_id: Optional["capo_sagemaker.types.domain_id.DomainId"] = None,
) -> "capo_sagemaker.types.describe_domain_response.DescribeDomainResponse":
    """<p>The description of the domain.</p>

    Args:
        domain_id: <p>The domain ID.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_domain_request.DescribeDomainRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_domain_response.DescribeDomainResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_domain

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDomain")
    )
    input_: capo_sagemaker.types.describe_domain_request.DescribeDomainRequest = {}
    if domain_id is not None:
        input_["domain_id"] = domain_id

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