View a markdown version of this page

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: Minimum length of 0. 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: Minimum length of 0. Maximum length of 63.

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

Required: Yes

SpaceName

The name of the space.

Type: String

Length Constraints: Minimum length of 0. 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: Minimum length of 0. 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",
   "DomainId": "string",
   "EffectiveTrustedIdentityPropagationStatus": "string",
   "FailureReason": "string",
   "RecoveryMode": boolean,
   "ResourceSpec": { 
      "InstanceType": "string",
      "LifecycleConfigArn": "string",
      "SageMakerImageArn": "string",
      "SageMakerImageVersionAlias": "string",
      "SageMakerImageVersionArn": "string",
      "TrainingPlanArn": "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: Minimum length of 0. 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: Minimum length of 0. 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: Minimum length of 0. Maximum length of 256.

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

DomainId

The domain ID.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

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

EffectiveTrustedIdentityPropagationStatus

The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled AWS services. When disabled, standard IAM role-based access is used.

Type: String

Valid Values: ENABLED | DISABLED

FailureReason

The failure reason.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

RecoveryMode

Indicates whether the application is launched in recovery mode.

Type: Boolean

ResourceSpec

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI 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: Minimum length of 0. 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: Minimum length of 0. 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 Error Types.

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: