DescribeApp - Amazon SageMaker
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

DescribeApp

Describes the app.

Request Syntax

{
   "AppName": "string",
   "AppType": "string",
   "DomainId": "string",
   "SpaceName": "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]){0,62}

Required: Yes

AppType

The type of app.

Type: String

Valid Values: JupyterServer | KernelGateway

Required: Yes

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^d-(-*[a-z0-9]){1,61}

Required: Yes

SpaceName

The name of the space.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: No

UserProfileName

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

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: No

Response Syntax

{
   "AppArn": "string",
   "AppName": "string",
   "AppType": "string",
   "BuiltInLifecycleConfigArn": "string",
   "CreationTime": number,
   "DomainId": "string",
   "FailureReason": "string",
   "LastHealthCheckTimestamp": number,
   "LastUserActivityTimestamp": number,
   "ResourceSpec": { 
      "InstanceType": "string",
      "LifecycleConfigArn": "string",
      "SageMakerImageArn": "string",
      "SageMakerImageVersionAlias": "string",
      "SageMakerImageVersionArn": "string"
   },
   "SpaceName": "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 Amazon Resource Name (ARN) of the app.

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]){0,62}

AppType

The type of app.

Type: String

Valid Values: JupyterServer | KernelGateway

BuiltInLifecycleConfigArn

The lifecycle configuration that runs before the default lifecycle configuration

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$

CreationTime

The creation time of the application.

Note

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.

Type: Timestamp

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^d-(-*[a-z0-9]){1,61}

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

Type: Timestamp

ResourceSpec

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

Type: ResourceSpec object

SpaceName

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

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

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]){0,62}

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: