Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
Parameters:
Raises:
Source code in docs_src/capo_sagemaker/_services/sage_maker.py
| def delete_user_profile(
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,
) -> None:
"""<p>Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.</p>
Args:
domain_id: <p>The domain ID.</p>
user_profile_name: <p>The user profile name.</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_user_profile_request.DeleteUserProfileRequest]",
) -> OperationResponse[None]:
import capo_sagemaker._operations.sage_maker.delete_user_profile
output, http_response = (
capo_sagemaker._operations.sage_maker.delete_user_profile.delete_user_profile(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteUserProfile")
)
input_: capo_sagemaker.types.delete_user_profile_request.DeleteUserProfileRequest = {}
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
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|