Skip to content

/AWS1/IF_CHI=>CREATEAPPINSTANCEBOT()

About CreateAppInstanceBot

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

Method Signature

METHODS /AWS1/IF_CHI~CREATEAPPINSTANCEBOT
  IMPORTING
    !IV_APPINSTANCEARN TYPE /AWS1/CHICHIMEARN OPTIONAL
    !IV_NAME TYPE /AWS1/CHIRESOURCENAME OPTIONAL
    !IV_METADATA TYPE /AWS1/CHIMETADATA OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/CHICLIENTREQUESTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CHITAG=>TT_TAGLIST OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_CHICONFIGURATION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chicreappinstbotrsp
  RAISING
    /AWS1/CX_CHIBADREQUESTEX
    /AWS1/CX_CHICONFLICTEXCEPTION
    /AWS1/CX_CHIFORBIDDENEXCEPTION
    /AWS1/CX_CHIRESRCLIMITEXCDEX
    /AWS1/CX_CHISERVICEFAILUREEX
    /AWS1/CX_CHISERVICEUNAVAILEX
    /AWS1/CX_CHITHROTTLEDCLIENTEX
    /AWS1/CX_CHIUNAUTHDCLIENTEX
    /AWS1/CX_CHICLIENTEXC
    /AWS1/CX_CHISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_appinstancearn TYPE /AWS1/CHICHIMEARN /AWS1/CHICHIMEARN

The ARN of the AppInstance request.

iv_clientrequesttoken TYPE /AWS1/CHICLIENTREQUESTTOKEN /AWS1/CHICLIENTREQUESTTOKEN

The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

io_configuration TYPE REF TO /AWS1/CL_CHICONFIGURATION /AWS1/CL_CHICONFIGURATION

Configuration information about the Amazon Lex V2 V2 bot.

Optional arguments:

iv_name TYPE /AWS1/CHIRESOURCENAME /AWS1/CHIRESOURCENAME

The user's name.

iv_metadata TYPE /AWS1/CHIMETADATA /AWS1/CHIMETADATA

The request metadata. Limited to a 1KB string in UTF-8.

it_tags TYPE /AWS1/CL_CHITAG=>TT_TAGLIST TT_TAGLIST

The tags assigned to the AppInstanceBot.

RETURNING

oo_output TYPE REF TO /aws1/cl_chicreappinstbotrsp /AWS1/CL_CHICREAPPINSTBOTRSP

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->createappinstancebot(
  io_configuration = new /aws1/cl_chiconfiguration(
    io_lex = new /aws1/cl_chilexconfiguration(
      io_invokedby = new /aws1/cl_chiinvokedby(
        iv_standardmessages = |string|
        iv_targetedmessages = |string|
      )
      iv_lexbotaliasarn = |string|
      iv_localeid = |string|
      iv_respondsto = |string|
      iv_welcomeintent = |string|
    )
  )
  it_tags = VALUE /aws1/cl_chitag=>tt_taglist(
    (
      new /aws1/cl_chitag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_appinstancearn = |string|
  iv_clientrequesttoken = |string|
  iv_metadata = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_chimearn = lo_result->get_appinstancebotarn( ).
ENDIF.