AWS CLI Command Reference

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 ]

update-app-image-config

Description

Updates the properties of an AppImageConfig.

See also: AWS API Documentation

Synopsis

  update-app-image-config
--app-image-config-name <value>
[--kernel-gateway-image-config <value>]
[--jupyter-lab-app-image-config <value>]
[--code-editor-app-image-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 storage configuration for a SageMaker AI 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
  }
}

--jupyter-lab-app-image-config (structure)

The JupyterLab app running on the image.

FileSystemConfig -> (structure)

The Amazon Elastic File System storage configuration for a SageMaker AI 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 .

ContainerConfig -> (structure)

The configuration used to run the application image container.

ContainerArguments -> (list)

The arguments for the container when you're running the application.

(string)

ContainerEntrypoint -> (list)

The entrypoint used to run the application in the container.

(string)

ContainerEnvironmentVariables -> (map)

The environment variables to set in the container

key -> (string)

value -> (string)

Shorthand Syntax:

FileSystemConfig={MountPath=string,DefaultUid=integer,DefaultGid=integer},ContainerConfig={ContainerArguments=[string,string],ContainerEntrypoint=[string,string],ContainerEnvironmentVariables={KeyName1=string,KeyName2=string}}

JSON Syntax:

{
  "FileSystemConfig": {
    "MountPath": "string",
    "DefaultUid": integer,
    "DefaultGid": integer
  },
  "ContainerConfig": {
    "ContainerArguments": ["string", ...],
    "ContainerEntrypoint": ["string", ...],
    "ContainerEnvironmentVariables": {"string": "string"
      ...}
  }
}

--code-editor-app-image-config (structure)

The Code Editor app running on the image.

FileSystemConfig -> (structure)

The Amazon Elastic File System storage configuration for a SageMaker AI 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 .

ContainerConfig -> (structure)

The configuration used to run the application image container.

ContainerArguments -> (list)

The arguments for the container when you're running the application.

(string)

ContainerEntrypoint -> (list)

The entrypoint used to run the application in the container.

(string)

ContainerEnvironmentVariables -> (map)

The environment variables to set in the container

key -> (string)

value -> (string)

Shorthand Syntax:

FileSystemConfig={MountPath=string,DefaultUid=integer,DefaultGid=integer},ContainerConfig={ContainerArguments=[string,string],ContainerEntrypoint=[string,string],ContainerEnvironmentVariables={KeyName1=string,KeyName2=string}}

JSON Syntax:

{
  "FileSystemConfig": {
    "MountPath": "string",
    "DefaultUid": integer,
    "DefaultGid": integer
  },
  "ContainerConfig": {
    "ContainerArguments": ["string", ...],
    "ContainerEntrypoint": ["string", ...],
    "ContainerEnvironmentVariables": {"string": "string"
      ...}
  }
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

AppImageConfigArn -> (string)

The ARN for the AppImageConfig.