update_application¶
Operation¶
update_application
¶
update_application(request: UpdateApplicationInput | UpdateApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateApplicationInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateApplicationInput | UpdateApplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateApplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateApplicationOutput
|
An instance of |
update_application
async
¶
update_application(request: UpdateApplicationInput | UpdateApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateApplicationInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateApplicationInput | UpdateApplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateApplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateApplicationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateApplicationInputDict
¶
Bases: TypedDict
Dictionary form of UpdateApplicationInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the Amazon Q Business application.
attachments_configuration
instance-attribute
¶
attachments_configuration: AttachmentsConfiguration | AttachmentsConfigurationDict | None
An option to allow end users to upload files directly during chat.
auto_subscription_configuration
instance-attribute
¶
auto_subscription_configuration: AutoSubscriptionConfiguration | AutoSubscriptionConfigurationDict | None
An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
description
instance-attribute
¶
description: str | None
A description for the Amazon Q Business application.
display_name
instance-attribute
¶
display_name: str | None
A name for the Amazon Q Business application.
identity_center_instance_arn
instance-attribute
¶
identity_center_instance_arn: str | 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.
personalization_configuration
instance-attribute
¶
personalization_configuration: PersonalizationConfiguration | PersonalizationConfigurationDict | None
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
q_apps_configuration
instance-attribute
¶
q_apps_configuration: QAppsConfiguration | QAppsConfigurationDict | None
An option to allow end users to create and use Amazon Q Apps in the web experience.
UpdateApplicationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateApplicationInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application.
attachments_configuration
class-attribute
instance-attribute
¶
attachments_configuration: AttachmentsConfiguration | None = ...
An option to allow end users to upload files directly during chat.
auto_subscription_configuration
class-attribute
instance-attribute
¶
auto_subscription_configuration: AutoSubscriptionConfiguration | None = ...
An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the Amazon Q Business application.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
A name for the Amazon Q Business application.
identity_center_instance_arn
class-attribute
instance-attribute
¶
identity_center_instance_arn: str | 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.
personalization_configuration
class-attribute
instance-attribute
¶
personalization_configuration: PersonalizationConfiguration | None = ...
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
q_apps_configuration
class-attribute
instance-attribute
¶
q_apps_configuration: QAppsConfiguration | None = ...
An option to allow end users to create and use Amazon Q Apps in the web experience.
Output¶
UpdateApplicationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateApplicationOutput structure.