[ 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>]
[--cli-auto-prompt <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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

AppArn -> (string)

The app’s Amazon Resource Name (ARN).

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.

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 Amazon Resource Name (ARN) of the SageMaker image created on the instance.

InstanceType -> (string)

The instance type.