[ aws . sagemaker ]



Describes the app.

See also: AWS API Documentation


--domain-id <value>
[--user-profile-name <value>]
[--space-name <value>]
--app-type <value>
--app-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]


--domain-id (string)

The domain ID.

--user-profile-name (string)

The user profile name. If this value is not set, then SpaceName must be set.

--space-name (string)

The name of the space.

--app-type (string)

The type of app.

Possible values:

  • JupyterServer
  • KernelGateway
  • DetailedProfiler
  • TensorBoard
  • CodeEditor
  • JupyterLab
  • RStudioServerPro
  • RSessionGateway
  • Canvas

--app-name (string)

The name of the app.

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

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.


AppArn -> (string)

The Amazon Resource Name (ARN) of the app.

AppType -> (string)

The type of app.

AppName -> (string)

The name of the app.

DomainId -> (string)

The domain ID.

UserProfileName -> (string)

The user profile name.

SpaceName -> (string)

The name of the space. If this value is not set, then UserProfileName must be set.

Status -> (string)

The status.

LastHealthCheckTimestamp -> (timestamp)

The timestamp of the last health check.

LastUserActivityTimestamp -> (timestamp)

The timestamp of the last user’s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp .

CreationTime -> (timestamp)

The creation time of the application.


After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

FailureReason -> (string)

The failure reason.

ResourceSpec -> (structure)

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

SageMakerImageArn -> (string)

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn -> (string)

The ARN of the image version created on the instance.

SageMakerImageVersionAlias -> (string)

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

InstanceType -> (string)

The instance type that the image version runs on.


JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

LifecycleConfigArn -> (string)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.