[ aws . sagemaker ]

describe-app

Description

Describes the app.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-app
--domain-id <value>
--user-profile-name <value>
--app-type <value>
--app-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-id (string)

The domain ID.

--user-profile-name (string)

The user profile name.

--app-type (string)

The type of app.

Possible values:

• JupyterServer

• KernelGateway

• TensorBoard

• RStudioServerPro

• RSessionGateway

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

See ‘aws help’ for descriptions of global parameters.

Output

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.

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.

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.

InstanceType -> (string)

The instance type that the image version runs on.

Note

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.