Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-app-image-config

Description

Describes an AppImageConfig.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-app-image-config
--app-image-config-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-image-config-name (string)

The name of the AppImageConfig to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AppImageConfigArn -> (string)

The Amazon Resource Name (ARN) of the AppImageConfig.

AppImageConfigName -> (string)

The name of the AppImageConfig.

CreationTime -> (timestamp)

When the AppImageConfig was created.

LastModifiedTime -> (timestamp)

When the AppImageConfig was last modified.

KernelGatewayImageConfig -> (structure)

The configuration of a KernelGateway app.

KernelSpecs -> (list)

The specification of the Jupyter kernels in the image.

(structure)

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 -> (structure)

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 .