SageMaker / Client / delete_domain

delete_domain#

SageMaker.Client.delete_domain(**kwargs)#

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    DomainId='string',
    RetentionPolicy={
        'HomeEfsFileSystem': 'Retain'|'Delete'
    }
)
Parameters:

  • DomainId (string) –

    [REQUIRED]

    The domain ID.

  • RetentionPolicy (dict) –

    The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

    • HomeEfsFileSystem (string) –

      The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.

      Specify Delete to delete the data stored on the Amazon EFS volume.

Returns:

None

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse

  • SageMaker.Client.exceptions.ResourceNotFound