app_image_configs

Creates, updates, deletes, gets or lists an app_image_configs resource.

Overview

Name	app_image_configs
Type	Resource
Id	aws.sagemaker.app_image_configs

Fields

The following fields are returned by SELECT queries:

describe_app_image_config

Name	Datatype	Description
app_image_config_arn	string	The ARN of the AppImageConfig. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:app-image-config/.*</code>)
app_image_config_name	string	The name of the AppImageConfig. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
code_editor_app_image_config	object	The configuration of the Code Editor app.
creation_time	string (date-time)	When the AppImageConfig was created.
jupyter_lab_app_image_config	object	The configuration of the JupyterLab app.
kernel_gateway_image_config	object	The configuration of a KernelGateway app.
last_modified_time	string (date-time)	When the AppImageConfig was last modified.

list_app_image_configs

Name	Datatype	Description
app_image_config_arn	string	The ARN of the AppImageConfig. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:app-image-config/.*</code>)
app_image_config_name	string	The name of the AppImageConfig. Must be unique to your account. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
code_editor_app_image_config	object	The configuration for the file system and the runtime, such as the environment variables and entry point.
creation_time	string (date-time)	When the AppImageConfig was created.
jupyter_lab_app_image_config	object	The configuration for the file system and the runtime, such as the environment variables and entry point.
kernel_gateway_image_config	object	The configuration for the file system and kernels in the SageMaker AI image.
last_modified_time	string (date-time)	When the AppImageConfig was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_image_config	select	region		Describes an AppImageConfig.
list_app_image_configs	select	region		Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
create_app_image_config	insert	region, AppImageConfigName		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.
update_app_image_config	update	region, AppImageConfigName		Updates the properties of an AppImageConfig.
delete_app_image_config	delete	region		Deletes an AppImageConfig.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_app_image_config

Describes an AppImageConfig.

SELECT
app_image_config_arn,
app_image_config_name,
code_editor_app_image_config,
creation_time,
jupyter_lab_app_image_config,
kernel_gateway_image_config,
last_modified_time
FROM aws.sagemaker.app_image_configs
WHERE region = '{{ region }}' -- required
;

list_app_image_configs

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

SELECT
app_image_config_arn,
app_image_config_name,
code_editor_app_image_config,
creation_time,
jupyter_lab_app_image_config,
kernel_gateway_image_config,
last_modified_time
FROM aws.sagemaker.app_image_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_app_image_config

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.

INSERT INTO aws.sagemaker.app_image_configs (
AppImageConfigName,
Tags,
KernelGatewayImageConfig,
JupyterLabAppImageConfig,
CodeEditorAppImageConfig,
region
)
SELECT 
'{{ AppImageConfigName }}' /* required */,
'{{ Tags }}',
'{{ KernelGatewayImageConfig }}',
'{{ JupyterLabAppImageConfig }}',
'{{ CodeEditorAppImageConfig }}',
'{{ region }}'
RETURNING
app_image_config_arn
;

Manifest

# Description fields are for documentation purposes
- name: app_image_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_image_configs resource.
  - name: AppImageConfigName
    value: "{{ AppImageConfigName }}"
    description: |
      The name of the AppImageConfig. Must be unique to your account.
  - name: Tags
    description: |
      A list of tags to apply to the AppImageConfig.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: KernelGatewayImageConfig
    description: |
      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.
    value:
      KernelSpecs:
        - Name: "{{ Name }}"
          DisplayName: "{{ DisplayName }}"
      FileSystemConfig:
        MountPath: "{{ MountPath }}"
        DefaultUid: {{ DefaultUid }}
        DefaultGid: {{ DefaultGid }}
  - name: JupyterLabAppImageConfig
    description: |
      The JupyterLabAppImageConfig. 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 JupyterLab.
    value:
      FileSystemConfig:
        MountPath: "{{ MountPath }}"
        DefaultUid: {{ DefaultUid }}
        DefaultGid: {{ DefaultGid }}
      ContainerConfig:
        ContainerArguments:
          - "{{ ContainerArguments }}"
        ContainerEntrypoint:
          - "{{ ContainerEntrypoint }}"
        ContainerEnvironmentVariables: "{{ ContainerEnvironmentVariables }}"
  - name: CodeEditorAppImageConfig
    description: |
      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.
    value:
      FileSystemConfig:
        MountPath: "{{ MountPath }}"
        DefaultUid: {{ DefaultUid }}
        DefaultGid: {{ DefaultGid }}
      ContainerConfig:
        ContainerArguments:
          - "{{ ContainerArguments }}"
        ContainerEntrypoint:
          - "{{ ContainerEntrypoint }}"
        ContainerEnvironmentVariables: "{{ ContainerEnvironmentVariables }}"

UPDATE examples

update_app_image_config

Updates the properties of an AppImageConfig.

UPDATE aws.sagemaker.app_image_configs
SET 
AppImageConfigName = '{{ AppImageConfigName }}',
KernelGatewayImageConfig = '{{ KernelGatewayImageConfig }}',
JupyterLabAppImageConfig = '{{ JupyterLabAppImageConfig }}',
CodeEditorAppImageConfig = '{{ CodeEditorAppImageConfig }}'
WHERE 
region = '{{ region }}' --required
AND AppImageConfigName = '{{ AppImageConfigName }}' --required
RETURNING
app_image_config_arn;

DELETE examples

delete_app_image_config

Deletes an AppImageConfig.

DELETE FROM aws.sagemaker.app_image_configs
WHERE region = '{{ region }}' --required
;