describe_app ¶

def describe_app(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    domain_id: Optional["capo_sagemaker.types.domain_id.DomainId"] = None,
    user_profile_name: Optional[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ] = None,
    space_name: Optional["capo_sagemaker.types.space_name.SpaceName"] = None,
    app_type: Optional["capo_sagemaker.types.app_type.AppType"] = None,
    app_name: Optional["capo_sagemaker.types.app_name.AppName"] = None,
) -> "capo_sagemaker.types.describe_app_response.DescribeAppResponse":
    """<p>Describes the app.</p>

    Args:
        domain_id: <p>The domain ID.</p>
        user_profile_name: <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
        space_name: <p>The name of the space.</p>
        app_type: <p>The type of app.</p>
        app_name: <p>The name of the app.</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_app_request.DescribeAppRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_app_response.DescribeAppResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_app

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApp")
    )
    input_: capo_sagemaker.types.describe_app_request.DescribeAppRequest = {}
    if domain_id is not None:
        input_["domain_id"] = domain_id
    if user_profile_name is not None:
        input_["user_profile_name"] = user_profile_name
    if space_name is not None:
        input_["space_name"] = space_name
    if app_type is not None:
        input_["app_type"] = app_type
    if app_name is not None:
        input_["app_name"] = app_name

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