aws_sdk_sagemaker/client/describe_partner_app.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribePartnerApp`](crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`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>
7 /// - On success, responds with [`DescribePartnerAppOutput`](crate::operation::describe_partner_app::DescribePartnerAppOutput) with field(s):
8 /// - [`arn(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::arn): <p>The ARN of the SageMaker Partner AI App that was described.</p>
9 /// - [`name(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::name): <p>The name of the SageMaker Partner AI App.</p>
10 /// - [`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>
11 /// - [`status(Option<PartnerAppStatus>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::status): <p>The status of the SageMaker Partner AI App.</p>
12 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::creation_time): <p>The time that the SageMaker Partner AI App was created.</p>
13 /// - [`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>
14 /// - [`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>
15 /// - [`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>
16 /// - [`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>
17 /// - [`maintenance_config(Option<PartnerAppMaintenanceConfig>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::maintenance_config): <p>Maintenance configuration settings for the SageMaker Partner AI App.</p>
18 /// - [`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>
19 /// - [`version(Option<String>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::version): <p>The version of the SageMaker Partner AI App.</p>
20 /// - [`application_config(Option<PartnerAppConfig>)`](crate::operation::describe_partner_app::DescribePartnerAppOutput::application_config): <p>Configuration settings for the SageMaker Partner AI App.</p>
21 /// - [`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.</p>
22 /// - [`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>
23 /// - [`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>
24 /// - On failure, responds with [`SdkError<DescribePartnerAppError>`](crate::operation::describe_partner_app::DescribePartnerAppError)
25 pub fn describe_partner_app(&self) -> crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder {
26 crate::operation::describe_partner_app::builders::DescribePartnerAppFluentBuilder::new(self.handle.clone())
27 }
28}