Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

describe-domain

Description

The desciption of the domain.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-domain
--domain-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-id (string)

The domain ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DomainArn -> (string)

The domain's Amazon Resource Name (ARN).

DomainId -> (string)

The domain ID.

DomainName -> (string)

The domain name.

HomeEfsFileSystemId -> (string)

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

SingleSignOnManagedApplicationInstanceId -> (string)

The SSO managed application instance ID.

Status -> (string)

The status.

CreationTime -> (timestamp)

The creation time.

LastModifiedTime -> (timestamp)

The last modified time.

FailureReason -> (string)

The failure reason.

AuthMode -> (string)

The domain's authentication mode.

DefaultUserSettings -> (structure)

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

ExecutionRole -> (string)

The execution role for the user.

SecurityGroups -> (list)

The security groups.

(string)

SharingSettings -> (structure)

The sharing settings.

NotebookOutputOption -> (string)

The notebook output option.

S3OutputPath -> (string)

The Amazon S3 output path.

S3KmsKeyId -> (string)

The AWS Key Management Service encryption key ID.

JupyterServerAppSettings -> (structure)

The Jupyter server's app settings.

DefaultResourceSpec -> (structure)

The instance type and quantity.

EnvironmentArn -> (string)

The Amazon Resource Name (ARN) of the environment.

InstanceType -> (string)

The instance type.

KernelGatewayAppSettings -> (structure)

The kernel gateway app settings.

DefaultResourceSpec -> (structure)

The instance type and quantity.

EnvironmentArn -> (string)

The Amazon Resource Name (ARN) of the environment.

InstanceType -> (string)

The instance type.

TensorBoardAppSettings -> (structure)

The TensorBoard app settings.

DefaultResourceSpec -> (structure)

The instance type and quantity.

EnvironmentArn -> (string)

The Amazon Resource Name (ARN) of the environment.

InstanceType -> (string)

The instance type.

HomeEfsFileSystemKmsKeyId -> (string)

The AWS Key Management Service encryption key ID.

SubnetIds -> (list)

Security setting to limit to a set of subnets.

(string)

Url -> (string)

The domain's URL.

VpcId -> (string)

The ID of the Amazon Virtual Private Cloud.