Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-space¶

Description¶

Describes the space.

Synopsis¶

  describe-space
--domain-id <value>
--space-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--domain-id (string)

The ID of the associated domain.

--space-name (string)

The name of the space.

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

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

DomainId -> (string)

The ID of the associated domain.

SpaceArn -> (string)

The space's Amazon Resource Name (ARN).

SpaceName -> (string)

The name of the space.

HomeEfsFileSystemUid -> (string)

The ID of the space's profile in the Amazon EFS volume.

Status -> (string)

The status.

LastModifiedTime -> (timestamp)

The last modified time.

CreationTime -> (timestamp)

The creation time.

FailureReason -> (string)

The failure reason.

SpaceSettings -> (structure)

A collection of space settings.

JupyterServerAppSettings -> (structure)

The JupyterServer app settings.

DefaultResourceSpec -> (structure)

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

SageMakerImageArn -> (string)

The ARN of the SageMaker AI image that the image version belongs to.

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

InstanceType -> (string)

The instance type that the image version runs on.

Note

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

LifecycleConfigArn -> (string)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

Note
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

CodeRepositories -> (list)

A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

(structure)

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

KernelGatewayAppSettings -> (structure)

The KernelGateway app settings.

DefaultResourceSpec -> (structure)

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

Note
The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

SageMakerImageArn -> (string)

The ARN of the SageMaker AI image that the image version belongs to.

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

InstanceType -> (string)

The instance type that the image version runs on.

Note

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

LifecycleConfigArn -> (string)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

CustomImages -> (list)

A list of custom SageMaker AI images that are configured to run as a KernelGateway app.

(structure)

A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image .

ImageName -> (string)

The name of the CustomImage. Must be unique to your account.

ImageVersionNumber -> (integer)

The version number of the CustomImage.

AppImageConfigName -> (string)

The name of the AppImageConfig.

LifecycleConfigArns -> (list)

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

Note
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

(string)

CodeEditorAppSettings -> (structure)

The Code Editor application settings.

DefaultResourceSpec -> (structure)

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

SageMakerImageArn -> (string)

The ARN of the SageMaker AI image that the image version belongs to.

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

InstanceType -> (string)

The instance type that the image version runs on.

Note

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

LifecycleConfigArn -> (string)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

AppLifecycleManagement -> (structure)

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

IdleSettings -> (structure)

Settings related to idle shutdown of Studio applications.

IdleTimeoutInMinutes -> (integer)

The time that SageMaker waits after the application becomes idle before shutting it down.

JupyterLabAppSettings -> (structure)

The settings for the JupyterLab application.

DefaultResourceSpec -> (structure)

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

SageMakerImageArn -> (string)

The ARN of the SageMaker AI image that the image version belongs to.

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

InstanceType -> (string)

The instance type that the image version runs on.

Note

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

LifecycleConfigArn -> (string)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

CodeRepositories -> (list)

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

(structure)

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

RepositoryUrl -> (string)

The URL of the Git repository.

AppLifecycleManagement -> (structure)

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

IdleSettings -> (structure)

Settings related to idle shutdown of Studio applications.

IdleTimeoutInMinutes -> (integer)

The time that SageMaker waits after the application becomes idle before shutting it down.

AppType -> (string)

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

SpaceStorageSettings -> (structure)

The storage settings for a space.

EbsStorageSettings -> (structure)

A collection of EBS storage settings for a space.

EbsVolumeSizeInGb -> (integer)

The size of an EBS storage volume for a space.

CustomFileSystems -> (list)

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

(tagged union structure)

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystem, FSxLustreFileSystem.

EFSFileSystem -> (structure)

A custom file system in Amazon EFS.

FileSystemId -> (string)

The ID of your Amazon EFS file system.

FSxLustreFileSystem -> (structure)

A custom file system in Amazon FSx for Lustre.

FileSystemId -> (string)

Amazon FSx for Lustre file system ID.

OwnershipSettings -> (structure)

The collection of ownership settings for a space.

OwnerUserProfileName -> (string)

The user profile who is the owner of the space.

SpaceSharingSettings -> (structure)

The collection of space sharing settings for a space.

SharingType -> (string)

Specifies the sharing type of the space.

SpaceDisplayName -> (string)

The name of the space that appears in the Amazon SageMaker Studio UI.

Url -> (string)

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

Studio Classic: &redirect=JupyterServer

JupyterLab: &redirect=JupyterLab

Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

Table Of Contents

Feedback

User Guide

Note:

describe-space¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note

Note