describe_app_image_config

describe_app_image_config(**kwargs)

Describes an AppImageConfig.

See also: AWS API Documentation

Request Syntax

response = client.describe_app_image_config(
    AppImageConfigName='string'
)
Parameters
AppImageConfigName (string) --

[REQUIRED]

The name of the AppImageConfig to describe.

Return type
dict
Returns
Response Syntax
{
    'AppImageConfigArn': 'string',
    'AppImageConfigName': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'KernelGatewayImageConfig': {
        'KernelSpecs': [
            {
                'Name': 'string',
                'DisplayName': 'string'
            },
        ],
        'FileSystemConfig': {
            'MountPath': 'string',
            'DefaultUid': 123,
            'DefaultGid': 123
        }
    }
}

Response Structure

  • (dict) --
    • AppImageConfigArn (string) --

      The Amazon Resource Name (ARN) of the AppImageConfig.

    • AppImageConfigName (string) --

      The name of the AppImageConfig.

    • CreationTime (datetime) --

      When the AppImageConfig was created.

    • LastModifiedTime (datetime) --

      When the AppImageConfig was last modified.

    • KernelGatewayImageConfig (dict) --

      The configuration of a KernelGateway app.

      • KernelSpecs (list) --

        The specification of the Jupyter kernels in the image.

        • (dict) --

          The specification of a Jupyter kernel.

          • Name (string) --

            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 .

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound