QBusiness / Client / create_application
create_application#
- QBusiness.Client.create_application(**kwargs)#
Creates an Amazon Q application.
See also: AWS API Documentation
Request Syntax
response = client.create_application( attachmentsConfiguration={ 'attachmentsControlMode': 'ENABLED'|'DISABLED' }, clientToken='string', description='string', displayName='string', encryptionConfiguration={ 'kmsKeyId': 'string' }, roleArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] )
- Parameters:
attachmentsConfiguration (dict) –
An option to allow end users to upload files directly during chat.
attachmentsControlMode (string) – [REQUIRED]
Status information about whether file upload functionality is activated or deactivated for your end user.
clientToken (string) –
A token that you provide to identify the request to create your Amazon Q application.
This field is autopopulated if not provided.
description (string) – A description for the Amazon Q application.
displayName (string) –
[REQUIRED]
A name for the Amazon Q application.
encryptionConfiguration (dict) –
The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn’t support asymmetric keys.
kmsKeyId (string) –
The identifier of the KMS key. Amazon Q doesn’t support asymmetric keys.
roleArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
tags (list) –
A list of key-value pairs that identify or categorize your Amazon Q 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: _ . : / = + - @.
(dict) –
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) – [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.
value (string) – [REQUIRED]
The value associated with the tag. The value may be an empty string but it can’t be null.
- Return type:
dict
- Returns:
Response Syntax
{ 'applicationArn': 'string', 'applicationId': 'string' }
Response Structure
(dict) –
applicationArn (string) –
The Amazon Resource Name (ARN) of the Amazon Q application.
applicationId (string) –
The identifier of the Amazon Q application.
Exceptions
QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ConflictException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException
QBusiness.Client.exceptions.ServiceQuotaExceededException