Skip to content

delete_app

delete_app(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    domain_id: Optional[DomainId] = None,
    user_profile_name: Optional[UserProfileName] = None,
    space_name: Optional[SpaceName] = None,
    app_type: Optional[AppType] = None,
    app_name: Optional[AppName] = None,
) -> None

Used to stop and delete an app.

Parameters:

  • domain_id (Optional[DomainId], default: None ) –

    The domain ID.

  • user_profile_name (Optional[UserProfileName], default: None ) –

    The user profile name. If this value is not set, then SpaceName must be set.

  • space_name (Optional[SpaceName], default: None ) –

    The name of the space. If this value is not set, then UserProfileName must be set.

  • app_type (Optional[AppType], default: None ) –

    The type of app.

  • app_name (Optional[AppName], default: None ) –

    The name of the app.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def delete_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,
) -> None:
    """<p>Used to stop and delete an 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. If this value is not set, then <code>UserProfileName</code> must be set.</p>
        app_type: <p>The type of app.</p>
        app_name: <p>The name of the app.</p>

    Raises:
        capo_sagemaker.errors.resource_in_use.ResourceInUse: <p>Resource being accessed is in use.</p>
        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.delete_app_request.DeleteAppRequest]",
    ) -> OperationResponse[None]:
        import capo_sagemaker._operations.sage_maker.delete_app

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApp")
    )
    input_: capo_sagemaker.types.delete_app_request.DeleteAppRequest = {}
    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