SageMaker / Client / describe_app

describe_app

SageMaker.Client.describe_app(**kwargs)

Describes the app.

See also: AWS API Documentation

Request Syntax

response = client.describe_app(
    DomainId='string',
    UserProfileName='string',
    SpaceName='string',
    AppType='JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'VSCode'|'Savitur'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSession'|'RSessionGateway'|'Canvas'|'DatasetManager'|'SageMakerLite'|'Local',
    AppName='string'
)

Parameters:

• DomainId (string) –

  [REQUIRED]

  The domain ID.

• UserProfileName (string) – The user profile name. If this value is not set, then SpaceName must be set.

• SpaceName (string) – The name of the space.

• AppType (string) –

  [REQUIRED]

  The type of app.

• AppName (string) –

  [REQUIRED]

  The name of the app.

Return type:

dict

Returns:

Response Syntax

{
    'AppArn': 'string',
    'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'VSCode'|'Savitur'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSession'|'RSessionGateway'|'Canvas'|'DatasetManager'|'SageMakerLite'|'Local',
    'AppName': 'string',
    'DomainId': 'string',
    'UserProfileName': 'string',
    'SpaceName': 'string',
    'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending',
    'LastHealthCheckTimestamp': datetime(2015, 1, 1),
    'LastUserActivityTimestamp': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'ResourceSpec': {
        'SageMakerImageArn': 'string',
        'SageMakerImageVersionArn': 'string',
        'SageMakerImageVersionAlias': 'string',
        'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
        'LifecycleConfigArn': 'string'
    }
}

Response Structure

• (dict) –

  • AppArn (string) –

    The Amazon Resource Name (ARN) of the app.

  • AppType (string) –

    The type of app.

  • AppName (string) –

    The name of the app.

  • DomainId (string) –

    The domain ID.

  • UserProfileName (string) –

    The user profile name.

  • SpaceName (string) –

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

  • Status (string) –

    The status.

  • LastHealthCheckTimestamp (datetime) –

    The timestamp of the last health check.

  • LastUserActivityTimestamp (datetime) –

    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.

  • CreationTime (datetime) –

    The creation time.

  • FailureReason (string) –

    The failure reason.

  • ResourceSpec (dict) –

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

    • SageMakerImageArn (string) –

      The ARN of the SageMaker image that the image version belongs to.

    • SageMakerImageVersionArn (string) –

      The ARN of the image version created on the instance.

    • SageMakerImageVersionAlias (string) –

      The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

    • InstanceType (string) –

      The instance type that the image version runs on.

      Note

      JupyterServer apps only support the system value.

      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

    • LifecycleConfigArn (string) –

      The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound