Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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' {
- appNetworkAccessType :: Maybe AppNetworkAccessType
- appSecurityGroupManagement :: Maybe AppSecurityGroupManagement
- authMode :: Maybe AuthMode
- creationTime :: Maybe POSIX
- defaultSpaceSettings :: Maybe DefaultSpaceSettings
- defaultUserSettings :: Maybe UserSettings
- domainArn :: Maybe Text
- domainId :: Maybe Text
- domainName :: Maybe Text
- domainSettings :: Maybe DomainSettings
- failureReason :: Maybe Text
- homeEfsFileSystemId :: Maybe Text
- homeEfsFileSystemKmsKeyId :: Maybe Text
- kmsKeyId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- securityGroupIdForDomainBoundary :: Maybe Text
- singleSignOnManagedApplicationInstanceId :: Maybe Text
- status :: Maybe DomainStatus
- subnetIds :: Maybe (NonEmpty Text)
- url :: Maybe Text
- vpcId :: Maybe Text
- httpStatus :: Int
}
newDescribeDomainResponse :: Int -> DescribeDomainResponse
describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType)
describeDomainResponse_appSecurityGroupManagement :: Lens' DescribeDomainResponse (Maybe AppSecurityGroupManagement)
describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode)
describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings)
describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings)
describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_domainSettings :: Lens' DescribeDomainResponse (Maybe DomainSettings)
describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
describeDomainResponse_securityGroupIdForDomainBoundary :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus)
describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text))
describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text)
describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text)
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

ToJSON DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods toJSON :: DescribeDomain -> Value # toEncoding :: DescribeDomain -> Encoding # toJSONList :: [DescribeDomain] -> Value # toEncodingList :: [DescribeDomain] -> Encoding #
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 #
AWSRequest DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Associated Types type AWSResponse DescribeDomain # Methods request :: (Service -> Service) -> DescribeDomain -> Request DescribeDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDomain))) #
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 #
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 #
NFData DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods rnf :: DescribeDomain -> () #
Eq DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods (==) :: DescribeDomain -> DescribeDomain -> Bool # (/=) :: DescribeDomain -> DescribeDomain -> Bool #
Hashable DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods hashWithSalt :: Int -> DescribeDomain -> Int # hash :: DescribeDomain -> Int #
type AWSResponse DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain type AWSResponse DescribeDomain = DescribeDomainResponse
type Rep DescribeDomain Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain type Rep DescribeDomain = D1 ('MetaData "DescribeDomain" "Amazonka.SageMaker.DescribeDomain" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDomain Source #

Arguments

:: Text	`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:

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

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
appSecurityGroupManagement :: Maybe AppSecurityGroupManagement
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
authMode :: Maybe AuthMode
The domain's authentication mode.
creationTime :: Maybe POSIX
The creation time.
defaultSpaceSettings :: Maybe DefaultSpaceSettings
The default settings used to create a space.
defaultUserSettings :: Maybe UserSettings
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
domainArn :: Maybe Text
The domain's Amazon Resource Name (ARN).
domainId :: Maybe Text
The domain ID.
domainName :: Maybe Text
The domain name.
domainSettings :: Maybe DomainSettings
A collection of Domain settings.
failureReason :: Maybe Text
The failure reason.
homeEfsFileSystemId :: Maybe Text
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
homeEfsFileSystemKmsKeyId :: Maybe Text
Use KmsKeyId.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
lastModifiedTime :: Maybe POSIX
The last modified time.
securityGroupIdForDomainBoundary :: Maybe Text
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
singleSignOnManagedApplicationInstanceId :: Maybe Text
The IAM Identity Center managed application instance ID.
status :: Maybe DomainStatus
The status.
subnetIds :: Maybe (NonEmpty Text)
The VPC subnets that Studio uses for communication.
url :: Maybe Text
The domain's URL.
vpcId :: Maybe Text
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods rnf :: DescribeDomainResponse -> () #
Eq DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain Methods (==) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool # (/=) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool #
type Rep DescribeDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeDomain type Rep DescribeDomainResponse = D1 ('MetaData "DescribeDomainResponse" "Amazonka.SageMaker.DescribeDomain" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeDomainResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "appNetworkAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppNetworkAccessType)) :: S1 ('MetaSel ('Just "appSecurityGroupManagement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppSecurityGroupManagement))) :: (S1 ('MetaSel ('Just "authMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthMode)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "defaultSpaceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultSpaceSettings))))) :: ((S1 ('MetaSel ('Just "defaultUserSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSettings)) :: (S1 ('MetaSel ('Just "domainArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domainSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainSettings)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "homeEfsFileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "homeEfsFileSystemKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "securityGroupIdForDomainBoundary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "singleSignOnManagedApplicationInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStatus)) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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: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:appSecurityGroupManagement:DescribeDomainResponse', describeDomainResponse_appSecurityGroupManagement - The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

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

DescribeDomainResponse, describeDomainResponse_creationTime - The creation time.

$sel:defaultSpaceSettings:DescribeDomainResponse', describeDomainResponse_defaultSpaceSettings - The default settings used to create a space.

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

DescribeDomainResponse, describeDomainResponse_domainArn - The domain's Amazon Resource Name (ARN).

DescribeDomain, describeDomainResponse_domainId - The domain ID.

DescribeDomainResponse, describeDomainResponse_domainName - The domain name.

$sel:domainSettings:DescribeDomainResponse', describeDomainResponse_domainSettings - A collection of Domain settings.

DescribeDomainResponse, describeDomainResponse_failureReason - The failure reason.

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

$sel:homeEfsFileSystemKmsKeyId:DescribeDomainResponse', describeDomainResponse_homeEfsFileSystemKmsKeyId - Use KmsKeyId.

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

DescribeDomainResponse, describeDomainResponse_lastModifiedTime - The last modified time.

$sel:securityGroupIdForDomainBoundary:DescribeDomainResponse', describeDomainResponse_securityGroupIdForDomainBoundary - The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

$sel:singleSignOnManagedApplicationInstanceId:DescribeDomainResponse', describeDomainResponse_singleSignOnManagedApplicationInstanceId - The IAM Identity Center managed application instance ID.

DescribeDomainResponse, describeDomainResponse_status - The status.

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

DescribeDomainResponse, describeDomainResponse_url - The domain's URL.

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

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

Response Lenses

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_appSecurityGroupManagement :: Lens' DescribeDomainResponse (Maybe AppSecurityGroupManagement) Source #

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

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

The domain's authentication mode.

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

The creation time.

describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings) Source #

The default settings used to create a space.

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_domainArn :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain's Amazon Resource Name (ARN).

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

The domain ID.