[ aws . sagemaker ]

update-app-image-config

Description

Updates the properties of an AppImageConfig.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-app-image-config
--app-image-config-name <value>
[--kernel-gateway-image-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

The name of the AppImageConfig to update.

--kernel-gateway-image-config (structure)

The new KernelGateway app to run on the image.

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 .

Shorthand Syntax:

KernelSpecs=[{Name=string,DisplayName=string},{Name=string,DisplayName=string}],FileSystemConfig={MountPath=string,DefaultUid=integer,DefaultGid=integer}

JSON Syntax:

{
  "KernelSpecs": [
    {
      "Name": "string",
      "DisplayName": "string"
    }
    ...
  ],
  "FileSystemConfig": {
    "MountPath": "string",
    "DefaultUid": integer,
    "DefaultGid": integer
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

AppImageConfigArn -> (string)

The Amazon Resource Name (ARN) for the AppImageConfig.