SageMaker / Client / create_user_profile
create_user_profile#
- SageMaker.Client.create_user_profile(**kwargs)#
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a “person” for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user’s private Amazon Elastic File System home directory.
See also: AWS API Documentation
Request Syntax
response = client.create_user_profile( DomainId='string', UserProfileName='string', SingleSignOnUserIdentifier='string', SingleSignOnUserValue='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], UserSettings={ 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' }, 'LifecycleConfigArns': [ 'string', ], 'CodeRepositories': [ { 'RepositoryUrl': 'string' }, ] }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ], 'LifecycleConfigArns': [ 'string', ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' } }, 'RStudioServerProAppSettings': { 'AccessStatus': 'ENABLED'|'DISABLED', 'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER' }, 'RSessionAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'CanvasAppSettings': { 'TimeSeriesForecastingSettings': { 'Status': 'ENABLED'|'DISABLED', 'AmazonForecastRoleArn': 'string' }, 'ModelRegisterSettings': { 'Status': 'ENABLED'|'DISABLED', 'CrossAccountModelRegisterRoleArn': 'string' }, 'WorkspaceSettings': { 'S3ArtifactPath': 'string', 'S3KmsKeyId': 'string' }, 'IdentityProviderOAuthSettings': [ { 'DataSourceName': 'SalesforceGenie'|'Snowflake', 'Status': 'ENABLED'|'DISABLED', 'SecretArn': 'string' }, ], 'DirectDeploySettings': { 'Status': 'ENABLED'|'DISABLED' }, 'KendraSettings': { 'Status': 'ENABLED'|'DISABLED' }, 'GenerativeAiSettings': { 'AmazonBedrockRoleArn': 'string' }, 'EmrServerlessSettings': { 'ExecutionRoleArn': 'string', 'Status': 'ENABLED'|'DISABLED' } }, 'CodeEditorAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ], 'LifecycleConfigArns': [ 'string', ], 'AppLifecycleManagement': { 'IdleSettings': { 'LifecycleManagement': 'ENABLED'|'DISABLED', 'IdleTimeoutInMinutes': 123, 'MinIdleTimeoutInMinutes': 123, 'MaxIdleTimeoutInMinutes': 123 } }, 'BuiltInLifecycleConfigArn': 'string' }, 'JupyterLabAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ], 'LifecycleConfigArns': [ 'string', ], 'CodeRepositories': [ { 'RepositoryUrl': 'string' }, ], 'AppLifecycleManagement': { 'IdleSettings': { 'LifecycleManagement': 'ENABLED'|'DISABLED', 'IdleTimeoutInMinutes': 123, 'MinIdleTimeoutInMinutes': 123, 'MaxIdleTimeoutInMinutes': 123 } }, 'EmrSettings': { 'AssumableRoleArns': [ 'string', ], 'ExecutionRoleArns': [ 'string', ] }, 'BuiltInLifecycleConfigArn': 'string' }, 'SpaceStorageSettings': { 'DefaultEbsStorageSettings': { 'DefaultEbsVolumeSizeInGb': 123, 'MaximumEbsVolumeSizeInGb': 123 } }, 'DefaultLandingUri': 'string', 'StudioWebPortal': 'ENABLED'|'DISABLED', 'CustomPosixUserConfig': { 'Uid': 123, 'Gid': 123 }, 'CustomFileSystemConfigs': [ { 'EFSFileSystemConfig': { 'FileSystemId': 'string', 'FileSystemPath': 'string' } }, ], 'StudioWebPortalSettings': { 'HiddenMlTools': [ 'DataWrangler'|'FeatureStore'|'EmrClusters'|'AutoMl'|'Experiments'|'Training'|'ModelEvaluation'|'Pipelines'|'Models'|'JumpStart'|'InferenceRecommender'|'Endpoints'|'Projects'|'InferenceOptimization'|'PerformanceEvaluation', ], 'HiddenAppTypes': [ 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas', ], 'HiddenInstanceTypes': [ '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.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge', ], 'HiddenSageMakerImageVersionAliases': [ { 'SageMakerImageName': 'sagemaker_distribution', 'VersionAliases': [ 'string', ] }, ] }, 'AutoMountHomeEFS': 'Enabled'|'Disabled'|'DefaultAsDomain' } )
- Parameters:
DomainId (string) –
[REQUIRED]
The ID of the associated Domain.
UserProfileName (string) –
[REQUIRED]
A name for the UserProfile. This value is not case sensitive.
SingleSignOnUserIdentifier (string) – 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.
SingleSignOnUserValue (string) – 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.
Tags (list) –
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.
UserSettings (dict) –
A collection of settings.
ExecutionRole (string) –
The execution role for the user.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.
SecurityGroups (list) –
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional when the
CreateDomain.AppNetworkAccessTypeparameter is set toPublicInternetOnly.Required when the
CreateDomain.AppNetworkAccessTypeparameter is set toVpcOnly, unless specified as part of theDefaultUserSettingsfor the domain.Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
(string) –
SharingSettings (dict) –
Specifies options for sharing Amazon SageMaker Studio notebooks.
NotebookOutputOption (string) –
Whether to include the notebook cell output when sharing the notebook. The default is
Disabled.S3OutputPath (string) –
When
NotebookOutputOptionisAllowed, the Amazon S3 bucket used to store the shared notebook snapshots.S3KmsKeyId (string) –
When
NotebookOutputOptionisAllowed, 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
LifecycleConfigArnsparameter, then this parameter is also required.SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.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
DefaultResourceSpecparameter is also required.Note
To remove a Lifecycle Config, you must set
LifecycleConfigArnsto 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 CLI or CloudFormation and the instance type parameter value is not passed.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.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
LifecycleConfigArnsto an empty list.(string) –
TensorBoardAppSettings (dict) –
The TensorBoard app settings.
DefaultResourceSpec (dict) –
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.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
RStudioServerProapp.AccessStatus (string) –
Indicates whether the current user has access to the
RStudioServerProapp.UserGroup (string) –
The level of permissions that the user has within the
RStudioServerProapp. 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
RSessionGatewayapp.DefaultResourceSpec (dict) –
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.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.
SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
TimeSeriesForecastingSettings (dict) –
Time series forecast settings for the SageMaker Canvas application.
Status (string) –
Describes whether time series forecasting is enabled or disabled in the Canvas application.
AmazonForecastRoleArn (string) –
The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the
UserProfilethat launches the Canvas application. If an execution role is not specified in theUserProfile, Canvas uses the execution role specified in the Domain that owns theUserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached andforecast.amazonaws.comadded in the trust relationship as a service principal.
ModelRegisterSettings (dict) –
The model registry settings for the SageMaker Canvas application.
Status (string) –
Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
CrossAccountModelRegisterRoleArn (string) –
The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.
WorkspaceSettings (dict) –
The workspace settings for the SageMaker Canvas application.
S3ArtifactPath (string) –
The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.
S3KmsKeyId (string) –
The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
IdentityProviderOAuthSettings (list) –
The settings for connecting to an external data source with OAuth.
(dict) –
The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.
DataSourceName (string) –
The name of the data source that you’re connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.
Status (string) –
Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
SecretArn (string) –
The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.
DirectDeploySettings (dict) –
The model deployment settings for the SageMaker Canvas application.
Status (string) –
Describes whether model deployment permissions are enabled or disabled in the Canvas application.
KendraSettings (dict) –
The settings for document querying.
Status (string) –
Describes whether the document querying feature is enabled or disabled in the Canvas application.
GenerativeAiSettings (dict) –
The generative AI settings for the SageMaker Canvas application.
AmazonBedrockRoleArn (string) –
The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes
bedrock.amazonaws.comas a service principal.
EmrServerlessSettings (dict) –
The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.
ExecutionRoleArn (string) –
The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary permissions to read and write data attached and a trust relationship with EMR Serverless.
Status (string) –
Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker Canvas application.
CodeEditorAppSettings (dict) –
The Code Editor application settings.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
DefaultResourceSpec (dict) –
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.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 Code Editor 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 Code Editor application lifecycle configuration.
(string) –
AppLifecycleManagement (dict) –
Settings that are used to configure and manage the lifecycle of CodeEditor applications.
IdleSettings (dict) –
Settings related to idle shutdown of Studio applications.
LifecycleManagement (string) –
Indicates whether idle shutdown is activated for the application type.
IdleTimeoutInMinutes (integer) –
The time that SageMaker waits after the application becomes idle before shutting it down.
MinIdleTimeoutInMinutes (integer) –
The minimum value in minutes that custom idle shutdown can be set to by the user.
MaxIdleTimeoutInMinutes (integer) –
The maximum value in minutes that custom idle shutdown can be set to by the user.
BuiltInLifecycleConfigArn (string) –
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
JupyterLabAppSettings (dict) –
The settings for the JupyterLab application.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
DefaultResourceSpec (dict) –
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
systemvalue.For KernelGateway apps, the
systemvalue is translated toml.t3.medium. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
CustomImages (list) –
A list of custom SageMaker images that are configured to run as a JupyterLab app.
(dict) –
A custom SageMaker image. For more information, see Bring your own SageMaker image.
ImageName (string) – [REQUIRED]
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) –
The version number of the CustomImage.
AppImageConfigName (string) – [REQUIRED]
The name of the AppImageConfig.
LifecycleConfigArns (list) –
The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set
LifecycleConfigArnsto an empty list.(string) –
CodeRepositories (list) –
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
(dict) –
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
RepositoryUrl (string) – [REQUIRED]
The URL of the Git repository.
AppLifecycleManagement (dict) –
Indicates whether idle shutdown is activated for JupyterLab applications.
IdleSettings (dict) –
Settings related to idle shutdown of Studio applications.
LifecycleManagement (string) –
Indicates whether idle shutdown is activated for the application type.
IdleTimeoutInMinutes (integer) –
The time that SageMaker waits after the application becomes idle before shutting it down.
MinIdleTimeoutInMinutes (integer) –
The minimum value in minutes that custom idle shutdown can be set to by the user.
MaxIdleTimeoutInMinutes (integer) –
The maximum value in minutes that custom idle shutdown can be set to by the user.
EmrSettings (dict) –
The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
AssumableRoleArns (list) –
An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain.
(string) –
ExecutionRoleArns (list) –
An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements.
(string) –
BuiltInLifecycleConfigArn (string) –
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
SpaceStorageSettings (dict) –
The storage settings for a space.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
DefaultEbsStorageSettings (dict) –
The default EBS storage settings for a space.
DefaultEbsVolumeSizeInGb (integer) – [REQUIRED]
The default size of the EBS storage volume for a space.
MaximumEbsVolumeSizeInGb (integer) – [REQUIRED]
The maximum size of the EBS storage volume for a space.
DefaultLandingUri (string) –
The default experience that the user is directed to when accessing the domain. The supported values are:
studio::: Indicates that Studio is the default experience. This value can only be passed ifStudioWebPortalis set toENABLED.app:JupyterServer:: Indicates that Studio Classic is the default experience.
StudioWebPortal (string) –
Whether the user can access Studio. If this value is set to
DISABLED, the user cannot access Studio, even if that is the default experience for the domain.CustomPosixUserConfig (dict) –
Details about the POSIX identity that is used for file system operations.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
Uid (integer) – [REQUIRED]
The POSIX user ID.
Gid (integer) – [REQUIRED]
The POSIX group ID.
CustomFileSystemConfigs (list) –
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.
(dict) –
The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
EFSFileSystemConfig.EFSFileSystemConfig (dict) –
The settings for a custom Amazon EFS file system.
FileSystemId (string) – [REQUIRED]
The ID of your Amazon EFS file system.
FileSystemPath (string) –
The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
StudioWebPortalSettings (dict) –
Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
HiddenMlTools (list) –
The machine learning tools that are hidden from the Studio left navigation pane.
(string) –
HiddenAppTypes (list) –
The Applications supported in Studio that are hidden from the Studio left navigation pane.
(string) –
HiddenInstanceTypes (list) –
The instance types you are hiding from the Studio user interface.
(string) –
HiddenSageMakerImageVersionAliases (list) –
The version aliases you are hiding from the Studio user interface.
(dict) –
The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.
SageMakerImageName (string) –
The SageMaker image name that you are hiding from the Studio user interface.
VersionAliases (list) –
The version aliases you are hiding from the Studio user interface.
(string) –
AutoMountHomeEFS (string) –
Indicates whether auto-mounting of an EFS volume is supported for the user profile. The
DefaultAsDomainvalue is only supported for user profiles. Do not use theDefaultAsDomainvalue when setting this parameter for a domain.SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.
- Return type:
dict
- Returns:
Response Syntax
{ 'UserProfileArn': 'string' }
Response Structure
(dict) –
UserProfileArn (string) –
The user profile Amazon Resource Name (ARN).
Exceptions