aws_sdk_sagemaker/client/

describe_app.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeApp`](crate::operation::describe_app::builders::DescribeAppFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_id(impl Into<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::set_domain_id):<br>required: **true**<br><p>The domain ID.</p><br>
    ///   - [`user_profile_name(impl Into<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::user_profile_name) / [`set_user_profile_name(Option<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::set_user_profile_name):<br>required: **false**<br><p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p><br>
    ///   - [`space_name(impl Into<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::space_name) / [`set_space_name(Option<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::set_space_name):<br>required: **false**<br><p>The name of the space.</p><br>
    ///   - [`app_type(AppType)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::app_type) / [`set_app_type(Option<AppType>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::set_app_type):<br>required: **true**<br><p>The type of app.</p><br>
    ///   - [`app_name(impl Into<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::app_name) / [`set_app_name(Option<String>)`](crate::operation::describe_app::builders::DescribeAppFluentBuilder::set_app_name):<br>required: **true**<br><p>The name of the app.</p><br>
    /// - On success, responds with [`DescribeAppOutput`](crate::operation::describe_app::DescribeAppOutput) with field(s):
    ///   - [`app_arn(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::app_arn): <p>The Amazon Resource Name (ARN) of the app.</p>
    ///   - [`app_type(Option<AppType>)`](crate::operation::describe_app::DescribeAppOutput::app_type): <p>The type of app.</p>
    ///   - [`app_name(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::app_name): <p>The name of the app.</p>
    ///   - [`domain_id(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::domain_id): <p>The domain ID.</p>
    ///   - [`user_profile_name(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::user_profile_name): <p>The user profile name.</p>
    ///   - [`space_name(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::space_name): <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>
    ///   - [`status(Option<AppStatus>)`](crate::operation::describe_app::DescribeAppOutput::status): <p>The status.</p>
    ///   - [`effective_trusted_identity_propagation_status(Option<FeatureStatus>)`](crate::operation::describe_app::DescribeAppOutput::effective_trusted_identity_propagation_status): <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(Option<bool>)`](crate::operation::describe_app::DescribeAppOutput::recovery_mode): <p>Indicates whether the application is launched in recovery mode.</p>
    ///   - [`last_health_check_timestamp(Option<DateTime>)`](crate::operation::describe_app::DescribeAppOutput::last_health_check_timestamp): <p>The timestamp of the last health check.</p>
    ///   - [`last_user_activity_timestamp(Option<DateTime>)`](crate::operation::describe_app::DescribeAppOutput::last_user_activity_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(Option<DateTime>)`](crate::operation::describe_app::DescribeAppOutput::creation_time): <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(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::failure_reason): <p>The failure reason.</p>
    ///   - [`resource_spec(Option<ResourceSpec>)`](crate::operation::describe_app::DescribeAppOutput::resource_spec): <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(Option<String>)`](crate::operation::describe_app::DescribeAppOutput::built_in_lifecycle_config_arn): <p>The lifecycle configuration that runs before the default lifecycle configuration</p>
    /// - On failure, responds with [`SdkError<DescribeAppError>`](crate::operation::describe_app::DescribeAppError)
    pub fn describe_app(&self) -> crate::operation::describe_app::builders::DescribeAppFluentBuilder {
        crate::operation::describe_app::builders::DescribeAppFluentBuilder::new(self.handle.clone())
    }
}