QBusiness / Client / create_application

create_application#

QBusiness.Client.create_application(**kwargs)#

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 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.

See also: AWS API Documentation

Request Syntax

response = client.create_application(
    displayName='string',
    roleArn='string',
    identityType='AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP',
    iamIdentityProviderArn='string',
    identityCenterInstanceArn='string',
    clientIdsForOIDC=[
        'string',
    ],
    description='string',
    encryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string',
    attachmentsConfiguration={
        'attachmentsControlMode': 'ENABLED'|'DISABLED'
    },
    qAppsConfiguration={
        'qAppsControlMode': 'ENABLED'|'DISABLED'
    },
    personalizationConfiguration={
        'personalizationControlMode': 'ENABLED'|'DISABLED'
    },
    quickSightConfiguration={
        'clientNamespace': 'string'
    }
)
Parameters:

  • displayName (string) –

    [REQUIRED]

    A name for the Amazon Q Business application.

  • roleArn (string) – 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.

  • identityType (string) – The authentication type being used by a Amazon Q Business application.

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

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

  • clientIdsForOIDC (list) –

    The OIDC client ID for a Amazon Q Business application.

    • (string) –

  • description (string) – A description for the Amazon Q Business application.

  • encryptionConfiguration (dict) –

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

    • kmsKeyId (string) –

      The identifier of the KMS key. Amazon Q Business doesn’t support asymmetric keys.

  • tags (list) –

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

    • (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 Business 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.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • 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.

  • qAppsConfiguration (dict) –

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

    • qAppsControlMode (string) – [REQUIRED]

      Status information about whether end users can create and use Amazon Q Apps in the web experience.

  • personalizationConfiguration (dict) –

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

    • personalizationControlMode (string) – [REQUIRED]

      An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

  • quickSightConfiguration (dict) –

    The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

    • clientNamespace (string) – [REQUIRED]

      The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'applicationArn': 'string'
}

Response Structure

  • (dict) –

    • applicationId (string) –

      The identifier of the Amazon Q Business application.

    • applicationArn (string) –

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

Exceptions