Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
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"
}
]
},
"Tags": [
{
"Key": "string",
"Value": "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. Must be unique to your account.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- CodeEditorAppImageConfig
-
The
CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.Type: CodeEditorAppImageConfig object
Required: No
- JupyterLabAppImageConfig
-
The
JupyterLabAppImageConfig. You can only specify one image kernel in theAppImageConfigAPI. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.Type: JupyterLabAppImageConfig object
Required: No
- KernelGatewayImageConfig
-
The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
Type: KernelGatewayImageConfig object
Required: No
- Tags
-
A list of tags to apply to the AppImageConfig.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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 of the AppImageConfig.
Type: String
Length Constraints: 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.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
