UpdateDomain
Updates the default settings for new user profiles in the domain.
Request Syntax
{
"AppSecurityGroupManagement": "string
",
"DefaultSpaceSettings": {
"ExecutionRole": "string
",
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"SecurityGroups": [ "string
" ]
},
"DefaultUserSettings": {
"CanvasAppSettings": {
"DirectDeploySettings": {
"Status": "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
"
}
},
"ExecutionRole": "string
",
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string
"
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
},
"LifecycleConfigArns": [ "string
" ]
},
"RSessionAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string
",
"ImageName": "string
",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
}
},
"RStudioServerProAppSettings": {
"AccessStatus": "string
",
"UserGroup": "string
"
},
"SecurityGroups": [ "string
" ],
"SharingSettings": {
"NotebookOutputOption": "string
",
"S3KmsKeyId": "string
",
"S3OutputPath": "string
"
},
"TensorBoardAppSettings": {
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
}
}
},
"DomainId": "string
",
"DomainSettingsForUpdate": {
"ExecutionRoleIdentityConfig": "string
",
"RStudioServerProDomainSettingsForUpdate": {
"DefaultResourceSpec": {
"InstanceType": "string
",
"LifecycleConfigArn": "string
",
"SageMakerImageArn": "string
",
"SageMakerImageVersionArn": "string
"
},
"DomainExecutionRoleArn": "string
",
"RStudioConnectUrl": "string
",
"RStudioPackageManagerUrl": "string
"
},
"SecurityGroupIds": [ "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.
- 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 used to create a space within 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.
Required: Yes
- DomainSettingsForUpdate
-
A collection of
DomainSettings
configuration values to update.Type: DomainSettingsForUpdate object
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 AWS SDKs, see the following: