Amazonka.SageMaker.DescribeDomain

The description of the domain.

Creating a Request

data DescribeDomain

See: newDescribeDomain smart constructor.

Constructors

DescribeDomain'

Fields

• domainId :: Text

  The domain ID.

Instances

ToJSON DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

toJSON :: DescribeDomain -> Value

toEncoding :: DescribeDomain -> Encoding

toJSONList :: [DescribeDomain] -> Value

toEncodingList :: [DescribeDomain] -> Encoding

ToHeaders DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

toHeaders :: DescribeDomain -> [Header]

ToPath DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

toPath :: DescribeDomain -> ByteString

ToQuery DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

toQuery :: DescribeDomain -> QueryString

AWSRequest DescribeDomain

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

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

Defined in Amazonka.SageMaker.DescribeDomain

Methods

readsPrec :: Int -> ReadS DescribeDomain

readList :: ReadS [DescribeDomain]

readPrec :: ReadPrec DescribeDomain

readListPrec :: ReadPrec [DescribeDomain]

Show DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

showsPrec :: Int -> DescribeDomain -> ShowS

show :: DescribeDomain -> String

showList :: [DescribeDomain] -> ShowS

NFData DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

rnf :: DescribeDomain -> ()

Eq DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

(==) :: DescribeDomain -> DescribeDomain -> Bool

(/=) :: DescribeDomain -> DescribeDomain -> Bool

Hashable DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

Methods

hashWithSalt :: Int -> DescribeDomain -> Int

hash :: DescribeDomain -> Int

type AWSResponse DescribeDomain

Defined in Amazonka.SageMaker.DescribeDomain

type AWSResponse DescribeDomain = DescribeDomainResponse

type Rep DescribeDomain

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

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

The domain ID.

Destructuring the Response

data DescribeDomainResponse

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

Generic DescribeDomainResponse

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

Defined in Amazonka.SageMaker.DescribeDomain

Methods

readsPrec :: Int -> ReadS DescribeDomainResponse

readList :: ReadS [DescribeDomainResponse]

readPrec :: ReadPrec DescribeDomainResponse

readListPrec :: ReadPrec [DescribeDomainResponse]

Show DescribeDomainResponse

Defined in Amazonka.SageMaker.DescribeDomain

Methods

showsPrec :: Int -> DescribeDomainResponse -> ShowS

show :: DescribeDomainResponse -> String

showList :: [DescribeDomainResponse] -> ShowS

NFData DescribeDomainResponse

Defined in Amazonka.SageMaker.DescribeDomain

Methods

rnf :: DescribeDomainResponse -> ()

Eq DescribeDomainResponse

Defined in Amazonka.SageMaker.DescribeDomain

Methods

(==) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool

(/=) :: DescribeDomainResponse -> DescribeDomainResponse -> Bool

type Rep DescribeDomainResponse

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

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)

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)

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)

The domain's authentication mode.

describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime)

The creation time.

describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings)

The default settings used to create a space.

describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings)

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)

The domain's Amazon Resource Name (ARN).

describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text)

The domain ID.

describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text)

The domain name.

describeDomainResponse_domainSettings :: Lens' DescribeDomainResponse (Maybe DomainSettings)

A collection of Domain settings.

describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text)

The failure reason.

describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text)

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

describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)

Use KmsKeyId.

describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)

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

describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime)

The last modified time.

describeDomainResponse_securityGroupIdForDomainBoundary :: Lens' DescribeDomainResponse (Maybe Text)

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text)

The IAM Identity Center managed application instance ID.

describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus)

The status.

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

The VPC subnets that Studio uses for communication.

describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text)

The domain's URL.

describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text)

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

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int

The response's http status code.