UpdateDomain
Updates the default settings for new user profiles in the domain.
Request Syntax
{
"AppNetworkAccessType": "string
",
"AppSecurityGroupManagement": "string
",
"DefaultSpaceSettings": {
"CustomFileSystemConfigs": [
{ ... }
],
"CustomPosixUserConfig": {
"Gid": number
,
"Uid": number
},
"ExecutionRole": "string
",
"JupyterLabAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number
,
"LifecycleManagement": "string
",
"MaxIdleTimeoutInMinutes": number
,
"MinIdleTimeoutInMinutes": number
}
},
"BuiltInLifecycleConfigArn": "string
",
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"EmrSettings": {
"AssumableRoleArns": [ "string
" ],
"ExecutionRoleArns": [ "string
" ]
},
"LifecycleConfigArns": [ "string
" ]
},
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"SecurityGroups": [ "string
" ],
"SpaceStorageSettings": {
"DefaultEbsStorageSettings": {
"DefaultEbsVolumeSizeInGb": number
,
"MaximumEbsVolumeSizeInGb": number
}
}
},
"DefaultUserSettings": {
"AutoMountHomeEFS": "string
",
"CanvasAppSettings": {
"DirectDeploySettings": {
"Status": "string
"
},
"EmrServerlessSettings": {
"ExecutionRoleArn": "string
",
"Status": "string
"
},
"GenerativeAiSettings": {
"AmazonBedrockRoleArn": "string
"
},
"IdentityProviderOAuthSettings": [
{
"DataSourceName": "string
",
"SecretArn": "string
",
"Status": "string
"
}
],
"KendraSettings": {
"Status": "string
"
},
"ModelRegisterSettings": {
"CrossAccountModelRegisterRoleArn": "string
",
"Status": "string
"
},
"TimeSeriesForecastingSettings": {
"AmazonForecastRoleArn": "string
",
"Status": "string
"
},
"WorkspaceSettings": {
"S3ArtifactPath": "string
",
"S3KmsKeyId": "string
"
}
},
"CodeEditorAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number
,
"LifecycleManagement": "string
",
"MaxIdleTimeoutInMinutes": number
,
"MinIdleTimeoutInMinutes": number
}
},
"BuiltInLifecycleConfigArn": "string
",
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"CustomFileSystemConfigs": [
{ ... }
],
"CustomPosixUserConfig": {
"Gid": number
,
"Uid": number
},
"DefaultLandingUri": "string
",
"ExecutionRole": "string
",
"JupyterLabAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number
,
"LifecycleManagement": "string
",
"MaxIdleTimeoutInMinutes": number
,
"MinIdleTimeoutInMinutes": number
}
},
"BuiltInLifecycleConfigArn": "string
",
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"EmrSettings": {
"AssumableRoleArns": [ "string
" ],
"ExecutionRoleArns": [ "string
" ]
},
"LifecycleConfigArns": [ "string
" ]
},
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"RSessionAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
}
},
"RStudioServerProAppSettings": {
"AccessStatus": "string
",
"UserGroup": "string
"
},
"SecurityGroups": [ "string
" ],
"SharingSettings": {
"NotebookOutputOption": "string
",
"S3KmsKeyId": "string
",
"S3OutputPath": "string
"
},
"SpaceStorageSettings": {
"DefaultEbsStorageSettings": {
"DefaultEbsVolumeSizeInGb": number
,
"MaximumEbsVolumeSizeInGb": number
}
},
"StudioWebPortal": "string
",
"StudioWebPortalSettings": {
"HiddenAppTypes": [ "string
" ],
"HiddenInstanceTypes": [ "string
" ],
"HiddenMlTools": [ "string
" ],
"HiddenSageMakerImageVersionAliases": [
{
"SageMakerImageName": "string
",
"VersionAliases": [ "string
" ]
}
]
},
"TensorBoardAppSettings": {
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
}
}
},
"DomainId": "string
",
"DomainSettingsForUpdate": {
"AmazonQSettings": {
"QProfileArn": "string
",
"Status": "string
"
},
"DockerSettings": {
"EnableDockerAccess": "string
",
"VpcOnlyTrustedAccounts": [ "string
" ]
},
"ExecutionRoleIdentityConfig": "string
",
"RStudioServerProDomainSettingsForUpdate": {
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionAlias": "string
",
"SageMakerImageVersionArn": "string
"
},
"DomainExecutionRoleArn": "string
",
"RStudioConnectUrl": "string
",
"RStudioPackageManagerUrl": "string
"
},
"SecurityGroupIds": [ "string
" ]
},
"SubnetIds": [ "string
" ],
"TagPropagation": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AppNetworkAccessType
-
Specifies the VPC used for non-EFS traffic.
-
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access. -
VpcOnly
- All Studio traffic is through the specified VPC and subnets.
This configuration can only be modified if there are no apps in the
InService
,Pending
, orDeleting
state. The configuration cannot be updated ifDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is already set orDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided as part of the same request.Type: String
Valid Values:
PublicInternetOnly | VpcOnly
Required: No
-
- AppSecurityGroupManagement
-
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.Type: String
Valid Values:
Service | Customer
Required: No
- DefaultSpaceSettings
-
The default settings for shared spaces that users create in the domain.
Type: DefaultSpaceSettings object
Required: No
- DefaultUserSettings
-
A collection of settings.
Type: UserSettings object
Required: No
- DomainId
-
The ID of the domain to be updated.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^d-(-*[a-z0-9]){1,61}
Required: Yes
- DomainSettingsForUpdate
-
A collection of
DomainSettings
configuration values to update.Type: DomainSettingsForUpdate object
Required: No
- SubnetIds
-
The VPC subnets that Studio uses for communication.
If removing subnets, ensure there are no apps in the
InService
,Pending
, orDeleting
state.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 16 items.
Length Constraints: Maximum length of 32.
Pattern:
[-0-9a-zA-Z]+
Required: No
- TagPropagation
-
Indicates whether custom tag propagation is supported for the domain. Defaults to
DISABLED
.Type: String
Valid Values:
ENABLED | DISABLED
Required: No
Response Syntax
{
"DomainArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DomainArn
-
The Amazon Resource Name (ARN) of the domain.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:domain/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: