DescribeApp - Amazon SageMaker Service

DescribeApp

Describes the app.

Request Syntax

{ "AppName": "string", "AppType": "string", "DomainId": "string", "UserProfileName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AppName

The name of the app.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

AppType

The type of app.

Type: String

Valid Values: JupyterServer | KernelGateway | TensorBoard

Required: Yes

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Required: Yes

UserProfileName

The user profile name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "AppArn": "string", "AppName": "string", "AppType": "string", "CreationTime": number, "DomainId": "string", "FailureReason": "string", "LastHealthCheckTimestamp": number, "LastUserActivityTimestamp": number, "ResourceSpec": { "EnvironmentArn": "string", "InstanceType": "string" }, "Status": "string", "UserProfileName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppArn

The app's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app/.*

AppName

The name of the app.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

AppType

The type of app.

Type: String

Valid Values: JupyterServer | KernelGateway | TensorBoard

CreationTime

The creation time.

Type: Timestamp

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

FailureReason

The failure reason.

Type: String

Length Constraints: Maximum length of 1024.

LastHealthCheckTimestamp

The timestamp of the last health check.

Type: Timestamp

LastUserActivityTimestamp

The timestamp of the last user's activity.

Type: Timestamp

ResourceSpec

The instance type and quantity.

Type: ResourceSpec object

Status

The status.

Type: String

Valid Values: Deleted | Deleting | Failed | InService | Pending

UserProfileName

The user profile name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: