get_application¶
Operation¶
async
¶
get_application(input: GetApplicationInput, plugins: list[Plugin] | None = None) -> GetApplicationOutput
Gets information about an existing Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetApplicationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetApplicationOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetApplicationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_arn: str | None = None
The Amazon Resource Name (ARN) of the Amazon Q Business application.
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
attachments_configuration: AppliedAttachmentsConfiguration | None = None
Settings for whether end users can upload files directly during chat.
class-attribute
instance-attribute
¶
auto_subscription_configuration: AutoSubscriptionConfiguration | None = None
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
class-attribute
instance-attribute
¶
client_ids_for_oidc: list[str] | None = None
The OIDC client ID for a Amazon Q Business application.
class-attribute
instance-attribute
¶
created_at: datetime | None = None
The Unix timestamp when the Amazon Q Business application was last updated.
class-attribute
instance-attribute
¶
description: str | None = None
A description for the Amazon Q Business application.
class-attribute
instance-attribute
¶
display_name: str | None = None
The name of the Amazon Q Business application.
class-attribute
instance-attribute
¶
encryption_configuration: EncryptionConfiguration | None = None
The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
class-attribute
instance-attribute
¶
error: ErrorDetail | None = None
If the Status field is set to ERROR, the ErrorMessage field
contains a description of the error that caused the synchronization to
fail.
class-attribute
instance-attribute
¶
iam_identity_provider_arn: str | None = None
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
class-attribute
instance-attribute
¶
identity_center_application_arn: str | None = None
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
class-attribute
instance-attribute
¶
identity_type: IdentityType | None = None
The authentication type being used by a Amazon Q Business application.
class-attribute
instance-attribute
¶
personalization_configuration: PersonalizationConfiguration | None = None
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
class-attribute
instance-attribute
¶
q_apps_configuration: QAppsConfiguration | None = None
Settings for whether end users can create and use Amazon Q Apps in the web experience.
class-attribute
instance-attribute
¶
quick_sight_configuration: QuickSightConfiguration | None = None
The Amazon Quick Suite authentication configuration for the Amazon Q Business application.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
class-attribute
instance-attribute
¶
status: ApplicationStatus | None = None
The status of the Amazon Q Business application.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The Unix timestamp when the Amazon Q Business application was last updated.