Skip to content

Creates a configuration for running a SageMaker AI image as a KernelGateway app

Description

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.

Usage

sagemaker_create_app_image_config(AppImageConfigName, Tags,
  KernelGatewayImageConfig, JupyterLabAppImageConfig,
  CodeEditorAppImageConfig)

Arguments

  • AppImageConfigName

    [required] The name of the AppImageConfig. Must be unique to your account.

  • Tags

    A list of tags to apply to the AppImageConfig.

  • 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.

  • JupyterLabAppImageConfig

    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.

  • 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.

Value

A list with the following syntax:

list(
  AppImageConfigArn = "string"
)

Request syntax

svc$create_app_image_config(
  AppImageConfigName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  KernelGatewayImageConfig = list(
    KernelSpecs = list(
      list(
        Name = "string",
        DisplayName = "string"
      )
    ),
    FileSystemConfig = list(
      MountPath = "string",
      DefaultUid = 123,
      DefaultGid = 123
    )
  ),
  JupyterLabAppImageConfig = list(
    FileSystemConfig = list(
      MountPath = "string",
      DefaultUid = 123,
      DefaultGid = 123
    ),
    ContainerConfig = list(
      ContainerArguments = list(
        "string"
      ),
      ContainerEntrypoint = list(
        "string"
      ),
      ContainerEnvironmentVariables = list(
        "string"
      )
    )
  ),
  CodeEditorAppImageConfig = list(
    FileSystemConfig = list(
      MountPath = "string",
      DefaultUid = 123,
      DefaultGid = 123
    ),
    ContainerConfig = list(
      ContainerArguments = list(
        "string"
      ),
      ContainerEntrypoint = list(
        "string"
      ),
      ContainerEnvironmentVariables = list(
        "string"
      )
    )
  )
)