update_application¶
Operation¶
async
¶
update_application(input: UpdateApplicationInput, plugins: list[Plugin] | None = None) -> UpdateApplicationOutput
Updates an existing Amazon Q Business application.
Note
Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
Note:
An Amazon Q Apps service-linked role will be created if it's absent in
the Amazon Web Services account when QAppsConfiguration is enabled in
the request. For more information, see Using service-linked roles for Q
Apps.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateApplicationInput
|
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 |
|---|---|
UpdateApplicationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateApplicationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
attachments_configuration: AttachmentsConfiguration | None = None
An option to allow end users to upload files directly during chat.
class-attribute
instance-attribute
¶
auto_subscription_configuration: AutoSubscriptionConfiguration | None = None
An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
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
A name for the Amazon Q Business application.
class-attribute
instance-attribute
¶
identity_center_instance_arn: str | None = None
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for---or connecting to---your 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
An option to allow end users to create and use Amazon Q Apps in the web experience.
class-attribute
instance-attribute
¶
role_arn: str | None = None
An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
Output¶
dataclass
¶
Dataclass for UpdateApplicationOutput structure.