AWS API Changes

2023/04/20 - Amazon SageMaker Service - 6 updated api methods

Changes Amazon SageMaker Canvas adds ModelRegisterSettings support for CanvasAppSettings.

CreateDomain (updated)

Link ¶
Changes (request)

{'DefaultUserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                         'Status': 'ENABLED '
                                                                                   '| '
                                                                                   'DISABLED'}}}}

Creates a Domain used by Amazon SageMaker Studio. 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 SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. 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 Studio 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 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.

For more information, see Connect 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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': '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',
                '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED'
    },
    DefaultSpaceSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                '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 Studio 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 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 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.
  - 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.
  - 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.
  - 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.
  - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.

type SubnetIds:

list

param SubnetIds:

[REQUIRED]

The VPC subnets that Studio uses for communication.

(string) --

type VpcId:

string

param VpcId:

[REQUIRED]

The ID of the Amazon Virtual Private Cloud (VPC) that Studio 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 Studio 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.

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

CreateUserProfile (updated)

Link ¶
Changes (request)

{'UserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                  'Status': 'ENABLED '
                                                                            '| '
                                                                            'DISABLED'}}}}

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 Amazon SageMaker Studio. 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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': '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 Studio 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 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 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.
  - 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.
  - 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.
  - 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.
  - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.

rtype:

dict

returns:

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

(dict) --
- UserProfileArn (string) --
  
  The user profile Amazon Resource Name (ARN).

DescribeDomain (updated)

Link ¶
Changes (response)

{'DefaultUserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                         'Status': 'ENABLED '
                                                                                   '| '
                                                                                   'DISABLED'}}}}

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',
    '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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': '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',
                '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED'
    },
    'AppSecurityGroupManagement': 'Service'|'Customer',
    'SecurityGroupIdForDomainBoundary': 'string',
    'DefaultSpaceSettings': {
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                '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.
- 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 Studio 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 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 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.
      - 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.
      - 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.
      - 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.
      - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.
- 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 Studio traffic is through the specified VPC and subnets
- HomeEfsFileSystemKmsKeyId (string) --
  
  Use KmsKeyId.
- SubnetIds (list) --
  
  The VPC subnets that Studio uses for communication.
  - (string) --
- Url (string) --
  
  The domain's URL.
- VpcId (string) --
  
  The ID of the Amazon Virtual Private Cloud (VPC) that Studio 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.
      - 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.
      - 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.
      - 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) --

DescribeUserProfile (updated)

Link ¶
Changes (response)

{'UserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                  'Status': 'ENABLED '
                                                                            '| '
                                                                            'DISABLED'}}}}

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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': '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 Studio 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 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 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.
      - 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.
      - 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.
      - 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.
      - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.

UpdateDomain (updated)

Link ¶
Changes (request)

{'DefaultUserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                         'Status': 'ENABLED '
                                                                                   '| '
                                                                                   'DISABLED'}}}}

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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            }
        }
    },
    DomainSettingsForUpdate={
        'RStudioServerProDomainSettingsForUpdate': {
            'DomainExecutionRoleArn': 'string',
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'RStudioConnectUrl': 'string',
            'RStudioPackageManagerUrl': 'string'
        },
        'ExecutionRoleIdentityConfig': 'USER_PROFILE_NAME'|'DISABLED',
        'SecurityGroupIds': [
            'string',
        ]
    },
    DefaultSpaceSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        }
    },
    AppSecurityGroupManagement='Service'|'Customer'
)

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 Studio 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 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 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.
  - 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.
  - 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.
  - 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.
  - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.

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

rtype:

dict

returns:

Response Syntax

{
    'DomainArn': 'string'
}

Response Structure

(dict) --
- DomainArn (string) --
  
  The Amazon Resource Name (ARN) of the domain.

UpdateUserProfile (updated)

Link ¶
Changes (request)

{'UserSettings': {'CanvasAppSettings': {'ModelRegisterSettings': {'CrossAccountModelRegisterRoleArn': 'string',
                                                                  'Status': 'ENABLED '
                                                                            '| '
                                                                            'DISABLED'}}}}

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',
                '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': '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 Studio 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 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 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.
  - 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.
  - 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.
  - 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.
  - 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 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 AWS account than the AWS account in which SageMaker model registry is set up.

rtype:

dict

returns:

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

(dict) --
- UserProfileArn (string) --
  
  The user profile Amazon Resource Name (ARN).