create_application
async
¶
create_application(
display_name: ApplicationName,
*,
config_overrides: Optional[AsyncQBusinessClientConfig] = None,
role_arn: Optional[RoleArn] = None,
identity_type: Optional[IdentityType] = None,
iam_identity_provider_arn: Optional[IAMIdentityProviderArn] = None,
identity_center_instance_arn: Optional[InstanceArn] = None,
client_ids_for_oidc: Optional[ClientIdsForOIDC] = None,
description: Optional[Description] = None,
encryption_configuration: Optional[EncryptionConfiguration] = None,
tags: Optional[Tags] = None,
client_token: Optional[ClientToken] = None,
attachments_configuration: Optional[AttachmentsConfiguration] = None,
q_apps_configuration: Optional[QAppsConfiguration] = None,
personalization_configuration: Optional[PersonalizationConfiguration] = None,
quick_sight_configuration: Optional[QuickSightConfiguration] = None,
) -> CreateApplicationResponse
Creates an Amazon Q Business application.
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:
-
display_name(ApplicationName) –A name for the Amazon Q Business application.
-
role_arn(Optional[RoleArn], default: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.
-
identity_type(Optional[IdentityType], default:None) –The authentication type being used by a Amazon Q Business application.
-
iam_identity_provider_arn(Optional[IAMIdentityProviderArn], default:None) –The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
-
identity_center_instance_arn(Optional[InstanceArn], default: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.
-
client_ids_for_oidc(Optional[ClientIdsForOIDC], default:None) –The OIDC client ID for a Amazon Q Business application.
-
description(Optional[Description], default:None) –A description for the Amazon Q Business application.
-
encryption_configuration(Optional[EncryptionConfiguration], default:None) –The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
-
tags(Optional[Tags], default: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: _ . : / = + - @.
-
client_token(Optional[ClientToken], default:None) –A token that you provide to identify the request to create your Amazon Q Business application.
-
attachments_configuration(Optional[AttachmentsConfiguration], default:None) –An option to allow end users to upload files directly during chat.
-
q_apps_configuration(Optional[QAppsConfiguration], default:None) –An option to allow end users to create and use Amazon Q Apps in the web experience.
-
personalization_configuration(Optional[PersonalizationConfiguration], default:None) –Configuration information about chat response personalization. For more information, see Personalizing chat responses
-
quick_sight_configuration(Optional[QuickSightConfiguration], default: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.
Raises:
-
AccessDeniedException–You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
-
ConflictException–You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
-
InternalServerException–An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
-
ResourceNotFoundException–The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
-
ServiceQuotaExceededException–You have exceeded the set limits for your Amazon Q Business service.
-
ThrottlingException–The request was denied due to throttling. Reduce the number of requests and try again.
-
ValidationException–The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_qbusiness/_services/async_q_business.py
3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 | |