Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.DeleteDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

Synopsis

Creating a Request

data DeleteDomain Source #

See: newDeleteDomain smart constructor.

Constructors

DeleteDomain'
Fields retentionPolicy :: Maybe RetentionPolicy 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). domainId :: Text The domain ID.

Instances

Instances details

Eq DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods (==) :: DeleteDomain -> DeleteDomain -> Bool # (/=) :: DeleteDomain -> DeleteDomain -> Bool #
Read DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods readsPrec :: Int -> ReadS DeleteDomain # readList :: ReadS [DeleteDomain] # readPrec :: ReadPrec DeleteDomain # readListPrec :: ReadPrec [DeleteDomain] #
Show DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods showsPrec :: Int -> DeleteDomain -> ShowS # show :: DeleteDomain -> String # showList :: [DeleteDomain] -> ShowS #
Generic DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Associated Types type Rep DeleteDomain :: Type -> Type # Methods from :: DeleteDomain -> Rep DeleteDomain x # to :: Rep DeleteDomain x -> DeleteDomain #
NFData DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods rnf :: DeleteDomain -> () #
Hashable DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods hashWithSalt :: Int -> DeleteDomain -> Int # hash :: DeleteDomain -> Int #
ToJSON DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods toJSON :: DeleteDomain -> Value # toEncoding :: DeleteDomain -> Encoding # toJSONList :: [DeleteDomain] -> Value # toEncodingList :: [DeleteDomain] -> Encoding #
AWSRequest DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Associated Types type AWSResponse DeleteDomain # Methods request :: DeleteDomain -> Request DeleteDomain # response :: MonadResource m => Logger -> Service -> Proxy DeleteDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDomain))) #
ToHeaders DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods toHeaders :: DeleteDomain -> [Header] #
ToPath DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods toPath :: DeleteDomain -> ByteString #
ToQuery DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods toQuery :: DeleteDomain -> QueryString #
type Rep DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain type Rep DeleteDomain = D1 ('MetaData "DeleteDomain" "Amazonka.SageMaker.DeleteDomain" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DeleteDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "retentionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPolicy)) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteDomain Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain type AWSResponse DeleteDomain = DeleteDomainResponse

newDeleteDomain Source #

Arguments

:: Text	`$sel:domainId:DeleteDomain'`
-> DeleteDomain

Create a value of DeleteDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:retentionPolicy:DeleteDomain', deleteDomain_retentionPolicy - 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).

$sel:domainId:DeleteDomain', deleteDomain_domainId - The domain ID.

Request Lenses

deleteDomain_retentionPolicy :: Lens' DeleteDomain (Maybe RetentionPolicy) Source #

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).

deleteDomain_domainId :: Lens' DeleteDomain Text Source #

The domain ID.

Destructuring the Response

data DeleteDomainResponse Source #

See: newDeleteDomainResponse smart constructor.

Constructors

DeleteDomainResponse'

Instances

Instances details

Eq DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods (==) :: DeleteDomainResponse -> DeleteDomainResponse -> Bool # (/=) :: DeleteDomainResponse -> DeleteDomainResponse -> Bool #
Read DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods readsPrec :: Int -> ReadS DeleteDomainResponse # readList :: ReadS [DeleteDomainResponse] # readPrec :: ReadPrec DeleteDomainResponse # readListPrec :: ReadPrec [DeleteDomainResponse] #
Show DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods showsPrec :: Int -> DeleteDomainResponse -> ShowS # show :: DeleteDomainResponse -> String # showList :: [DeleteDomainResponse] -> ShowS #
Generic DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Associated Types type Rep DeleteDomainResponse :: Type -> Type # Methods from :: DeleteDomainResponse -> Rep DeleteDomainResponse x # to :: Rep DeleteDomainResponse x -> DeleteDomainResponse #
NFData DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain Methods rnf :: DeleteDomainResponse -> () #
type Rep DeleteDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DeleteDomain type Rep DeleteDomainResponse = D1 ('MetaData "DeleteDomainResponse" "Amazonka.SageMaker.DeleteDomain" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DeleteDomainResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDomainResponse :: DeleteDomainResponse Source #

Create a value of DeleteDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.