create_application¶
Operation¶
async
¶
create_application(input: CreateApplicationInput, plugins: list[Plugin] | None = None) -> CreateApplicationOutput
Creates an Amazon Q Business application.
Note
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
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.
When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateApplicationInput
|
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 |
|---|---|
CreateApplicationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateApplicationInput structure.
Attributes¶
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
¶
client_ids_for_oidc: list[str] | None = None
The OIDC client ID for a Amazon Q Business application.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token that you provide to identify the request to create your Amazon Q Business application.
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
¶
encryption_configuration: EncryptionConfiguration | None = None
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
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_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
¶
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
An option to allow end users to create and use Amazon Q Apps in the web experience.
class-attribute
instance-attribute
¶
quick_sight_configuration: QuickSightConfiguration | None = None
The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite for authentication. This configuration is required if your application uses Quick Suite as the identity provider. For more information, see Creating an Amazon Quick Suite integrated application.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = None
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Output¶
dataclass
¶
Dataclass for CreateApplicationOutput 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.