Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateApplication

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 AWS 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 AWS region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

Request Syntax


POST /applications HTTP/1.1
Content-type: application/json

{
   "attachmentsConfiguration": { 
      "attachmentsControlMode": "string"
   },
   "clientIdsForOIDC": [ "string" ],
   "clientToken": "string",
   "description": "string",
   "displayName": "string",
   "encryptionConfiguration": { 
      "kmsKeyId": "string"
   },
   "iamIdentityProviderArn": "string",
   "identityCenterInstanceArn": "string",
   "identityType": "string",
   "personalizationConfiguration": { 
      "personalizationControlMode": "string"
   },
   "qAppsConfiguration": { 
      "qAppsControlMode": "string"
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

attachmentsConfiguration

An option to allow end users to upload files directly during chat.

Type: AttachmentsConfiguration object

Required: No

clientIdsForOIDC

The OIDC client ID for a Amazon Q Business application.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

clientToken

A token that you provide to identify the request to create your Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

description

A description for the Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

Required: No

displayName

A name for the Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

encryptionConfiguration

The identifier of the AWS KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

Type: EncryptionConfiguration object

Required: No

iamIdentityProviderArn

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+

Required: No

identityCenterInstanceArn

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: No

identityType

The authentication type being used by a Amazon Q Business application.

Type: String

Valid Values: AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC

Required: No

personalizationConfiguration

Configuration information about chat response personalization. For more information, see Personalizing chat responses

Type: PersonalizationConfiguration object

Required: No

qAppsConfiguration

An option to allow end users to create and use Amazon Q Apps in the web experience.

Type: QAppsConfiguration object

Required: No

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

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: _ . : / = + - @.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "applicationId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationArn

The Amazon Resource Name (ARN) of the Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

applicationId

The identifier of the Amazon Q Business application.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

ConflictException

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

HTTP Status Code: 409

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.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded the set limits for your Amazon Q Business service.

HTTP Status Code: 402

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400