Skip to content

DescribeAppResponse

Source code in docs_src/capo_sagemaker/types/describe_app_response.py
class DescribeAppResponse(TypedDict, closed=True):
    app_arn: NotRequired["capo_sagemaker.types.app_arn.AppArn"]
    """<p>The Amazon Resource Name (ARN) of the app.</p>"""
    app_type: NotRequired["capo_sagemaker.types.app_type.AppType"]
    """<p>The type of app.</p>"""
    app_name: NotRequired["capo_sagemaker.types.app_name.AppName"]
    """<p>The name of the app.</p>"""
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The domain ID.</p>"""
    user_profile_name: NotRequired[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ]
    """<p>The user profile name.</p>"""
    space_name: NotRequired["capo_sagemaker.types.space_name.SpaceName"]
    """<p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>"""
    status: NotRequired["capo_sagemaker.types.app_status.AppStatus"]
    """<p>The status.</p>"""
    effective_trusted_identity_propagation_status: NotRequired[
        "capo_sagemaker.types.feature_status.FeatureStatus"
    ]
    """<p>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 Amazon Web Services services. When disabled, standard IAM role-based access is used. </p>"""
    recovery_mode: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p> Indicates whether the application is launched in recovery mode. </p>"""
    last_health_check_timestamp: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The timestamp of the last health check.</p>"""
    last_user_activity_timestamp: NotRequired[
        "capo_sagemaker.types.timestamp.Timestamp"
    ]
    """<p>The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as <code>LastHealthCheckTimestamp</code>.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The creation time of the application.</p> <note> <p>After an application has been shut down for 24 hours, SageMaker AI 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.</p> </note>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The failure reason.</p>"""
    resource_spec: NotRequired["capo_sagemaker.types.resource_spec.ResourceSpec"]
    """<p>The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.</p>"""
    built_in_lifecycle_config_arn: NotRequired[
        "capo_sagemaker.types.studio_lifecycle_config_arn.StudioLifecycleConfigArn"
    ]
    """<p>The lifecycle configuration that runs before the default lifecycle configuration</p>"""

app_arn instance-attribute

app_arn: NotRequired[AppArn]

The Amazon Resource Name (ARN) of the app.

app_name instance-attribute

app_name: NotRequired[AppName]

The name of the app.

app_type instance-attribute

app_type: NotRequired[AppType]

The type of app.

built_in_lifecycle_config_arn instance-attribute

built_in_lifecycle_config_arn: NotRequired[StudioLifecycleConfigArn]

The lifecycle configuration that runs before the default lifecycle configuration

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker AI 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.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The domain ID.

effective_trusted_identity_propagation_status instance-attribute

effective_trusted_identity_propagation_status: NotRequired[FeatureStatus]

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 Amazon Web Services services. When disabled, standard IAM role-based access is used.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The failure reason.

last_health_check_timestamp instance-attribute

last_health_check_timestamp: NotRequired[Timestamp]

The timestamp of the last health check.

last_user_activity_timestamp instance-attribute

last_user_activity_timestamp: NotRequired[Timestamp]

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

recovery_mode instance-attribute

recovery_mode: NotRequired[Boolean]

Indicates whether the application is launched in recovery mode.

resource_spec instance-attribute

resource_spec: NotRequired[ResourceSpec]

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

space_name instance-attribute

space_name: NotRequired[SpaceName]

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

status instance-attribute

status: NotRequired[AppStatus]

The status.

user_profile_name instance-attribute

user_profile_name: NotRequired[UserProfileName]

The user profile name.