Skip to content

/AWS1/IF_QQB=>CREATEAPPLICATION()

About CreateApplication

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.

Method Signature

METHODS /AWS1/IF_QQB~CREATEAPPLICATION
  IMPORTING
    !IV_DISPLAYNAME TYPE /AWS1/QQBAPPLICATIONNAME OPTIONAL
    !IV_ROLEARN TYPE /AWS1/QQBROLEARN OPTIONAL
    !IV_IDENTITYTYPE TYPE /AWS1/QQBIDENTITYTYPE OPTIONAL
    !IV_IAMIDENTITYPROVIDERARN TYPE /AWS1/QQBIAMIDENTITYPVDRARN OPTIONAL
    !IV_IDENTITYCENTERINSTANCEARN TYPE /AWS1/QQBINSTANCEARN OPTIONAL
    !IT_CLIENTIDSFOROIDC TYPE /AWS1/CL_QQBCLIENTIDSFOROIDC_W=>TT_CLIENTIDSFOROIDC OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION OPTIONAL
    !IO_ENCRYPTIONCONFIGURATION TYPE REF TO /AWS1/CL_QQBENCRYPTIONCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN OPTIONAL
    !IO_ATTACHMENTSCONFIGURATION TYPE REF TO /AWS1/CL_QQBATTACHMENTSCONF OPTIONAL
    !IO_QAPPSCONFIGURATION TYPE REF TO /AWS1/CL_QQBQAPPSCONFIGURATION OPTIONAL
    !IO_PERSONALIZATIONCONF TYPE REF TO /AWS1/CL_QQBPERSONALIZATIONC00 OPTIONAL
    !IO_QUICKSIGHTCONFIGURATION TYPE REF TO /AWS1/CL_QQBQUICKSIGHTCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbcreapplicationrsp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBSERVICEQUOTAEXCDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_displayname TYPE /AWS1/QQBAPPLICATIONNAME /AWS1/QQBAPPLICATIONNAME

A name for the Amazon Q Business application.

Optional arguments:

iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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.

iv_identitytype TYPE /AWS1/QQBIDENTITYTYPE /AWS1/QQBIDENTITYTYPE

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

iv_iamidentityproviderarn TYPE /AWS1/QQBIAMIDENTITYPVDRARN /AWS1/QQBIAMIDENTITYPVDRARN

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

iv_identitycenterinstancearn TYPE /AWS1/QQBINSTANCEARN /AWS1/QQBINSTANCEARN

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

it_clientidsforoidc TYPE /AWS1/CL_QQBCLIENTIDSFOROIDC_W=>TT_CLIENTIDSFOROIDC TT_CLIENTIDSFOROIDC

The OIDC client ID for a Amazon Q Business application.

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

A description for the Amazon Q Business application.

io_encryptionconfiguration TYPE REF TO /AWS1/CL_QQBENCRYPTIONCONF /AWS1/CL_QQBENCRYPTIONCONF

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

it_tags TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_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: _ . : / = + - @.

iv_clienttoken TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN

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

io_attachmentsconfiguration TYPE REF TO /AWS1/CL_QQBATTACHMENTSCONF /AWS1/CL_QQBATTACHMENTSCONF

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

io_qappsconfiguration TYPE REF TO /AWS1/CL_QQBQAPPSCONFIGURATION /AWS1/CL_QQBQAPPSCONFIGURATION

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

io_personalizationconf TYPE REF TO /AWS1/CL_QQBPERSONALIZATIONC00 /AWS1/CL_QQBPERSONALIZATIONC00

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

io_quicksightconfiguration TYPE REF TO /AWS1/CL_QQBQUICKSIGHTCONF /AWS1/CL_QQBQUICKSIGHTCONF

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbcreapplicationrsp /AWS1/CL_QQBCREAPPLICATIONRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createapplication(
  io_attachmentsconfiguration = new /aws1/cl_qqbattachmentsconf( |string| )
  io_encryptionconfiguration = new /aws1/cl_qqbencryptionconf( |string| )
  io_personalizationconf = new /aws1/cl_qqbpersonalizationc00( |string| )
  io_qappsconfiguration = new /aws1/cl_qqbqappsconfiguration( |string| )
  io_quicksightconfiguration = new /aws1/cl_qqbquicksightconf( |string| )
  it_clientidsforoidc = VALUE /aws1/cl_qqbclientidsforoidc_w=>tt_clientidsforoidc(
    ( new /aws1/cl_qqbclientidsforoidc_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_qqbtag=>tt_tags(
    (
      new /aws1/cl_qqbtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_iamidentityproviderarn = |string|
  iv_identitycenterinstancearn = |string|
  iv_identitytype = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_applicationid = lo_result->get_applicationid( ).
  lv_applicationarn = lo_result->get_applicationarn( ).
ENDIF.