Describes the app.
post/#X-Amz-Target=SageMaker.DescribeApp
Headers
X-Amz-Target'SageMaker.DescribeApp' required
Request body
DomainIdstring required
The domain ID.
UserProfileNamestring
The user profile name. If this value is not set, then <code>SpaceName</code> must be set.
AppType'JupyterServer' | 'KernelGateway' | 'TensorBoard' | 'RStudioServerPro' | 'RSessionGateway' required
The type of app.
AppNamestring required
The name of the app.
SpaceNamestring
The name of the space.
Response
Success
AppArnstring
The Amazon Resource Name (ARN) of the app.
AppType'JupyterServer' | 'KernelGateway' | 'TensorBoard' | 'RStudioServerPro' | 'RSessionGateway'
The type of app.
AppNamestring
The name of the app.
DomainIdstring
The domain ID.
UserProfileNamestring
The user profile name.
Status'Deleted' | 'Deleting' | 'Failed' | 'InService' | 'Pending'
The status.
LastHealthCheckTimestampstring date-time
The timestamp of the last health check.
LastUserActivityTimestampstring date-time
The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as <code>LastHealthCheckTimestamp</code>.
CreationTimestring date-time
The creation time.
FailureReasonstring
The failure reason.
SpaceNamestring
The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.