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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The description of the domain.

Synopsis

data DescribeDomain = DescribeDomain' {
- domainId :: Text
}
newDescribeDomain :: Text -> DescribeDomain
describeDomain_domainId :: Lens' DescribeDomain Text
data DescribeDomainResponse = DescribeDomainResponse' {
- creationTime :: Maybe POSIX
- status :: Maybe DomainStatus
- failureReason :: Maybe Text
- defaultUserSettings :: Maybe UserSettings
- subnetIds :: Maybe (NonEmpty Text)
- domainArn :: Maybe Text
- vpcId :: Maybe Text
- url :: Maybe Text
- authMode :: Maybe AuthMode
- homeEfsFileSystemKmsKeyId :: Maybe Text
- singleSignOnManagedApplicationInstanceId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- homeEfsFileSystemId :: Maybe Text
- kmsKeyId :: Maybe Text
- domainName :: Maybe Text
- domainId :: Maybe Text
- appNetworkAccessType :: Maybe AppNetworkAccessType
- httpStatus :: Int
}
newDescribeDomainResponse :: Int -> DescribeDomainResponse
describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus)
describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings)
describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text))
describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode)
describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType)
describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int

Creating a Request

data DescribeDomain Source #

See: newDescribeDomain smart constructor.

Constructors

DescribeDomain'
Fields domainId :: Text The domain ID.

Instances

Instances details

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

newDescribeDomain Source #

Arguments

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

Create a value of DescribeDomain 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:domainId:DescribeDomain', describeDomain_domainId - The domain ID.

Request Lenses

describeDomain_domainId :: Lens' DescribeDomain Text Source #

The domain ID.

Destructuring the Response

data DescribeDomainResponse Source #

See: newDescribeDomainResponse smart constructor.

Constructors

DescribeDomainResponse'

Fields

creationTime :: Maybe POSIX
The creation time.
status :: Maybe DomainStatus
The status.
failureReason :: Maybe Text
The failure reason.
defaultUserSettings :: Maybe UserSettings
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
subnetIds :: Maybe (NonEmpty Text)
The VPC subnets that Studio uses for communication.
domainArn :: Maybe Text
The domain's Amazon Resource Name (ARN).
vpcId :: Maybe Text
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
url :: Maybe Text
The domain's URL.
authMode :: Maybe AuthMode
The domain's authentication mode.
homeEfsFileSystemKmsKeyId :: Maybe Text
This member is deprecated and replaced with KmsKeyId.
singleSignOnManagedApplicationInstanceId :: Maybe Text
The SSO managed application instance ID.
lastModifiedTime :: Maybe POSIX
The last modified time.
homeEfsFileSystemId :: Maybe Text
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
domainName :: Maybe Text
The domain name.
domainId :: Maybe Text
The domain ID.
appNetworkAccessType :: Maybe AppNetworkAccessType
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
- PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
- VpcOnly - All Studio traffic is through the specified VPC and subnets
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods (==) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool # (/=) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool #
Read DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods readsPrec :: Int -> ReadS DescribeDomainResponse # readList :: ReadS [DescribeDomainResponse] # readPrec :: ReadPrec DescribeDomainResponse # readListPrec :: ReadPrec [DescribeDomainResponse] #
Show DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods showsPrec :: Int -> DescribeDomainResponse -> ShowS # show :: DescribeDomainResponse -> String # showList :: [DescribeDomainResponse] -> ShowS #
Generic DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Associated Types type Rep DescribeDomainResponse :: Type -> Type # Methods from :: DescribeDomainResponse -> Rep DescribeDomainResponse x # to :: Rep DescribeDomainResponse x -> DescribeDomainResponse #
NFData DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods rnf :: DescribeDomainResponse -> () #
type Rep DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain type Rep DescribeDomainResponse = D1 ('MetaData "DescribeDomainResponse" "Amazonka.SageMaker.DescribeDomain" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeDomainResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStatus))) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultUserSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSettings)))) :: ((S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "domainArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthMode)))))) :: (((S1 ('MetaSel ('Just "homeEfsFileSystemKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "singleSignOnManagedApplicationInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "homeEfsFileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "appNetworkAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppNetworkAccessType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDomainResponse'`
-> DescribeDomainResponse

Create a value of DescribeDomainResponse 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:creationTime:DescribeDomainResponse', describeDomainResponse_creationTime - The creation time.

$sel:status:DescribeDomainResponse', describeDomainResponse_status - The status.

$sel:failureReason:DescribeDomainResponse', describeDomainResponse_failureReason - The failure reason.

$sel:defaultUserSettings:DescribeDomainResponse', describeDomainResponse_defaultUserSettings - Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

$sel:subnetIds:DescribeDomainResponse', describeDomainResponse_subnetIds - The VPC subnets that Studio uses for communication.

$sel:domainArn:DescribeDomainResponse', describeDomainResponse_domainArn - The domain's Amazon Resource Name (ARN).

$sel:vpcId:DescribeDomainResponse', describeDomainResponse_vpcId - The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

$sel:url:DescribeDomainResponse', describeDomainResponse_url - The domain's URL.

$sel:authMode:DescribeDomainResponse', describeDomainResponse_authMode - The domain's authentication mode.

$sel:homeEfsFileSystemKmsKeyId:DescribeDomainResponse', describeDomainResponse_homeEfsFileSystemKmsKeyId - This member is deprecated and replaced with KmsKeyId.

$sel:singleSignOnManagedApplicationInstanceId:DescribeDomainResponse', describeDomainResponse_singleSignOnManagedApplicationInstanceId - The SSO managed application instance ID.

$sel:lastModifiedTime:DescribeDomainResponse', describeDomainResponse_lastModifiedTime - The last modified time.

$sel:homeEfsFileSystemId:DescribeDomainResponse', describeDomainResponse_homeEfsFileSystemId - The ID of the Amazon Elastic File System (EFS) managed by this Domain.

$sel:kmsKeyId:DescribeDomainResponse', describeDomainResponse_kmsKeyId - The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

$sel:domainName:DescribeDomainResponse', describeDomainResponse_domainName - The domain name.

$sel:domainId:DescribeDomain', describeDomainResponse_domainId - The domain ID.

$sel:appNetworkAccessType:DescribeDomainResponse', describeDomainResponse_appNetworkAccessType - Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets

$sel:httpStatus:DescribeDomainResponse', describeDomainResponse_httpStatus - The response's http status code.

Response Lenses

describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #

The creation time.

describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus) Source #

The status.

describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text) Source #

The failure reason.

describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings) Source #

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text)) Source #

The VPC subnets that Studio uses for communication.

describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain's Amazon Resource Name (ARN).

describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain's URL.

describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode) Source #

The domain's authentication mode.

describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #

This member is deprecated and replaced with KmsKeyId.

describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The SSO managed application instance ID.

describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #

The last modified time.

describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain name.

describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain ID.

describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType) Source #

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #

The response's http status code.