DescribePartnerAppResponse
¶
Source code in docs_src/capo_sagemaker/types/describe_partner_app_response.py
application_config
instance-attribute
¶
application_config: NotRequired[PartnerAppConfig]
Configuration settings for the SageMaker Partner AI App.
arn
instance-attribute
¶
arn: NotRequired[PartnerAppArn]
The ARN of the SageMaker Partner AI App that was described.
auth_type
instance-attribute
¶
auth_type: NotRequired[PartnerAppAuthType]
The authorization type that users use to access the SageMaker Partner AI App. Valid values:
-
IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity. -
IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity.
available_upgrade
instance-attribute
¶
available_upgrade: NotRequired[AvailableUpgrade]
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.
base_url
instance-attribute
¶
base_url: NotRequired[String2048]
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
creation_time
instance-attribute
¶
creation_time: NotRequired[Timestamp]
The time that the SageMaker Partner AI App was created.
current_version_eol_date
instance-attribute
¶
current_version_eol_date: NotRequired[Timestamp]
The end-of-life date for the current version of the SageMaker Partner AI App.
enable_auto_minor_version_upgrade
instance-attribute
¶
enable_auto_minor_version_upgrade: NotRequired[Boolean]
Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
enable_iam_session_based_identity
instance-attribute
¶
enable_iam_session_based_identity: NotRequired[Boolean]
When set to TRUE, 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.
error
instance-attribute
¶
error: NotRequired[ErrorInfo]
This is an error field object that contains the error code and the reason for an operation failure.
execution_role_arn
instance-attribute
¶
execution_role_arn: NotRequired[RoleArn]
The ARN of the IAM role associated with the SageMaker Partner AI App.
idc_config
instance-attribute
¶
idc_config: NotRequired[IdcConfigOutput]
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 IDC authorization.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[KmsKeyId]
The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
last_modified_time
instance-attribute
¶
last_modified_time: NotRequired[Timestamp]
The time that the SageMaker Partner AI App was last modified.
maintenance_config
instance-attribute
¶
maintenance_config: NotRequired[PartnerAppMaintenanceConfig]
Maintenance configuration settings for the SageMaker Partner AI App.
name
instance-attribute
¶
name: NotRequired[PartnerAppName]
The name of the SageMaker Partner AI App.
status
instance-attribute
¶
status: NotRequired[PartnerAppStatus]
The status of the SageMaker Partner AI App.
-
Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.
-
Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.
-
Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.
-
Available: The partner AI app is provisioned and accessible.
-
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.
-
UpdateFailed: The partner AI app couldn't be updated but is available.
-
Deleted: The partner AI app is permanently deleted and not available.
tier
instance-attribute
¶
tier: NotRequired[NonEmptyString64]
The instance type and size of the cluster attached to the SageMaker Partner AI App.
type
instance-attribute
¶
type: NotRequired[PartnerAppType]
The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
version
instance-attribute
¶
version: NotRequired[NonEmptyString64]
The version of the SageMaker Partner AI App.