UpdateAppImageConfig
Updates the properties of an AppImageConfig.
Request Syntax
{
"AppImageConfigName": "string",
"CodeEditorAppImageConfig": {
"ContainerConfig": {
"ContainerArguments": [ "string" ],
"ContainerEntrypoint": [ "string" ],
"ContainerEnvironmentVariables": {
"string" : "string"
}
},
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
}
},
"JupyterLabAppImageConfig": {
"ContainerConfig": {
"ContainerArguments": [ "string" ],
"ContainerEntrypoint": [ "string" ],
"ContainerEnvironmentVariables": {
"string" : "string"
}
},
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
}
},
"KernelGatewayImageConfig": {
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
},
"KernelSpecs": [
{
"DisplayName": "string",
"Name": "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.
- AppImageConfigName
-
The name of the AppImageConfig to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- CodeEditorAppImageConfig
-
The Code Editor app running on the image.
Type: CodeEditorAppImageConfig object
Required: No
- JupyterLabAppImageConfig
-
The JupyterLab app running on the image.
Type: JupyterLabAppImageConfig object
Required: No
- KernelGatewayImageConfig
-
The new KernelGateway app to run on the image.
Type: KernelGatewayImageConfig object
Required: No
Response Syntax
{
"AppImageConfigArn": "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.
- AppImageConfigArn
-
The ARN for the AppImageConfig.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app-image-config/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
