Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

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.

post/applications

Request body

displayNamestring required

A name for the Amazon Q Business application.

roleArnstring

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 <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions">service linked role (SLR)</a> and use it as the application's role.

identityType'AWS_IAM_IDP_SAML' | 'AWS_IAM_IDP_OIDC' | 'AWS_IAM_IDC' | 'AWS_QUICKSIGHT_IDP' | 'ANONYMOUS'

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

iamIdentityProviderArnstring

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

identityCenterInstanceArnstring

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

clientIdsForOIDCClientIdForOIDC[]

The OIDC client ID for a Amazon Q Business application.

descriptionstring

A description for the Amazon Q Business application.

clientTokenstring

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

Response

Success

applicationIdstring

The identifier of the Amazon Q Business application.

applicationArnstring

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