CreateApplicationRequest
¶
Source code in docs_src/capo_qbusiness/types/create_application_request.py
attachments_configuration
instance-attribute
¶
attachments_configuration: NotRequired[AttachmentsConfiguration]
An option to allow end users to upload files directly during chat.
client_ids_for_oidc
instance-attribute
¶
client_ids_for_oidc: NotRequired[ClientIdsForOIDC]
The OIDC client ID for a Amazon Q Business application.
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
A token that you provide to identify the request to create your Amazon Q Business application.
description
instance-attribute
¶
description: NotRequired[Description]
A description for the Amazon Q Business application.
display_name
instance-attribute
¶
display_name: ApplicationName
A name for the Amazon Q Business application.
encryption_configuration
instance-attribute
¶
encryption_configuration: NotRequired[EncryptionConfiguration]
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
iam_identity_provider_arn
instance-attribute
¶
iam_identity_provider_arn: NotRequired[IAMIdentityProviderArn]
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
identity_center_instance_arn
instance-attribute
¶
identity_center_instance_arn: NotRequired[InstanceArn]
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
identity_type
instance-attribute
¶
identity_type: NotRequired[IdentityType]
The authentication type being used by a Amazon Q Business application.
personalization_configuration
instance-attribute
¶
personalization_configuration: NotRequired[PersonalizationConfiguration]
Configuration information about chat response personalization. For more information, see Personalizing chat responses
q_apps_configuration
instance-attribute
¶
q_apps_configuration: NotRequired[QAppsConfiguration]
An option to allow end users to create and use Amazon Q Apps in the web experience.
quick_sight_configuration
instance-attribute
¶
quick_sight_configuration: NotRequired[QuickSightConfiguration]
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.
role_arn
instance-attribute
¶
role_arn: NotRequired[RoleArn]
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.
tags
instance-attribute
¶
tags: NotRequired[Tags]
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: _ . : / = + - @.