Amazon SageMaker Service

2023/11/30 - Amazon SageMaker Service - 21 updated api methods

Changes  This release adds support for 1/ Code Editor, based on Code-OSS, Visual Studio Code Open Source, a new fully managed IDE option in SageMaker Studio 2/ JupyterLab, a new fully managed JupyterLab IDE experience in SageMaker Studio

CreateApp (updated) Link ¶
Changes (request)
{'AppType': {'JupyterLab', 'CodeEditor'}}

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

See also: AWS API Documentation

Request Syntax

client.create_app(
    DomainId='string',
    UserProfileName='string',
    AppType='JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
    AppName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ResourceSpec={
        'SageMakerImageArn': 'string',
        'SageMakerImageVersionArn': 'string',
        'SageMakerImageVersionAlias': 'string',
        'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
        'LifecycleConfigArn': 'string'
    },
    SpaceName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

The user profile name. If this value is not set, then SpaceName must be set.

type AppType

string

param AppType

[REQUIRED]

The type of app.

type AppName

string

param AppName

[REQUIRED]

The name of the app.

type Tags

list

param Tags

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type ResourceSpec

dict

param ResourceSpec

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

Note

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

  • SageMakerImageArn (string) --

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

  • SageMakerImageVersionArn (string) --

    The ARN of the image version created on the instance.

  • SageMakerImageVersionAlias (string) --

    The SageMakerImageVersionAlias.

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

type SpaceName

string

param SpaceName

The name of the space. If this value is not set, then UserProfileName must be set.

rtype

dict

returns

Response Syntax

{
    'AppArn': 'string'
}

Response Structure

  • (dict) --

    • AppArn (string) --

      The Amazon Resource Name (ARN) of the app.

CreateAppImageConfig (updated) Link ¶
Changes (request)
{'JupyterLabAppImageConfig': {'ContainerConfig': {'ContainerArguments': ['string'],
                                                  'ContainerEntrypoint': ['string'],
                                                  'ContainerEnvironmentVariables': {'string': 'string'}}}}

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

See also: AWS API Documentation

Request Syntax

client.create_app_image_config(
    AppImageConfigName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KernelGatewayImageConfig={
        'KernelSpecs': [
            {
                'Name': 'string',
                'DisplayName': 'string'
            },
        ],
        'FileSystemConfig': {
            'MountPath': 'string',
            'DefaultUid': 123,
            'DefaultGid': 123
        }
    },
    JupyterLabAppImageConfig={
        'ContainerConfig': {
            'ContainerArguments': [
                'string',
            ],
            'ContainerEntrypoint': [
                'string',
            ],
            'ContainerEnvironmentVariables': {
                'string': 'string'
            }
        }
    }
)
type AppImageConfigName

string

param AppImageConfigName

[REQUIRED]

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

type Tags

list

param Tags

A list of tags to apply to the AppImageConfig.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type KernelGatewayImageConfig

dict

param KernelGatewayImageConfig

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

  • KernelSpecs (list) -- [REQUIRED]

    The specification of the Jupyter kernels in the image.

    • (dict) --

      The specification of a Jupyter kernel.

      • Name (string) -- [REQUIRED]

        The name of the Jupyter kernel in the image. This value is case sensitive.

      • DisplayName (string) --

        The display name of the kernel.

  • FileSystemConfig (dict) --

    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

    • MountPath (string) --

      The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .

    • DefaultUid (integer) --

      The default POSIX user ID (UID). If not specified, defaults to 1000 .

    • DefaultGid (integer) --

      The default POSIX group ID (GID). If not specified, defaults to 100 .

type JupyterLabAppImageConfig

dict

param JupyterLabAppImageConfig

The JupyterLabAppImageConfig . You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

  • ContainerConfig (dict) --

    The configuration used to run the application image container.

    • ContainerArguments (list) --

      The arguments for the container when you're running the application.

      • (string) --

    • ContainerEntrypoint (list) --

      The entrypoint used to run the application in the container.

      • (string) --

    • ContainerEnvironmentVariables (dict) --

      The environment variables to set in the container

      • (string) --

        • (string) --

rtype

dict

returns

Response Syntax

{
    'AppImageConfigArn': 'string'
}

Response Structure

  • (dict) --

    • AppImageConfigArn (string) --

      The Amazon Resource Name (ARN) of the AppImageConfig.

CreateDomain (updated) Link ¶
Changes (request)
{'DefaultUserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                              'FileSystemPath': 'string'}}],
                         'CustomPosixUserConfig': {'Gid': 'long',
                                                   'Uid': 'long'},
                         'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                                   'CustomImages': [{'AppImageConfigName': 'string',
                                                                     'ImageName': 'string',
                                                                     'ImageVersionNumber': 'integer'}],
                                                   'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                                'MaximumEbsVolumeSizeInGb': 'integer'}}}}

Creates a Domain . A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

Warning

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

See also: AWS API Documentation

Request Syntax

client.create_domain(
    DomainName='string',
    AuthMode='SSO'|'IAM',
    DefaultUserSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    },
    SubnetIds=[
        'string',
    ],
    VpcId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AppNetworkAccessType='PublicInternetOnly'|'VpcOnly',
    HomeEfsFileSystemKmsKeyId='string',
    KmsKeyId='string',
    AppSecurityGroupManagement='Service'|'Customer',
    DomainSettings={
        'SecurityGroupIds': [
            'string',
        ],
        'RStudioServerProDomainSettings': {
            'DomainExecutionRoleArn': 'string',
            'RStudioConnectUrl': 'string',
            'RStudioPackageManagerUrl': 'string',
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED'
    },
    DefaultSpaceSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        }
    }
)
type DomainName

string

param DomainName

[REQUIRED]

A name for the domain.

type AuthMode

string

param AuthMode

[REQUIRED]

The mode of authentication that members use to access the domain.

type DefaultUserSettings

dict

param DefaultUserSettings

[REQUIRED]

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings , the values specified in CreateUserProfile take precedence over those specified in CreateDomain .

  • ExecutionRole (string) --

    The execution role for the user.

  • SecurityGroups (list) --

    The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

    Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

    • (string) --

  • SharingSettings (dict) --

    Specifies options for sharing Amazon SageMaker Studio notebooks.

    • NotebookOutputOption (string) --

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

    • S3OutputPath (string) --

      When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

    • S3KmsKeyId (string) --

      When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

  • JupyterServerAppSettings (dict) --

    The Jupyter server's app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The kernel gateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • TensorBoardAppSettings (dict) --

    The TensorBoard app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • RStudioServerProAppSettings (dict) --

    A collection of settings that configure user interaction with the RStudioServerPro app.

    • AccessStatus (string) --

      Indicates whether the current user has access to the RStudioServerPro app.

    • UserGroup (string) --

      The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

  • RSessionAppSettings (dict) --

    A collection of settings that configure the RSessionGateway app.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a RSession app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

  • CanvasAppSettings (dict) --

    The Canvas app settings.

    • TimeSeriesForecastingSettings (dict) --

      Time series forecast settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether time series forecasting is enabled or disabled in the Canvas application.

      • AmazonForecastRoleArn (string) --

        The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

    • ModelRegisterSettings (dict) --

      The model registry settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

      • CrossAccountModelRegisterRoleArn (string) --

        The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

    • WorkspaceSettings (dict) --

      The workspace settings for the SageMaker Canvas application.

      • S3ArtifactPath (string) --

        The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

      • S3KmsKeyId (string) --

        The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

    • IdentityProviderOAuthSettings (list) --

      The settings for connecting to an external data source with OAuth.

      • (dict) --

        The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

        • DataSourceName (string) --

          The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

        • Status (string) --

          Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

        • SecretArn (string) --

          The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

    • KendraSettings (dict) --

      The settings for document querying.

      • Status (string) --

        Describes whether the document querying feature is enabled or disabled in the Canvas application.

    • DirectDeploySettings (dict) --

      The model deployment settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether model deployment permissions are enabled or disabled in the Canvas application.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a JupyterLab app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 Code Editor application lifecycle configuration.

      • (string) --

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • DefaultEbsStorageSettings (dict) --

      The default EBS storage settings for a private space.

      • DefaultEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The default size of the EBS storage volume for a private space.

      • MaximumEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The maximum size of the EBS storage volume for a private space.

  • DefaultLandingUri (string) --

    The default experience that the user is directed to when accessing the domain. The supported values are:

    • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

    • app:JupyterServer: : Indicates that Studio Classic is the default experience.

  • StudioWebPortal (string) --

    Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

  • CustomPosixUserConfig (dict) --

    Details about the POSIX identity that is used for file system operations.

    • Uid (integer) -- [REQUIRED]

      The POSIX user ID.

    • Gid (integer) -- [REQUIRED]

      The POSIX group ID.

  • CustomFileSystemConfigs (list) --

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    • (dict) --

      The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

      • EFSFileSystemConfig (dict) --

        The settings for a custom Amazon EFS file system.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

        • FileSystemPath (string) --

          The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

type SubnetIds

list

param SubnetIds

[REQUIRED]

The VPC subnets that the domain uses for communication.

  • (string) --

type VpcId

string

param VpcId

[REQUIRED]

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

type Tags

list

param Tags

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type AppNetworkAccessType

string

param 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 traffic is through the specified VPC and subnets

type HomeEfsFileSystemKmsKeyId

string

param HomeEfsFileSystemKmsKeyId

Use KmsKeyId .

type KmsKeyId

string

param KmsKeyId

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

type AppSecurityGroupManagement

string

param 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. If setting up the domain for use with RStudio, this value must be set to Service .

type DomainSettings

dict

param DomainSettings

A collection of Domain settings.

  • SecurityGroupIds (list) --

    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

    • (string) --

  • RStudioServerProDomainSettings (dict) --

    A collection of settings that configure the RStudioServerPro Domain-level app.

    • DomainExecutionRoleArn (string) -- [REQUIRED]

      The ARN of the execution role for the RStudioServerPro Domain-level app.

    • RStudioConnectUrl (string) --

      A URL pointing to an RStudio Connect server.

    • RStudioPackageManagerUrl (string) --

      A URL pointing to an RStudio Package Manager server.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • ExecutionRoleIdentityConfig (string) --

    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

type DefaultSpaceSettings

dict

param DefaultSpaceSettings

The default settings used to create a space.

  • ExecutionRole (string) --

    The ARN of the execution role for the space.

  • SecurityGroups (list) --

    The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

    • (string) --

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string',
    'Url': 'string'
}

Response Structure

  • (dict) --

    • DomainArn (string) --

      The Amazon Resource Name (ARN) of the created domain.

    • Url (string) --

      The URL to the created domain.

CreateSpace (updated) Link ¶
Changes (request)
{'OwnershipSettings': {'OwnerUserProfileName': 'string'},
 'SpaceDisplayName': 'string',
 'SpaceSettings': {'AppType': 'JupyterServer | KernelGateway | TensorBoard | '
                              'RStudioServerPro | RSessionGateway | JupyterLab '
                              '| CodeEditor',
                   'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'CustomFileSystems': [{'EFSFileSystem': {'FileSystemId': 'string'}}],
                   'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                             'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'SpaceStorageSettings': {'EbsStorageSettings': {'EbsVolumeSizeInGb': 'integer'}}},
 'SpaceSharingSettings': {'SharingType': 'Private | Shared'}}

Creates a space used for real time collaboration in a Domain.

See also: AWS API Documentation

Request Syntax

client.create_space(
    DomainId='string',
    SpaceName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SpaceSettings={
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ]
    },
    SpaceDisplayName='string',
    OwnershipSettings={
        'OwnerUserProfileName': 'string'
    },
    SpaceSharingSettings={
        'SharingType': 'Private'|'Shared'
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type SpaceName

string

param SpaceName

[REQUIRED]

The name of the space.

type Tags

list

param Tags

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type SpaceSettings

dict

param SpaceSettings

A collection of space settings.

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • EbsStorageSettings (dict) --

      A collection of EBS storage settings for a private space.

      • EbsVolumeSizeInGb (integer) -- [REQUIRED]

        The size of an EBS storage volume for a private space.

  • AppType (string) --

    The type of app created within the space.

  • CustomFileSystems (list) --

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

    • (dict) --

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

      Note

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

      • EFSFileSystem (dict) --

        A custom file system in Amazon EFS.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

type SpaceDisplayName

string

param SpaceDisplayName

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

type OwnershipSettings

dict

param OwnershipSettings

A collection of ownership settings.

  • OwnerUserProfileName (string) -- [REQUIRED]

    The user profile who is the owner of the private space.

type SpaceSharingSettings

dict

param SpaceSharingSettings

A collection of space sharing settings.

  • SharingType (string) -- [REQUIRED]

    Specifies the sharing type of the space.

rtype

dict

returns

Response Syntax

{
    'SpaceArn': 'string'
}

Response Structure

  • (dict) --

    • SpaceArn (string) --

      The space's Amazon Resource Name (ARN).

CreateStudioLifecycleConfig (updated) Link ¶
Changes (request)
{'StudioLifecycleConfigAppType': {'JupyterLab', 'CodeEditor'}}

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

See also: AWS API Documentation

Request Syntax

client.create_studio_lifecycle_config(
    StudioLifecycleConfigName='string',
    StudioLifecycleConfigContent='string',
    StudioLifecycleConfigAppType='JupyterServer'|'KernelGateway'|'JupyterLab'|'CodeEditor',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type StudioLifecycleConfigName

string

param StudioLifecycleConfigName

[REQUIRED]

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

type StudioLifecycleConfigContent

string

param StudioLifecycleConfigContent

[REQUIRED]

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

type StudioLifecycleConfigAppType

string

param StudioLifecycleConfigAppType

[REQUIRED]

The App type that the Lifecycle Configuration is attached to.

type Tags

list

param Tags

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

rtype

dict

returns

Response Syntax

{
    'StudioLifecycleConfigArn': 'string'
}

Response Structure

  • (dict) --

    • StudioLifecycleConfigArn (string) --

      The ARN of your created Lifecycle Configuration.

CreateUserProfile (updated) Link ¶
Changes (request)
{'UserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                       'FileSystemPath': 'string'}}],
                  'CustomPosixUserConfig': {'Gid': 'long', 'Uid': 'long'},
                  'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                            'CustomImages': [{'AppImageConfigName': 'string',
                                                              'ImageName': 'string',
                                                              'ImageVersionNumber': 'integer'}],
                                            'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                         'MaximumEbsVolumeSizeInGb': 'integer'}}}}

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

See also: AWS API Documentation

Request Syntax

client.create_user_profile(
    DomainId='string',
    UserProfileName='string',
    SingleSignOnUserIdentifier='string',
    SingleSignOnUserValue='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    UserSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type UserProfileName

string

param UserProfileName

[REQUIRED]

A name for the UserProfile. This value is not case sensitive.

type SingleSignOnUserIdentifier

string

param SingleSignOnUserIdentifier

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

type SingleSignOnUserValue

string

param SingleSignOnUserValue

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

type Tags

list

param Tags

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type UserSettings

dict

param UserSettings

A collection of settings.

  • ExecutionRole (string) --

    The execution role for the user.

  • SecurityGroups (list) --

    The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

    Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

    • (string) --

  • SharingSettings (dict) --

    Specifies options for sharing Amazon SageMaker Studio notebooks.

    • NotebookOutputOption (string) --

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

    • S3OutputPath (string) --

      When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

    • S3KmsKeyId (string) --

      When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

  • JupyterServerAppSettings (dict) --

    The Jupyter server's app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The kernel gateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • TensorBoardAppSettings (dict) --

    The TensorBoard app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • RStudioServerProAppSettings (dict) --

    A collection of settings that configure user interaction with the RStudioServerPro app.

    • AccessStatus (string) --

      Indicates whether the current user has access to the RStudioServerPro app.

    • UserGroup (string) --

      The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

  • RSessionAppSettings (dict) --

    A collection of settings that configure the RSessionGateway app.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a RSession app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

  • CanvasAppSettings (dict) --

    The Canvas app settings.

    • TimeSeriesForecastingSettings (dict) --

      Time series forecast settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether time series forecasting is enabled or disabled in the Canvas application.

      • AmazonForecastRoleArn (string) --

        The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

    • ModelRegisterSettings (dict) --

      The model registry settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

      • CrossAccountModelRegisterRoleArn (string) --

        The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

    • WorkspaceSettings (dict) --

      The workspace settings for the SageMaker Canvas application.

      • S3ArtifactPath (string) --

        The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

      • S3KmsKeyId (string) --

        The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

    • IdentityProviderOAuthSettings (list) --

      The settings for connecting to an external data source with OAuth.

      • (dict) --

        The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

        • DataSourceName (string) --

          The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

        • Status (string) --

          Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

        • SecretArn (string) --

          The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

    • KendraSettings (dict) --

      The settings for document querying.

      • Status (string) --

        Describes whether the document querying feature is enabled or disabled in the Canvas application.

    • DirectDeploySettings (dict) --

      The model deployment settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether model deployment permissions are enabled or disabled in the Canvas application.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a JupyterLab app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 Code Editor application lifecycle configuration.

      • (string) --

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • DefaultEbsStorageSettings (dict) --

      The default EBS storage settings for a private space.

      • DefaultEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The default size of the EBS storage volume for a private space.

      • MaximumEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The maximum size of the EBS storage volume for a private space.

  • DefaultLandingUri (string) --

    The default experience that the user is directed to when accessing the domain. The supported values are:

    • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

    • app:JupyterServer: : Indicates that Studio Classic is the default experience.

  • StudioWebPortal (string) --

    Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

  • CustomPosixUserConfig (dict) --

    Details about the POSIX identity that is used for file system operations.

    • Uid (integer) -- [REQUIRED]

      The POSIX user ID.

    • Gid (integer) -- [REQUIRED]

      The POSIX group ID.

  • CustomFileSystemConfigs (list) --

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    • (dict) --

      The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

      • EFSFileSystemConfig (dict) --

        The settings for a custom Amazon EFS file system.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

        • FileSystemPath (string) --

          The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

  • (dict) --

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).

DeleteApp (updated) Link ¶
Changes (request)
{'AppType': {'JupyterLab', 'CodeEditor'}}

Used to stop and delete an app.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    DomainId='string',
    UserProfileName='string',
    AppType='JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
    AppName='string',
    SpaceName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

The user profile name. If this value is not set, then SpaceName must be set.

type AppType

string

param AppType

[REQUIRED]

The type of app.

type AppName

string

param AppName

[REQUIRED]

The name of the app.

type SpaceName

string

param SpaceName

The name of the space. If this value is not set, then UserProfileName must be set.

returns

None

DescribeApp (updated) Link ¶
Changes (both)
{'AppType': {'JupyterLab', 'CodeEditor'}}

Describes the app.

See also: AWS API Documentation

Request Syntax

client.describe_app(
    DomainId='string',
    UserProfileName='string',
    AppType='JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
    AppName='string',
    SpaceName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

The user profile name. If this value is not set, then SpaceName must be set.

type AppType

string

param AppType

[REQUIRED]

The type of app.

type AppName

string

param AppName

[REQUIRED]

The name of the app.

type SpaceName

string

param SpaceName

The name of the space.

rtype

dict

returns

Response Syntax

{
    'AppArn': 'string',
    'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
    'AppName': 'string',
    'DomainId': 'string',
    'UserProfileName': 'string',
    'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending',
    'LastHealthCheckTimestamp': datetime(2015, 1, 1),
    'LastUserActivityTimestamp': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'ResourceSpec': {
        'SageMakerImageArn': 'string',
        'SageMakerImageVersionArn': 'string',
        'SageMakerImageVersionAlias': 'string',
        'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
        'LifecycleConfigArn': 'string'
    },
    'SpaceName': 'string'
}

Response Structure

  • (dict) --

    • AppArn (string) --

      The Amazon Resource Name (ARN) of the app.

    • AppType (string) --

      The type of app.

    • AppName (string) --

      The name of the app.

    • DomainId (string) --

      The domain ID.

    • UserProfileName (string) --

      The user profile name.

    • Status (string) --

      The status.

    • LastHealthCheckTimestamp (datetime) --

      The timestamp of the last health check.

    • LastUserActivityTimestamp (datetime) --

      The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp .

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • ResourceSpec (dict) --

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

    • SpaceName (string) --

      The name of the space. If this value is not set, then UserProfileName must be set.

DescribeAppImageConfig (updated) Link ¶
Changes (response)
{'JupyterLabAppImageConfig': {'ContainerConfig': {'ContainerArguments': ['string'],
                                                  'ContainerEntrypoint': ['string'],
                                                  'ContainerEnvironmentVariables': {'string': 'string'}}}}

Describes an AppImageConfig.

See also: AWS API Documentation

Request Syntax

client.describe_app_image_config(
    AppImageConfigName='string'
)
type AppImageConfigName

string

param AppImageConfigName

[REQUIRED]

The name of the AppImageConfig to describe.

rtype

dict

returns

Response Syntax

{
    'AppImageConfigArn': 'string',
    'AppImageConfigName': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'KernelGatewayImageConfig': {
        'KernelSpecs': [
            {
                'Name': 'string',
                'DisplayName': 'string'
            },
        ],
        'FileSystemConfig': {
            'MountPath': 'string',
            'DefaultUid': 123,
            'DefaultGid': 123
        }
    },
    'JupyterLabAppImageConfig': {
        'ContainerConfig': {
            'ContainerArguments': [
                'string',
            ],
            'ContainerEntrypoint': [
                'string',
            ],
            'ContainerEnvironmentVariables': {
                'string': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --

    • AppImageConfigArn (string) --

      The Amazon Resource Name (ARN) of the AppImageConfig.

    • AppImageConfigName (string) --

      The name of the AppImageConfig.

    • CreationTime (datetime) --

      When the AppImageConfig was created.

    • LastModifiedTime (datetime) --

      When the AppImageConfig was last modified.

    • KernelGatewayImageConfig (dict) --

      The configuration of a KernelGateway app.

      • KernelSpecs (list) --

        The specification of the Jupyter kernels in the image.

        • (dict) --

          The specification of a Jupyter kernel.

          • Name (string) --

            The name of the Jupyter kernel in the image. This value is case sensitive.

          • DisplayName (string) --

            The display name of the kernel.

      • FileSystemConfig (dict) --

        The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

        • MountPath (string) --

          The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .

        • DefaultUid (integer) --

          The default POSIX user ID (UID). If not specified, defaults to 1000 .

        • DefaultGid (integer) --

          The default POSIX group ID (GID). If not specified, defaults to 100 .

    • JupyterLabAppImageConfig (dict) --

      The configuration of the JupyterLab app.

      • ContainerConfig (dict) --

        The configuration used to run the application image container.

        • ContainerArguments (list) --

          The arguments for the container when you're running the application.

          • (string) --

        • ContainerEntrypoint (list) --

          The entrypoint used to run the application in the container.

          • (string) --

        • ContainerEnvironmentVariables (dict) --

          The environment variables to set in the container

          • (string) --

            • (string) --

DescribeDomain (updated) Link ¶
Changes (response)
{'DefaultUserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                              'FileSystemPath': 'string'}}],
                         'CustomPosixUserConfig': {'Gid': 'long',
                                                   'Uid': 'long'},
                         'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                                   'CustomImages': [{'AppImageConfigName': 'string',
                                                                     'ImageName': 'string',
                                                                     'ImageVersionNumber': 'integer'}],
                                                   'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                                'MaximumEbsVolumeSizeInGb': 'integer'}}}}

The description of the domain.

See also: AWS API Documentation

Request Syntax

client.describe_domain(
    DomainId='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string',
    'DomainId': 'string',
    'DomainName': 'string',
    'HomeEfsFileSystemId': 'string',
    'SingleSignOnManagedApplicationInstanceId': 'string',
    'SingleSignOnApplicationArn': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'AuthMode': 'SSO'|'IAM',
    'DefaultUserSettings': {
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    },
    'AppNetworkAccessType': 'PublicInternetOnly'|'VpcOnly',
    'HomeEfsFileSystemKmsKeyId': 'string',
    'SubnetIds': [
        'string',
    ],
    'Url': 'string',
    'VpcId': 'string',
    'KmsKeyId': 'string',
    'DomainSettings': {
        'SecurityGroupIds': [
            'string',
        ],
        'RStudioServerProDomainSettings': {
            'DomainExecutionRoleArn': 'string',
            'RStudioConnectUrl': 'string',
            'RStudioPackageManagerUrl': 'string',
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED'
    },
    'AppSecurityGroupManagement': 'Service'|'Customer',
    'SecurityGroupIdForDomainBoundary': 'string',
    'DefaultSpaceSettings': {
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) --

    • 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 IAM Identity Center managed application instance ID.

    • SingleSignOnApplicationArn (string) --

      The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after September 19, 2023.

    • Status (string) --

      The status.

    • CreationTime (datetime) --

      The creation time.

    • LastModifiedTime (datetime) --

      The last modified time.

    • FailureReason (string) --

      The failure reason.

    • AuthMode (string) --

      The domain's authentication mode.

    • DefaultUserSettings (dict) --

      Settings which are applied to UserProfiles 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 for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        • (string) --

      • SharingSettings (dict) --

        Specifies options for sharing Amazon SageMaker Studio notebooks.

        • NotebookOutputOption (string) --

          Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

        • S3OutputPath (string) --

          When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

        • S3KmsKeyId (string) --

          When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

      • JupyterServerAppSettings (dict) --

        The Jupyter server's app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 automatically displays to users for cloning in the JupyterServer application.

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • KernelGatewayAppSettings (dict) --

        The kernel gateway app settings.

        • DefaultResourceSpec (dict) --

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

          Note

          The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a KernelGateway app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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) --

      • TensorBoardAppSettings (dict) --

        The TensorBoard app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

      • RStudioServerProAppSettings (dict) --

        A collection of settings that configure user interaction with the RStudioServerPro app.

        • AccessStatus (string) --

          Indicates whether the current user has access to the RStudioServerPro app.

        • UserGroup (string) --

          The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

      • RSessionAppSettings (dict) --

        A collection of settings that configure the RSessionGateway app.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a RSession app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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.

      • CanvasAppSettings (dict) --

        The Canvas app settings.

        • TimeSeriesForecastingSettings (dict) --

          Time series forecast settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether time series forecasting is enabled or disabled in the Canvas application.

          • AmazonForecastRoleArn (string) --

            The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

        • ModelRegisterSettings (dict) --

          The model registry settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

          • CrossAccountModelRegisterRoleArn (string) --

            The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

        • WorkspaceSettings (dict) --

          The workspace settings for the SageMaker Canvas application.

          • S3ArtifactPath (string) --

            The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

          • S3KmsKeyId (string) --

            The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

        • IdentityProviderOAuthSettings (list) --

          The settings for connecting to an external data source with OAuth.

          • (dict) --

            The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

            • DataSourceName (string) --

              The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

            • Status (string) --

              Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

            • SecretArn (string) --

              The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

        • KendraSettings (dict) --

          The settings for document querying.

          • Status (string) --

            Describes whether the document querying feature is enabled or disabled in the Canvas application.

        • DirectDeploySettings (dict) --

          The model deployment settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether model deployment permissions are enabled or disabled in the Canvas application.

      • JupyterLabAppSettings (dict) --

        The settings for the JupyterLab application.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a JupyterLab app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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 user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

          • (string) --

        • CodeRepositories (list) --

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

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • CodeEditorAppSettings (dict) --

        The Code Editor application settings.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 Code Editor application lifecycle configuration.

          • (string) --

      • SpaceStorageSettings (dict) --

        The storage settings for a private space.

        • DefaultEbsStorageSettings (dict) --

          The default EBS storage settings for a private space.

          • DefaultEbsVolumeSizeInGb (integer) --

            The default size of the EBS storage volume for a private space.

          • MaximumEbsVolumeSizeInGb (integer) --

            The maximum size of the EBS storage volume for a private space.

      • DefaultLandingUri (string) --

        The default experience that the user is directed to when accessing the domain. The supported values are:

        • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

        • app:JupyterServer: : Indicates that Studio Classic is the default experience.

      • StudioWebPortal (string) --

        Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

      • CustomPosixUserConfig (dict) --

        Details about the POSIX identity that is used for file system operations.

        • Uid (integer) --

          The POSIX user ID.

        • Gid (integer) --

          The POSIX group ID.

      • CustomFileSystemConfigs (list) --

        The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

        • (dict) --

          The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: EFSFileSystemConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • EFSFileSystemConfig (dict) --

            The settings for a custom Amazon EFS file system.

            • FileSystemId (string) --

              The ID of your Amazon EFS file system.

            • FileSystemPath (string) --

              The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

    • AppNetworkAccessType (string) --

      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 traffic is through the specified VPC and subnets

    • HomeEfsFileSystemKmsKeyId (string) --

      Use KmsKeyId .

    • SubnetIds (list) --

      The VPC subnets that the domain uses for communication.

      • (string) --

    • Url (string) --

      The domain's URL.

    • VpcId (string) --

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

    • KmsKeyId (string) --

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

    • DomainSettings (dict) --

      A collection of Domain settings.

      • SecurityGroupIds (list) --

        The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

        • (string) --

      • RStudioServerProDomainSettings (dict) --

        A collection of settings that configure the RStudioServerPro Domain-level app.

        • DomainExecutionRoleArn (string) --

          The ARN of the execution role for the RStudioServerPro Domain-level app.

        • RStudioConnectUrl (string) --

          A URL pointing to an RStudio Connect server.

        • RStudioPackageManagerUrl (string) --

          A URL pointing to an RStudio Package Manager server.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

      • ExecutionRoleIdentityConfig (string) --

        The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

    • AppSecurityGroupManagement (string) --

      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.

    • SecurityGroupIdForDomainBoundary (string) --

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

    • DefaultSpaceSettings (dict) --

      The default settings used to create a space.

      • ExecutionRole (string) --

        The ARN of the execution role for the space.

      • SecurityGroups (list) --

        The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

        • (string) --

      • JupyterServerAppSettings (dict) --

        The JupyterServer app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 automatically displays to users for cloning in the JupyterServer application.

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • KernelGatewayAppSettings (dict) --

        The KernelGateway app settings.

        • DefaultResourceSpec (dict) --

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

          Note

          The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a KernelGateway app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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) --

DescribeSpace (updated) Link ¶
Changes (response)
{'OwnershipSettings': {'OwnerUserProfileName': 'string'},
 'SpaceDisplayName': 'string',
 'SpaceSettings': {'AppType': 'JupyterServer | KernelGateway | TensorBoard | '
                              'RStudioServerPro | RSessionGateway | JupyterLab '
                              '| CodeEditor',
                   'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'CustomFileSystems': [{'EFSFileSystem': {'FileSystemId': 'string'}}],
                   'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                             'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'SpaceStorageSettings': {'EbsStorageSettings': {'EbsVolumeSizeInGb': 'integer'}}},
 'SpaceSharingSettings': {'SharingType': 'Private | Shared'}}

Describes the space.

See also: AWS API Documentation

Request Syntax

client.describe_space(
    DomainId='string',
    SpaceName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type SpaceName

string

param SpaceName

[REQUIRED]

The name of the space.

rtype

dict

returns

Response Syntax

{
    'DomainId': 'string',
    'SpaceArn': 'string',
    'SpaceName': 'string',
    'HomeEfsFileSystemUid': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'SpaceSettings': {
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ]
    },
    'Url': 'string',
    'SpaceDisplayName': 'string',
    'OwnershipSettings': {
        'OwnerUserProfileName': 'string'
    },
    'SpaceSharingSettings': {
        'SharingType': 'Private'|'Shared'
    }
}

Response Structure

  • (dict) --

    • 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 Elastic File System volume.

    • Status (string) --

      The status.

    • LastModifiedTime (datetime) --

      The last modified time.

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • SpaceSettings (dict) --

      A collection of space settings.

      • JupyterServerAppSettings (dict) --

        The JupyterServer app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 automatically displays to users for cloning in the JupyterServer application.

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • KernelGatewayAppSettings (dict) --

        The KernelGateway app settings.

        • DefaultResourceSpec (dict) --

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

          Note

          The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a KernelGateway app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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) --

      • JupyterLabAppSettings (dict) --

        The settings for the JupyterLab application.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • CodeEditorAppSettings (dict) --

        The Code Editor application settings.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

      • SpaceStorageSettings (dict) --

        The storage settings for a private space.

        • EbsStorageSettings (dict) --

          A collection of EBS storage settings for a private space.

          • EbsVolumeSizeInGb (integer) --

            The size of an EBS storage volume for a private space.

      • AppType (string) --

        The type of app created within the space.

      • CustomFileSystems (list) --

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

        • (dict) --

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

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: EFSFileSystem. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • EFSFileSystem (dict) --

            A custom file system in Amazon EFS.

            • FileSystemId (string) --

              The ID of your Amazon EFS file system.

    • 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

    • SpaceDisplayName (string) --

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

    • OwnershipSettings (dict) --

      The collection of ownership settings for a space.

      • OwnerUserProfileName (string) --

        The user profile who is the owner of the private space.

    • SpaceSharingSettings (dict) --

      The collection of space sharing settings for a space.

      • SharingType (string) --

        Specifies the sharing type of the space.

DescribeStudioLifecycleConfig (updated) Link ¶
Changes (response)
{'StudioLifecycleConfigAppType': {'JupyterLab', 'CodeEditor'}}

Describes the Amazon SageMaker Studio Lifecycle Configuration.

See also: AWS API Documentation

Request Syntax

client.describe_studio_lifecycle_config(
    StudioLifecycleConfigName='string'
)
type StudioLifecycleConfigName

string

param StudioLifecycleConfigName

[REQUIRED]

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

rtype

dict

returns

Response Syntax

{
    'StudioLifecycleConfigArn': 'string',
    'StudioLifecycleConfigName': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'StudioLifecycleConfigContent': 'string',
    'StudioLifecycleConfigAppType': 'JupyterServer'|'KernelGateway'|'JupyterLab'|'CodeEditor'
}

Response Structure

  • (dict) --

    • StudioLifecycleConfigArn (string) --

      The ARN of the Lifecycle Configuration to describe.

    • StudioLifecycleConfigName (string) --

      The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

    • CreationTime (datetime) --

      The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

    • LastModifiedTime (datetime) --

      This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

    • StudioLifecycleConfigContent (string) --

      The content of your Amazon SageMaker Studio Lifecycle Configuration script.

    • StudioLifecycleConfigAppType (string) --

      The App type that the Lifecycle Configuration is attached to.

DescribeUserProfile (updated) Link ¶
Changes (response)
{'UserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                       'FileSystemPath': 'string'}}],
                  'CustomPosixUserConfig': {'Gid': 'long', 'Uid': 'long'},
                  'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                            'CustomImages': [{'AppImageConfigName': 'string',
                                                              'ImageName': 'string',
                                                              'ImageVersionNumber': 'integer'}],
                                            'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                         'MaximumEbsVolumeSizeInGb': 'integer'}}}}

Describes a user profile. For more information, see CreateUserProfile .

See also: AWS API Documentation

Request Syntax

client.describe_user_profile(
    DomainId='string',
    UserProfileName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name. This value is not case sensitive.

rtype

dict

returns

Response Syntax

{
    'DomainId': 'string',
    'UserProfileArn': 'string',
    'UserProfileName': 'string',
    'HomeEfsFileSystemUid': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'SingleSignOnUserIdentifier': 'string',
    'SingleSignOnUserValue': 'string',
    'UserSettings': {
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • DomainId (string) --

      The ID of the domain that contains the profile.

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).

    • UserProfileName (string) --

      The user profile name.

    • HomeEfsFileSystemUid (string) --

      The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

    • Status (string) --

      The status.

    • LastModifiedTime (datetime) --

      The last modified time.

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • SingleSignOnUserIdentifier (string) --

      The IAM Identity Center user identifier.

    • SingleSignOnUserValue (string) --

      The IAM Identity Center user value.

    • UserSettings (dict) --

      A collection of settings.

      • ExecutionRole (string) --

        The execution role for the user.

      • SecurityGroups (list) --

        The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        • (string) --

      • SharingSettings (dict) --

        Specifies options for sharing Amazon SageMaker Studio notebooks.

        • NotebookOutputOption (string) --

          Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

        • S3OutputPath (string) --

          When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

        • S3KmsKeyId (string) --

          When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

      • JupyterServerAppSettings (dict) --

        The Jupyter server's app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 automatically displays to users for cloning in the JupyterServer application.

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • KernelGatewayAppSettings (dict) --

        The kernel gateway app settings.

        • DefaultResourceSpec (dict) --

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

          Note

          The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a KernelGateway app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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) --

      • TensorBoardAppSettings (dict) --

        The TensorBoard app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

      • RStudioServerProAppSettings (dict) --

        A collection of settings that configure user interaction with the RStudioServerPro app.

        • AccessStatus (string) --

          Indicates whether the current user has access to the RStudioServerPro app.

        • UserGroup (string) --

          The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

      • RSessionAppSettings (dict) --

        A collection of settings that configure the RSessionGateway app.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a RSession app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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.

      • CanvasAppSettings (dict) --

        The Canvas app settings.

        • TimeSeriesForecastingSettings (dict) --

          Time series forecast settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether time series forecasting is enabled or disabled in the Canvas application.

          • AmazonForecastRoleArn (string) --

            The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

        • ModelRegisterSettings (dict) --

          The model registry settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

          • CrossAccountModelRegisterRoleArn (string) --

            The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

        • WorkspaceSettings (dict) --

          The workspace settings for the SageMaker Canvas application.

          • S3ArtifactPath (string) --

            The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

          • S3KmsKeyId (string) --

            The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

        • IdentityProviderOAuthSettings (list) --

          The settings for connecting to an external data source with OAuth.

          • (dict) --

            The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

            • DataSourceName (string) --

              The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

            • Status (string) --

              Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

            • SecretArn (string) --

              The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

        • KendraSettings (dict) --

          The settings for document querying.

          • Status (string) --

            Describes whether the document querying feature is enabled or disabled in the Canvas application.

        • DirectDeploySettings (dict) --

          The model deployment settings for the SageMaker Canvas application.

          • Status (string) --

            Describes whether model deployment permissions are enabled or disabled in the Canvas application.

      • JupyterLabAppSettings (dict) --

        The settings for the JupyterLab application.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 images that are configured to run as a JupyterLab app.

          • (dict) --

            A custom SageMaker image. For more information, see Bring your own SageMaker 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 user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

          • (string) --

        • CodeRepositories (list) --

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

          • (dict) --

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

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • CodeEditorAppSettings (dict) --

        The Code Editor application settings.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

          • 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 Code Editor application lifecycle configuration.

          • (string) --

      • SpaceStorageSettings (dict) --

        The storage settings for a private space.

        • DefaultEbsStorageSettings (dict) --

          The default EBS storage settings for a private space.

          • DefaultEbsVolumeSizeInGb (integer) --

            The default size of the EBS storage volume for a private space.

          • MaximumEbsVolumeSizeInGb (integer) --

            The maximum size of the EBS storage volume for a private space.

      • DefaultLandingUri (string) --

        The default experience that the user is directed to when accessing the domain. The supported values are:

        • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

        • app:JupyterServer: : Indicates that Studio Classic is the default experience.

      • StudioWebPortal (string) --

        Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

      • CustomPosixUserConfig (dict) --

        Details about the POSIX identity that is used for file system operations.

        • Uid (integer) --

          The POSIX user ID.

        • Gid (integer) --

          The POSIX group ID.

      • CustomFileSystemConfigs (list) --

        The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

        • (dict) --

          The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: EFSFileSystemConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • EFSFileSystemConfig (dict) --

            The settings for a custom Amazon EFS file system.

            • FileSystemId (string) --

              The ID of your Amazon EFS file system.

            • FileSystemPath (string) --

              The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

ListAppImageConfigs (updated) Link ¶
Changes (response)
{'AppImageConfigs': {'JupyterLabAppImageConfig': {'ContainerConfig': {'ContainerArguments': ['string'],
                                                                      'ContainerEntrypoint': ['string'],
                                                                      'ContainerEnvironmentVariables': {'string': 'string'}}}}}

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

See also: AWS API Documentation

Request Syntax

client.list_app_image_configs(
    MaxResults=123,
    NextToken='string',
    NameContains='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    ModifiedTimeBefore=datetime(2015, 1, 1),
    ModifiedTimeAfter=datetime(2015, 1, 1),
    SortBy='CreationTime'|'LastModifiedTime'|'Name',
    SortOrder='Ascending'|'Descending'
)
type MaxResults

integer

param MaxResults

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

type NextToken

string

param NextToken

If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

type NameContains

string

param NameContains

A filter that returns only AppImageConfigs whose name contains the specified string.

type CreationTimeBefore

datetime

param CreationTimeBefore

A filter that returns only AppImageConfigs created on or before the specified time.

type CreationTimeAfter

datetime

param CreationTimeAfter

A filter that returns only AppImageConfigs created on or after the specified time.

type ModifiedTimeBefore

datetime

param ModifiedTimeBefore

A filter that returns only AppImageConfigs modified on or before the specified time.

type ModifiedTimeAfter

datetime

param ModifiedTimeAfter

A filter that returns only AppImageConfigs modified on or after the specified time.

type SortBy

string

param SortBy

The property used to sort results. The default value is CreationTime .

type SortOrder

string

param SortOrder

The sort order. The default value is Descending .

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'AppImageConfigs': [
        {
            'AppImageConfigArn': 'string',
            'AppImageConfigName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'KernelGatewayImageConfig': {
                'KernelSpecs': [
                    {
                        'Name': 'string',
                        'DisplayName': 'string'
                    },
                ],
                'FileSystemConfig': {
                    'MountPath': 'string',
                    'DefaultUid': 123,
                    'DefaultGid': 123
                }
            },
            'JupyterLabAppImageConfig': {
                'ContainerConfig': {
                    'ContainerArguments': [
                        'string',
                    ],
                    'ContainerEntrypoint': [
                        'string',
                    ],
                    'ContainerEnvironmentVariables': {
                        'string': 'string'
                    }
                }
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A token for getting the next set of AppImageConfigs, if there are any.

    • AppImageConfigs (list) --

      A list of AppImageConfigs and their properties.

      • (dict) --

        The configuration for running a SageMaker image as a KernelGateway app.

        • AppImageConfigArn (string) --

          The Amazon Resource Name (ARN) of the AppImageConfig.

        • AppImageConfigName (string) --

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

        • CreationTime (datetime) --

          When the AppImageConfig was created.

        • LastModifiedTime (datetime) --

          When the AppImageConfig was last modified.

        • KernelGatewayImageConfig (dict) --

          The configuration for the file system and kernels in the SageMaker image.

          • KernelSpecs (list) --

            The specification of the Jupyter kernels in the image.

            • (dict) --

              The specification of a Jupyter kernel.

              • Name (string) --

                The name of the Jupyter kernel in the image. This value is case sensitive.

              • DisplayName (string) --

                The display name of the kernel.

          • FileSystemConfig (dict) --

            The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

            • MountPath (string) --

              The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .

            • DefaultUid (integer) --

              The default POSIX user ID (UID). If not specified, defaults to 1000 .

            • DefaultGid (integer) --

              The default POSIX group ID (GID). If not specified, defaults to 100 .

        • JupyterLabAppImageConfig (dict) --

          The configuration for the file system and the runtime, such as the environment variables and entry point.

          • ContainerConfig (dict) --

            The configuration used to run the application image container.

            • ContainerArguments (list) --

              The arguments for the container when you're running the application.

              • (string) --

            • ContainerEntrypoint (list) --

              The entrypoint used to run the application in the container.

              • (string) --

            • ContainerEnvironmentVariables (dict) --

              The environment variables to set in the container

              • (string) --

                • (string) --

ListApps (updated) Link ¶
Changes (response)
{'Apps': {'AppType': {'JupyterLab', 'CodeEditor'},
          'ResourceSpec': {'InstanceType': 'system | ml.t3.micro | ml.t3.small '
                                           '| ml.t3.medium | ml.t3.large | '
                                           'ml.t3.xlarge | ml.t3.2xlarge | '
                                           'ml.m5.large | ml.m5.xlarge | '
                                           'ml.m5.2xlarge | ml.m5.4xlarge | '
                                           'ml.m5.8xlarge | ml.m5.12xlarge | '
                                           'ml.m5.16xlarge | ml.m5.24xlarge | '
                                           'ml.m5d.large | ml.m5d.xlarge | '
                                           'ml.m5d.2xlarge | ml.m5d.4xlarge | '
                                           'ml.m5d.8xlarge | ml.m5d.12xlarge | '
                                           'ml.m5d.16xlarge | ml.m5d.24xlarge '
                                           '| ml.c5.large | ml.c5.xlarge | '
                                           'ml.c5.2xlarge | ml.c5.4xlarge | '
                                           'ml.c5.9xlarge | ml.c5.12xlarge | '
                                           'ml.c5.18xlarge | ml.c5.24xlarge | '
                                           'ml.p3.2xlarge | ml.p3.8xlarge | '
                                           'ml.p3.16xlarge | ml.p3dn.24xlarge '
                                           '| ml.g4dn.xlarge | ml.g4dn.2xlarge '
                                           '| ml.g4dn.4xlarge | '
                                           'ml.g4dn.8xlarge | ml.g4dn.12xlarge '
                                           '| ml.g4dn.16xlarge | ml.r5.large | '
                                           'ml.r5.xlarge | ml.r5.2xlarge | '
                                           'ml.r5.4xlarge | ml.r5.8xlarge | '
                                           'ml.r5.12xlarge | ml.r5.16xlarge | '
                                           'ml.r5.24xlarge | ml.g5.xlarge | '
                                           'ml.g5.2xlarge | ml.g5.4xlarge | '
                                           'ml.g5.8xlarge | ml.g5.16xlarge | '
                                           'ml.g5.12xlarge | ml.g5.24xlarge | '
                                           'ml.g5.48xlarge | '
                                           'ml.geospatial.interactive | '
                                           'ml.p4d.24xlarge | ml.p4de.24xlarge '
                                           '| ml.trn1.2xlarge | '
                                           'ml.trn1.32xlarge | '
                                           'ml.trn1n.32xlarge',
                           'LifecycleConfigArn': 'string',
                           'SageMakerImageArn': 'string',
                           'SageMakerImageVersionAlias': 'string',
                           'SageMakerImageVersionArn': 'string'}}}

Lists apps.

See also: AWS API Documentation

Request Syntax

client.list_apps(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime',
    DomainIdEquals='string',
    UserProfileNameEquals='string',
    SpaceNameEquals='string'
)
type NextToken

string

param NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

type MaxResults

integer

param MaxResults

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

type SortOrder

string

param SortOrder

The sort order for the results. The default is Ascending.

type SortBy

string

param SortBy

The parameter by which to sort the results. The default is CreationTime.

type DomainIdEquals

string

param DomainIdEquals

A parameter to search for the domain ID.

type UserProfileNameEquals

string

param UserProfileNameEquals

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

type SpaceNameEquals

string

param SpaceNameEquals

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

rtype

dict

returns

Response Syntax

{
    'Apps': [
        {
            'DomainId': 'string',
            'UserProfileName': 'string',
            'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
            'AppName': 'string',
            'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending',
            'CreationTime': datetime(2015, 1, 1),
            'SpaceName': 'string',
            'ResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Apps (list) --

      The list of apps.

      • (dict) --

        Details about an Amazon SageMaker app.

        • DomainId (string) --

          The domain ID.

        • UserProfileName (string) --

          The user profile name.

        • AppType (string) --

          The type of app.

        • AppName (string) --

          The name of the app.

        • Status (string) --

          The status.

        • CreationTime (datetime) --

          The creation time.

        • SpaceName (string) --

          The name of the space.

        • ResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

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

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias.

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

    • NextToken (string) --

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

ListSpaces (updated) Link ¶
Changes (response)
{'Spaces': {'OwnershipSettingsSummary': {'OwnerUserProfileName': 'string'},
            'SpaceDisplayName': 'string',
            'SpaceSettingsSummary': {'AppType': 'JupyterServer | KernelGateway '
                                                '| TensorBoard | '
                                                'RStudioServerPro | '
                                                'RSessionGateway | JupyterLab '
                                                '| CodeEditor',
                                     'SpaceStorageSettings': {'EbsStorageSettings': {'EbsVolumeSizeInGb': 'integer'}}},
            'SpaceSharingSettingsSummary': {'SharingType': 'Private | Shared'}}}

Lists spaces.

See also: AWS API Documentation

Request Syntax

client.list_spaces(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime'|'LastModifiedTime',
    DomainIdEquals='string',
    SpaceNameContains='string'
)
type NextToken

string

param NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

type MaxResults

integer

param MaxResults

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

type SortOrder

string

param SortOrder

The sort order for the results. The default is Ascending .

type SortBy

string

param SortBy

The parameter by which to sort the results. The default is CreationTime .

type DomainIdEquals

string

param DomainIdEquals

A parameter to search for the Domain ID.

type SpaceNameContains

string

param SpaceNameContains

A parameter by which to filter the results.

rtype

dict

returns

Response Syntax

{
    'Spaces': [
        {
            'DomainId': 'string',
            'SpaceName': 'string',
            'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'SpaceDisplayName': 'string',
            'SpaceSettingsSummary': {
                'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
                'SpaceStorageSettings': {
                    'EbsStorageSettings': {
                        'EbsVolumeSizeInGb': 123
                    }
                }
            },
            'SpaceSharingSettingsSummary': {
                'SharingType': 'Private'|'Shared'
            },
            'OwnershipSettingsSummary': {
                'OwnerUserProfileName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Spaces (list) --

      The list of spaces.

      • (dict) --

        The space's details.

        • DomainId (string) --

          The ID of the associated Domain.

        • SpaceName (string) --

          The name of the space.

        • Status (string) --

          The status.

        • CreationTime (datetime) --

          The creation time.

        • LastModifiedTime (datetime) --

          The last modified time.

        • SpaceDisplayName (string) --

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

        • SpaceSettingsSummary (dict) --

          Specifies summary information about the space settings.

          • AppType (string) --

            The type of app created within the space.

          • SpaceStorageSettings (dict) --

            The storage settings for a private space.

            • EbsStorageSettings (dict) --

              A collection of EBS storage settings for a private space.

              • EbsVolumeSizeInGb (integer) --

                The size of an EBS storage volume for a private space.

        • SpaceSharingSettingsSummary (dict) --

          Specifies summary information about the space sharing settings.

          • SharingType (string) --

            Specifies the sharing type of the space.

        • OwnershipSettingsSummary (dict) --

          Specifies summary information about the ownership settings.

          • OwnerUserProfileName (string) --

            The user profile who is the owner of the private space.

    • NextToken (string) --

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

ListStudioLifecycleConfigs (updated) Link ¶
Changes (request, response)
Request
{'AppTypeEquals': {'JupyterLab', 'CodeEditor'}}
Response
{'StudioLifecycleConfigs': {'StudioLifecycleConfigAppType': {'CodeEditor',
                                                             'JupyterLab'}}}

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

See also: AWS API Documentation

Request Syntax

client.list_studio_lifecycle_configs(
    MaxResults=123,
    NextToken='string',
    NameContains='string',
    AppTypeEquals='JupyterServer'|'KernelGateway'|'JupyterLab'|'CodeEditor',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    ModifiedTimeBefore=datetime(2015, 1, 1),
    ModifiedTimeAfter=datetime(2015, 1, 1),
    SortBy='CreationTime'|'LastModifiedTime'|'Name',
    SortOrder='Ascending'|'Descending'
)
type MaxResults

integer

param MaxResults

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

type NextToken

string

param NextToken

If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

type NameContains

string

param NameContains

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

type AppTypeEquals

string

param AppTypeEquals

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

type CreationTimeBefore

datetime

param CreationTimeBefore

A filter that returns only Lifecycle Configurations created on or before the specified time.

type CreationTimeAfter

datetime

param CreationTimeAfter

A filter that returns only Lifecycle Configurations created on or after the specified time.

type ModifiedTimeBefore

datetime

param ModifiedTimeBefore

A filter that returns only Lifecycle Configurations modified before the specified time.

type ModifiedTimeAfter

datetime

param ModifiedTimeAfter

A filter that returns only Lifecycle Configurations modified after the specified time.

type SortBy

string

param SortBy

The property used to sort results. The default value is CreationTime.

type SortOrder

string

param SortOrder

The sort order. The default value is Descending.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'StudioLifecycleConfigs': [
        {
            'StudioLifecycleConfigArn': 'string',
            'StudioLifecycleConfigName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'StudioLifecycleConfigAppType': 'JupyterServer'|'KernelGateway'|'JupyterLab'|'CodeEditor'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

    • StudioLifecycleConfigs (list) --

      A list of Lifecycle Configurations and their properties.

      • (dict) --

        Details of the Amazon SageMaker Studio Lifecycle Configuration.

        • StudioLifecycleConfigArn (string) --

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

        • StudioLifecycleConfigName (string) --

          The name of the Amazon SageMaker Studio Lifecycle Configuration.

        • CreationTime (datetime) --

          The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

        • LastModifiedTime (datetime) --

          This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

        • StudioLifecycleConfigAppType (string) --

          The App type to which the Lifecycle Configuration is attached.

UpdateAppImageConfig (updated) Link ¶
Changes (request)
{'JupyterLabAppImageConfig': {'ContainerConfig': {'ContainerArguments': ['string'],
                                                  'ContainerEntrypoint': ['string'],
                                                  'ContainerEnvironmentVariables': {'string': 'string'}}}}

Updates the properties of an AppImageConfig.

See also: AWS API Documentation

Request Syntax

client.update_app_image_config(
    AppImageConfigName='string',
    KernelGatewayImageConfig={
        'KernelSpecs': [
            {
                'Name': 'string',
                'DisplayName': 'string'
            },
        ],
        'FileSystemConfig': {
            'MountPath': 'string',
            'DefaultUid': 123,
            'DefaultGid': 123
        }
    },
    JupyterLabAppImageConfig={
        'ContainerConfig': {
            'ContainerArguments': [
                'string',
            ],
            'ContainerEntrypoint': [
                'string',
            ],
            'ContainerEnvironmentVariables': {
                'string': 'string'
            }
        }
    }
)
type AppImageConfigName

string

param AppImageConfigName

[REQUIRED]

The name of the AppImageConfig to update.

type KernelGatewayImageConfig

dict

param KernelGatewayImageConfig

The new KernelGateway app to run on the image.

  • KernelSpecs (list) -- [REQUIRED]

    The specification of the Jupyter kernels in the image.

    • (dict) --

      The specification of a Jupyter kernel.

      • Name (string) -- [REQUIRED]

        The name of the Jupyter kernel in the image. This value is case sensitive.

      • DisplayName (string) --

        The display name of the kernel.

  • FileSystemConfig (dict) --

    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

    • MountPath (string) --

      The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .

    • DefaultUid (integer) --

      The default POSIX user ID (UID). If not specified, defaults to 1000 .

    • DefaultGid (integer) --

      The default POSIX group ID (GID). If not specified, defaults to 100 .

type JupyterLabAppImageConfig

dict

param JupyterLabAppImageConfig

The JupyterLab app running on the image.

  • ContainerConfig (dict) --

    The configuration used to run the application image container.

    • ContainerArguments (list) --

      The arguments for the container when you're running the application.

      • (string) --

    • ContainerEntrypoint (list) --

      The entrypoint used to run the application in the container.

      • (string) --

    • ContainerEnvironmentVariables (dict) --

      The environment variables to set in the container

      • (string) --

        • (string) --

rtype

dict

returns

Response Syntax

{
    'AppImageConfigArn': 'string'
}

Response Structure

  • (dict) --

    • AppImageConfigArn (string) --

      The Amazon Resource Name (ARN) for the AppImageConfig.

UpdateDomain (updated) Link ¶
Changes (request)
{'DefaultUserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                              'FileSystemPath': 'string'}}],
                         'CustomPosixUserConfig': {'Gid': 'long',
                                                   'Uid': 'long'},
                         'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                                   'CustomImages': [{'AppImageConfigName': 'string',
                                                                     'ImageName': 'string',
                                                                     'ImageVersionNumber': 'integer'}],
                                                   'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                           '| '
                                                                                           'ml.t3.micro '
                                                                                           '| '
                                                                                           'ml.t3.small '
                                                                                           '| '
                                                                                           'ml.t3.medium '
                                                                                           '| '
                                                                                           'ml.t3.large '
                                                                                           '| '
                                                                                           'ml.t3.xlarge '
                                                                                           '| '
                                                                                           'ml.t3.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.large '
                                                                                           '| '
                                                                                           'ml.m5.xlarge '
                                                                                           '| '
                                                                                           'ml.m5.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5.24xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.large '
                                                                                           '| '
                                                                                           'ml.m5d.xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.2xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.4xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.8xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.12xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.16xlarge '
                                                                                           '| '
                                                                                           'ml.m5d.24xlarge '
                                                                                           '| '
                                                                                           'ml.c5.large '
                                                                                           '| '
                                                                                           'ml.c5.xlarge '
                                                                                           '| '
                                                                                           'ml.c5.2xlarge '
                                                                                           '| '
                                                                                           'ml.c5.4xlarge '
                                                                                           '| '
                                                                                           'ml.c5.9xlarge '
                                                                                           '| '
                                                                                           'ml.c5.12xlarge '
                                                                                           '| '
                                                                                           'ml.c5.18xlarge '
                                                                                           '| '
                                                                                           'ml.c5.24xlarge '
                                                                                           '| '
                                                                                           'ml.p3.2xlarge '
                                                                                           '| '
                                                                                           'ml.p3.8xlarge '
                                                                                           '| '
                                                                                           'ml.p3.16xlarge '
                                                                                           '| '
                                                                                           'ml.p3dn.24xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.2xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.4xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.8xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.12xlarge '
                                                                                           '| '
                                                                                           'ml.g4dn.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.large '
                                                                                           '| '
                                                                                           'ml.r5.xlarge '
                                                                                           '| '
                                                                                           'ml.r5.2xlarge '
                                                                                           '| '
                                                                                           'ml.r5.4xlarge '
                                                                                           '| '
                                                                                           'ml.r5.8xlarge '
                                                                                           '| '
                                                                                           'ml.r5.12xlarge '
                                                                                           '| '
                                                                                           'ml.r5.16xlarge '
                                                                                           '| '
                                                                                           'ml.r5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.xlarge '
                                                                                           '| '
                                                                                           'ml.g5.2xlarge '
                                                                                           '| '
                                                                                           'ml.g5.4xlarge '
                                                                                           '| '
                                                                                           'ml.g5.8xlarge '
                                                                                           '| '
                                                                                           'ml.g5.16xlarge '
                                                                                           '| '
                                                                                           'ml.g5.12xlarge '
                                                                                           '| '
                                                                                           'ml.g5.24xlarge '
                                                                                           '| '
                                                                                           'ml.g5.48xlarge '
                                                                                           '| '
                                                                                           'ml.geospatial.interactive '
                                                                                           '| '
                                                                                           'ml.p4d.24xlarge '
                                                                                           '| '
                                                                                           'ml.p4de.24xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.2xlarge '
                                                                                           '| '
                                                                                           'ml.trn1.32xlarge '
                                                                                           '| '
                                                                                           'ml.trn1n.32xlarge',
                                                                           'LifecycleConfigArn': 'string',
                                                                           'SageMakerImageArn': 'string',
                                                                           'SageMakerImageVersionAlias': 'string',
                                                                           'SageMakerImageVersionArn': 'string'},
                                                   'LifecycleConfigArns': ['string']},
                         'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                                'MaximumEbsVolumeSizeInGb': 'integer'}}}}

Updates the default settings for new user profiles in the domain.

See also: AWS API Documentation

Request Syntax

client.update_domain(
    DomainId='string',
    DefaultUserSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    },
    DomainSettingsForUpdate={
        'RStudioServerProDomainSettingsForUpdate': {
            'DomainExecutionRoleArn': 'string',
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'RStudioConnectUrl': 'string',
            'RStudioPackageManagerUrl': 'string'
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED',
        'SecurityGroupIds': [
            'string',
        ]
    },
    DefaultSpaceSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        }
    },
    AppSecurityGroupManagement='Service'|'Customer',
    SubnetIds=[
        'string',
    ],
    AppNetworkAccessType='PublicInternetOnly'|'VpcOnly'
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the domain to be updated.

type DefaultUserSettings

dict

param DefaultUserSettings

A collection of settings.

  • ExecutionRole (string) --

    The execution role for the user.

  • SecurityGroups (list) --

    The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

    Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

    • (string) --

  • SharingSettings (dict) --

    Specifies options for sharing Amazon SageMaker Studio notebooks.

    • NotebookOutputOption (string) --

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

    • S3OutputPath (string) --

      When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

    • S3KmsKeyId (string) --

      When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

  • JupyterServerAppSettings (dict) --

    The Jupyter server's app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The kernel gateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • TensorBoardAppSettings (dict) --

    The TensorBoard app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • RStudioServerProAppSettings (dict) --

    A collection of settings that configure user interaction with the RStudioServerPro app.

    • AccessStatus (string) --

      Indicates whether the current user has access to the RStudioServerPro app.

    • UserGroup (string) --

      The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

  • RSessionAppSettings (dict) --

    A collection of settings that configure the RSessionGateway app.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a RSession app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

  • CanvasAppSettings (dict) --

    The Canvas app settings.

    • TimeSeriesForecastingSettings (dict) --

      Time series forecast settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether time series forecasting is enabled or disabled in the Canvas application.

      • AmazonForecastRoleArn (string) --

        The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

    • ModelRegisterSettings (dict) --

      The model registry settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

      • CrossAccountModelRegisterRoleArn (string) --

        The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

    • WorkspaceSettings (dict) --

      The workspace settings for the SageMaker Canvas application.

      • S3ArtifactPath (string) --

        The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

      • S3KmsKeyId (string) --

        The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

    • IdentityProviderOAuthSettings (list) --

      The settings for connecting to an external data source with OAuth.

      • (dict) --

        The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

        • DataSourceName (string) --

          The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

        • Status (string) --

          Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

        • SecretArn (string) --

          The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

    • KendraSettings (dict) --

      The settings for document querying.

      • Status (string) --

        Describes whether the document querying feature is enabled or disabled in the Canvas application.

    • DirectDeploySettings (dict) --

      The model deployment settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether model deployment permissions are enabled or disabled in the Canvas application.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a JupyterLab app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 Code Editor application lifecycle configuration.

      • (string) --

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • DefaultEbsStorageSettings (dict) --

      The default EBS storage settings for a private space.

      • DefaultEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The default size of the EBS storage volume for a private space.

      • MaximumEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The maximum size of the EBS storage volume for a private space.

  • DefaultLandingUri (string) --

    The default experience that the user is directed to when accessing the domain. The supported values are:

    • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

    • app:JupyterServer: : Indicates that Studio Classic is the default experience.

  • StudioWebPortal (string) --

    Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

  • CustomPosixUserConfig (dict) --

    Details about the POSIX identity that is used for file system operations.

    • Uid (integer) -- [REQUIRED]

      The POSIX user ID.

    • Gid (integer) -- [REQUIRED]

      The POSIX group ID.

  • CustomFileSystemConfigs (list) --

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    • (dict) --

      The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

      • EFSFileSystemConfig (dict) --

        The settings for a custom Amazon EFS file system.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

        • FileSystemPath (string) --

          The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

type DomainSettingsForUpdate

dict

param DomainSettingsForUpdate

A collection of DomainSettings configuration values to update.

  • RStudioServerProDomainSettingsForUpdate (dict) --

    A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

    • DomainExecutionRoleArn (string) -- [REQUIRED]

      The execution role for the RStudioServerPro Domain-level app.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

    • RStudioConnectUrl (string) --

      A URL pointing to an RStudio Connect server.

    • RStudioPackageManagerUrl (string) --

      A URL pointing to an RStudio Package Manager server.

  • ExecutionRoleIdentityConfig (string) --

    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

  • SecurityGroupIds (list) --

    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

    • (string) --

type DefaultSpaceSettings

dict

param DefaultSpaceSettings

The default settings used to create a space within the Domain.

  • ExecutionRole (string) --

    The ARN of the execution role for the space.

  • SecurityGroups (list) --

    The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

    • (string) --

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

type AppSecurityGroupManagement

string

param 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. If setting up the domain for use with RStudio, this value must be set to Service .

type SubnetIds

list

param SubnetIds

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService , Pending , or Deleting state.

  • (string) --

type AppNetworkAccessType

string

param AppNetworkAccessType

Specifies the VPC used for non-EFS traffic.

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

This configuration can only be modified if there are no apps in the InService , Pending , or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string'
}

Response Structure

  • (dict) --

    • DomainArn (string) --

      The Amazon Resource Name (ARN) of the domain.

UpdateSpace (updated) Link ¶
Changes (request)
{'SpaceDisplayName': 'string',
 'SpaceSettings': {'AppType': 'JupyterServer | KernelGateway | TensorBoard | '
                              'RStudioServerPro | RSessionGateway | JupyterLab '
                              '| CodeEditor',
                   'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'CustomFileSystems': [{'EFSFileSystem': {'FileSystemId': 'string'}}],
                   'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                             'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                     '| '
                                                                                     'ml.t3.micro '
                                                                                     '| '
                                                                                     'ml.t3.small '
                                                                                     '| '
                                                                                     'ml.t3.medium '
                                                                                     '| '
                                                                                     'ml.t3.large '
                                                                                     '| '
                                                                                     'ml.t3.xlarge '
                                                                                     '| '
                                                                                     'ml.t3.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.large '
                                                                                     '| '
                                                                                     'ml.m5.xlarge '
                                                                                     '| '
                                                                                     'ml.m5.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5.24xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.large '
                                                                                     '| '
                                                                                     'ml.m5d.xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.2xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.4xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.8xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.12xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.16xlarge '
                                                                                     '| '
                                                                                     'ml.m5d.24xlarge '
                                                                                     '| '
                                                                                     'ml.c5.large '
                                                                                     '| '
                                                                                     'ml.c5.xlarge '
                                                                                     '| '
                                                                                     'ml.c5.2xlarge '
                                                                                     '| '
                                                                                     'ml.c5.4xlarge '
                                                                                     '| '
                                                                                     'ml.c5.9xlarge '
                                                                                     '| '
                                                                                     'ml.c5.12xlarge '
                                                                                     '| '
                                                                                     'ml.c5.18xlarge '
                                                                                     '| '
                                                                                     'ml.c5.24xlarge '
                                                                                     '| '
                                                                                     'ml.p3.2xlarge '
                                                                                     '| '
                                                                                     'ml.p3.8xlarge '
                                                                                     '| '
                                                                                     'ml.p3.16xlarge '
                                                                                     '| '
                                                                                     'ml.p3dn.24xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.2xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.4xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.8xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.12xlarge '
                                                                                     '| '
                                                                                     'ml.g4dn.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.large '
                                                                                     '| '
                                                                                     'ml.r5.xlarge '
                                                                                     '| '
                                                                                     'ml.r5.2xlarge '
                                                                                     '| '
                                                                                     'ml.r5.4xlarge '
                                                                                     '| '
                                                                                     'ml.r5.8xlarge '
                                                                                     '| '
                                                                                     'ml.r5.12xlarge '
                                                                                     '| '
                                                                                     'ml.r5.16xlarge '
                                                                                     '| '
                                                                                     'ml.r5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.xlarge '
                                                                                     '| '
                                                                                     'ml.g5.2xlarge '
                                                                                     '| '
                                                                                     'ml.g5.4xlarge '
                                                                                     '| '
                                                                                     'ml.g5.8xlarge '
                                                                                     '| '
                                                                                     'ml.g5.16xlarge '
                                                                                     '| '
                                                                                     'ml.g5.12xlarge '
                                                                                     '| '
                                                                                     'ml.g5.24xlarge '
                                                                                     '| '
                                                                                     'ml.g5.48xlarge '
                                                                                     '| '
                                                                                     'ml.geospatial.interactive '
                                                                                     '| '
                                                                                     'ml.p4d.24xlarge '
                                                                                     '| '
                                                                                     'ml.p4de.24xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.2xlarge '
                                                                                     '| '
                                                                                     'ml.trn1.32xlarge '
                                                                                     '| '
                                                                                     'ml.trn1n.32xlarge',
                                                                     'LifecycleConfigArn': 'string',
                                                                     'SageMakerImageArn': 'string',
                                                                     'SageMakerImageVersionAlias': 'string',
                                                                     'SageMakerImageVersionArn': 'string'}},
                   'SpaceStorageSettings': {'EbsStorageSettings': {'EbsVolumeSizeInGb': 'integer'}}}}

Updates the settings of a space.

See also: AWS API Documentation

Request Syntax

client.update_space(
    DomainId='string',
    SpaceName='string',
    SpaceSettings={
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway'|'JupyterLab'|'CodeEditor',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ]
    },
    SpaceDisplayName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type SpaceName

string

param SpaceName

[REQUIRED]

The name of the space.

type SpaceSettings

dict

param SpaceSettings

A collection of space settings.

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • EbsStorageSettings (dict) --

      A collection of EBS storage settings for a private space.

      • EbsVolumeSizeInGb (integer) -- [REQUIRED]

        The size of an EBS storage volume for a private space.

  • AppType (string) --

    The type of app created within the space.

  • CustomFileSystems (list) --

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

    • (dict) --

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

      Note

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

      • EFSFileSystem (dict) --

        A custom file system in Amazon EFS.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

type SpaceDisplayName

string

param SpaceDisplayName

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

rtype

dict

returns

Response Syntax

{
    'SpaceArn': 'string'
}

Response Structure

  • (dict) --

    • SpaceArn (string) --

      The space's Amazon Resource Name (ARN).

UpdateUserProfile (updated) Link ¶
Changes (request)
{'UserSettings': {'CodeEditorAppSettings': {'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'CustomFileSystemConfigs': [{'EFSFileSystemConfig': {'FileSystemId': 'string',
                                                                       'FileSystemPath': 'string'}}],
                  'CustomPosixUserConfig': {'Gid': 'long', 'Uid': 'long'},
                  'JupyterLabAppSettings': {'CodeRepositories': [{'RepositoryUrl': 'string'}],
                                            'CustomImages': [{'AppImageConfigName': 'string',
                                                              'ImageName': 'string',
                                                              'ImageVersionNumber': 'integer'}],
                                            'DefaultResourceSpec': {'InstanceType': 'system '
                                                                                    '| '
                                                                                    'ml.t3.micro '
                                                                                    '| '
                                                                                    'ml.t3.small '
                                                                                    '| '
                                                                                    'ml.t3.medium '
                                                                                    '| '
                                                                                    'ml.t3.large '
                                                                                    '| '
                                                                                    'ml.t3.xlarge '
                                                                                    '| '
                                                                                    'ml.t3.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.large '
                                                                                    '| '
                                                                                    'ml.m5.xlarge '
                                                                                    '| '
                                                                                    'ml.m5.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5.24xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.large '
                                                                                    '| '
                                                                                    'ml.m5d.xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.2xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.4xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.8xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.12xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.16xlarge '
                                                                                    '| '
                                                                                    'ml.m5d.24xlarge '
                                                                                    '| '
                                                                                    'ml.c5.large '
                                                                                    '| '
                                                                                    'ml.c5.xlarge '
                                                                                    '| '
                                                                                    'ml.c5.2xlarge '
                                                                                    '| '
                                                                                    'ml.c5.4xlarge '
                                                                                    '| '
                                                                                    'ml.c5.9xlarge '
                                                                                    '| '
                                                                                    'ml.c5.12xlarge '
                                                                                    '| '
                                                                                    'ml.c5.18xlarge '
                                                                                    '| '
                                                                                    'ml.c5.24xlarge '
                                                                                    '| '
                                                                                    'ml.p3.2xlarge '
                                                                                    '| '
                                                                                    'ml.p3.8xlarge '
                                                                                    '| '
                                                                                    'ml.p3.16xlarge '
                                                                                    '| '
                                                                                    'ml.p3dn.24xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.2xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.4xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.8xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.12xlarge '
                                                                                    '| '
                                                                                    'ml.g4dn.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.large '
                                                                                    '| '
                                                                                    'ml.r5.xlarge '
                                                                                    '| '
                                                                                    'ml.r5.2xlarge '
                                                                                    '| '
                                                                                    'ml.r5.4xlarge '
                                                                                    '| '
                                                                                    'ml.r5.8xlarge '
                                                                                    '| '
                                                                                    'ml.r5.12xlarge '
                                                                                    '| '
                                                                                    'ml.r5.16xlarge '
                                                                                    '| '
                                                                                    'ml.r5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.xlarge '
                                                                                    '| '
                                                                                    'ml.g5.2xlarge '
                                                                                    '| '
                                                                                    'ml.g5.4xlarge '
                                                                                    '| '
                                                                                    'ml.g5.8xlarge '
                                                                                    '| '
                                                                                    'ml.g5.16xlarge '
                                                                                    '| '
                                                                                    'ml.g5.12xlarge '
                                                                                    '| '
                                                                                    'ml.g5.24xlarge '
                                                                                    '| '
                                                                                    'ml.g5.48xlarge '
                                                                                    '| '
                                                                                    'ml.geospatial.interactive '
                                                                                    '| '
                                                                                    'ml.p4d.24xlarge '
                                                                                    '| '
                                                                                    'ml.p4de.24xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.2xlarge '
                                                                                    '| '
                                                                                    'ml.trn1.32xlarge '
                                                                                    '| '
                                                                                    'ml.trn1n.32xlarge',
                                                                    'LifecycleConfigArn': 'string',
                                                                    'SageMakerImageArn': 'string',
                                                                    'SageMakerImageVersionAlias': 'string',
                                                                    'SageMakerImageVersionArn': 'string'},
                                            'LifecycleConfigArns': ['string']},
                  'SpaceStorageSettings': {'DefaultEbsStorageSettings': {'DefaultEbsVolumeSizeInGb': 'integer',
                                                                         'MaximumEbsVolumeSizeInGb': 'integer'}}}}

Updates a user profile.

See also: AWS API Documentation

Request Syntax

client.update_user_profile(
    DomainId='string',
    UserProfileName='string',
    UserSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            },
            'WorkspaceSettings': {
                'S3ArtifactPath': 'string',
                'S3KmsKeyId': 'string'
            },
            'IdentityProviderOAuthSettings': [
                {
                    'DataSourceName': 'SalesforceGenie'|'Snowflake',
                    'Status': 'ENABLED'|'DISABLED',
                    'SecretArn': 'string'
                },
            ],
            'KendraSettings': {
                'Status': 'ENABLED'|'DISABLED'
            },
            'DirectDeploySettings': {
                'Status': 'ENABLED'|'DISABLED'
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'SpaceStorageSettings': {
            'DefaultEbsStorageSettings': {
                'DefaultEbsVolumeSizeInGb': 123,
                'MaximumEbsVolumeSizeInGb': 123
            }
        },
        'DefaultLandingUri': 'string',
        'StudioWebPortal': 'ENABLED'|'DISABLED',
        'CustomPosixUserConfig': {
            'Uid': 123,
            'Gid': 123
        },
        'CustomFileSystemConfigs': [
            {
                'EFSFileSystemConfig': {
                    'FileSystemId': 'string',
                    'FileSystemPath': 'string'
                }
            },
        ]
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name.

type UserSettings

dict

param UserSettings

A collection of settings.

  • ExecutionRole (string) --

    The execution role for the user.

  • SecurityGroups (list) --

    The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

    Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

    • (string) --

  • SharingSettings (dict) --

    Specifies options for sharing Amazon SageMaker Studio notebooks.

    • NotebookOutputOption (string) --

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

    • S3OutputPath (string) --

      When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

    • S3KmsKeyId (string) --

      When NotebookOutputOption is Allowed , the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

  • JupyterServerAppSettings (dict) --

    The Jupyter server's app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker 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 image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 automatically displays to users for cloning in the JupyterServer application.

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The kernel gateway app settings.

    • DefaultResourceSpec (dict) --

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

      Note

      The Amazon SageMaker 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 Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a KernelGateway app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

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

  • TensorBoardAppSettings (dict) --

    The TensorBoard app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

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

  • RStudioServerProAppSettings (dict) --

    A collection of settings that configure user interaction with the RStudioServerPro app.

    • AccessStatus (string) --

      Indicates whether the current user has access to the RStudioServerPro app.

    • UserGroup (string) --

      The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

  • RSessionAppSettings (dict) --

    A collection of settings that configure the RSessionGateway app.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a RSession app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

  • CanvasAppSettings (dict) --

    The Canvas app settings.

    • TimeSeriesForecastingSettings (dict) --

      Time series forecast settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether time series forecasting is enabled or disabled in the Canvas application.

      • AmazonForecastRoleArn (string) --

        The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile , Canvas uses the execution role specified in the Domain that owns the UserProfile . To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

    • ModelRegisterSettings (dict) --

      The model registry settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

      • CrossAccountModelRegisterRoleArn (string) --

        The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

    • WorkspaceSettings (dict) --

      The workspace settings for the SageMaker Canvas application.

      • S3ArtifactPath (string) --

        The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

      • S3KmsKeyId (string) --

        The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

    • IdentityProviderOAuthSettings (list) --

      The settings for connecting to an external data source with OAuth.

      • (dict) --

        The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

        • DataSourceName (string) --

          The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

        • Status (string) --

          Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

        • SecretArn (string) --

          The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

    • KendraSettings (dict) --

      The settings for document querying.

      • Status (string) --

        Describes whether the document querying feature is enabled or disabled in the Canvas application.

    • DirectDeploySettings (dict) --

      The model deployment settings for the SageMaker Canvas application.

      • Status (string) --

        Describes whether model deployment permissions are enabled or disabled in the Canvas application.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 images that are configured to run as a JupyterLab app.

      • (dict) --

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

        • ImageName (string) -- [REQUIRED]

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

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

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

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

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

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias.

      • 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 Code Editor application lifecycle configuration.

      • (string) --

  • SpaceStorageSettings (dict) --

    The storage settings for a private space.

    • DefaultEbsStorageSettings (dict) --

      The default EBS storage settings for a private space.

      • DefaultEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The default size of the EBS storage volume for a private space.

      • MaximumEbsVolumeSizeInGb (integer) -- [REQUIRED]

        The maximum size of the EBS storage volume for a private space.

  • DefaultLandingUri (string) --

    The default experience that the user is directed to when accessing the domain. The supported values are:

    • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

    • app:JupyterServer: : Indicates that Studio Classic is the default experience.

  • StudioWebPortal (string) --

    Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

  • CustomPosixUserConfig (dict) --

    Details about the POSIX identity that is used for file system operations.

    • Uid (integer) -- [REQUIRED]

      The POSIX user ID.

    • Gid (integer) -- [REQUIRED]

      The POSIX group ID.

  • CustomFileSystemConfigs (list) --

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    • (dict) --

      The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystemConfig.

      • EFSFileSystemConfig (dict) --

        The settings for a custom Amazon EFS file system.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

        • FileSystemPath (string) --

          The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

  • (dict) --

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).