update_app_image_config

SageMaker.Client.update_app_image_config(**kwargs)

Updates the properties of an AppImageConfig.

See also: AWS API Documentation

Request Syntax

response = client.update_app_image_config(
    AppImageConfigName='string',
    KernelGatewayImageConfig={
        'KernelSpecs': [
            {
                'Name': 'string',
                'DisplayName': 'string'
            },
        ],
        'FileSystemConfig': {
            'MountPath': 'string',
            'DefaultUid': 123,
            'DefaultGid': 123
        }
    }
)

Parameters

• AppImageConfigName (string) --

  [REQUIRED]

  The name of the AppImageConfig to update.

• KernelGatewayImageConfig (dict) --

  The new KernelGateway app to run on the image.

  • KernelSpecs (list) -- [REQUIRED]

    The specification of the Jupyter kernels in the image.

    • (dict) --

      The specification of a Jupyter kernel.

      • Name (string) -- [REQUIRED]

        The name of the Jupyter kernel in the image. This value is case sensitive.

      • DisplayName (string) --

        The display name of the kernel.

  • FileSystemConfig (dict) --

    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

    • MountPath (string) --

      The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .

    • DefaultUid (integer) --

      The default POSIX user ID (UID). If not specified, defaults to 1000 .

    • DefaultGid (integer) --

      The default POSIX group ID (GID). If not specified, defaults to 100 .

Return type

dict

Returns

Response Syntax

{
    'AppImageConfigArn': 'string'
}

Response Structure

• (dict) --

  • AppImageConfigArn (string) --

    The Amazon Resource Name (ARN) for the AppImageConfig.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound