aws-sdk-sagemaker 1.225.0

AWS SDK for Amazon SageMaker Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribePartnerApp`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`arn(impl Into<String>)`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::set_arn):<br>required: **true**<br><p>The ARN of the SageMaker Partner AI App to describe.</p><br>
    ///   - [`include_available_upgrade(bool)`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::include_available_upgrade) / [`set_include_available_upgrade(Option<bool>)`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::set_include_available_upgrade):<br>required: **false**<br><p>When set to <code>TRUE</code>, the response includes available upgrade information for the SageMaker Partner AI App. Default is <code>FALSE</code>.</p><br>
    /// - On success, responds with [`DescribePartnerAppOutput`](crate::operation::describe_partner_app::DescribePartnerAppOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::arn): <p>The ARN of the SageMaker Partner AI App that was described.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::name): <p>The name of the SageMaker Partner AI App.</p>
    ///   - [`r#type(Option<PartnerAppType>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::type): <p>The type of SageMaker Partner AI App. Must be one of the following: <code>lakera-guard</code>, <code>comet</code>, <code>deepchecks-llm-evaluation</code>, or <code>fiddler</code>.</p>
    ///   - [`status(Option<PartnerAppStatus>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::status): <p>The status of the SageMaker Partner AI App.</p> <ul>  <li>   <p>Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.</p></li>  <li>   <p>Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.</p></li>  <li>   <p>Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.</p></li>  <li>   <p>Available: The partner AI app is provisioned and accessible.</p></li>  <li>   <p>Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.</p></li>  <li>   <p>UpdateFailed: The partner AI app couldn't be updated but is available.</p></li>  <li>   <p>Deleted: The partner AI app is permanently deleted and not available.</p></li> </ul>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::creation_time): <p>The time that the SageMaker Partner AI App was created.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::last_modified_time): <p>The time that the SageMaker Partner AI App was last modified.</p>
    ///   - [`execution_role_arn(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::execution_role_arn): <p>The ARN of the IAM role associated with the SageMaker Partner AI App.</p>
    ///   - [`kms_key_id(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::kms_key_id): <p>The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.</p>
    ///   - [`base_url(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::base_url): <p>The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.</p>
    ///   - [`maintenance_config(Option<PartnerAppMaintenanceConfig>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::maintenance_config): <p>Maintenance configuration settings for the SageMaker Partner AI App.</p>
    ///   - [`tier(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::tier): <p>The instance type and size of the cluster attached to the SageMaker Partner AI App.</p>
    ///   - [`version(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::version): <p>The version of the SageMaker Partner AI App.</p>
    ///   - [`application_config(Option<PartnerAppConfig>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::application_config): <p>Configuration settings for the SageMaker Partner AI App.</p>
    ///   - [`auth_type(Option<PartnerAppAuthType>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::auth_type): <p>The authorization type that users use to access the SageMaker Partner AI App. Valid values:</p> <ul>  <li>   <p><code>IAM</code>: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.</p></li>  <li>   <p><code>IDC</code>: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity.</p></li> </ul>
    ///   - [`enable_iam_session_based_identity(Option<bool>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::enable_iam_session_based_identity): <p>When set to <code>TRUE</code>, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.</p>
    ///   - [`error(Option<ErrorInfo>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::error): <p>This is an error field object that contains the error code and the reason for an operation failure.</p>
    ///   - [`enable_auto_minor_version_upgrade(Option<bool>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::enable_auto_minor_version_upgrade): <p>Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.</p>
    ///   - [`current_version_eol_date(Option<DateTime>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::current_version_eol_date): <p>The end-of-life date for the current version of the SageMaker Partner AI App.</p>
    ///   - [`available_upgrade(Option<AvailableUpgrade>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::available_upgrade): <p>A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.</p>
    ///   - [`idc_config(Option<IdcConfigOutput>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::idc_config): <p>Contains the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App, including the Identity Center instance and the Identity Center application that SageMaker creates for the app. The service returns this field for apps that use <code>IDC</code> authorization.</p>
    /// - On failure, responds with [`SdkError<DescribePartnerAppError>`](crate::operation::describe_partner_app::DescribePartnerAppError)
    pub fn describe_partner_app(&self) -> crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder {
        crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::new(self.handle.clone())
    }
}