DescribeDomain - Amazon SageMaker Service

DescribeDomain

The description of the domain.

Request Syntax

{ "DomainId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Required: Yes

Response Syntax

{ "AuthMode": "string", "CreationTime": number, "DefaultUserSettings": { "ExecutionRole": "string", "JupyterServerAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "SageMakerImageArn": "string" } }, "KernelGatewayAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "SageMakerImageArn": "string" } }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "SageMakerImageArn": "string" } } }, "DomainArn": "string", "DomainId": "string", "DomainName": "string", "FailureReason": "string", "HomeEfsFileSystemId": "string", "HomeEfsFileSystemKmsKeyId": "string", "LastModifiedTime": number, "SingleSignOnManagedApplicationInstanceId": "string", "Status": "string", "SubnetIds": [ "string" ], "Url": "string", "VpcId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuthMode

The domain's authentication mode.

Type: String

Valid Values: SSO | IAM

CreationTime

The creation time.

Type: Timestamp

DefaultUserSettings

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

Type: UserSettings object

DomainArn

The domain's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:domain/.*

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

DomainName

The domain name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

FailureReason

The failure reason.

Type: String

Length Constraints: Maximum length of 1024.

HomeEfsFileSystemId

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

Type: String

Length Constraints: Maximum length of 32.

HomeEfsFileSystemKmsKeyId

The AWS Key Management Service encryption key ID.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

LastModifiedTime

The last modified time.

Type: Timestamp

SingleSignOnManagedApplicationInstanceId

The SSO managed application instance ID.

Type: String

Length Constraints: Maximum length of 256.

Status

The status.

Type: String

Valid Values: Deleting | Failed | InService | Pending

SubnetIds

Security setting to limit to a set of subnets.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 16 items.

Length Constraints: Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

Url

The domain's URL.

Type: String

Length Constraints: Maximum length of 1024.

VpcId

The ID of the Amazon Virtual Private Cloud.

Type: String

Length Constraints: Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: