CREATEAPPINSTANCE()`¶

About CreateAppInstance¶

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

Method Signature¶

METHODS /AWS1/IF_CHI~CREATEAPPINSTANCE
  IMPORTING
    !IV_NAME TYPE /AWS1/CHINONEMPTYRESOURCENAME OPTIONAL
    !IV_METADATA TYPE /AWS1/CHIMETADATA OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/CHICLIENTREQUESTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CHITAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chicreateappinstrsp
  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_name` `TYPE /AWS1/CHINONEMPTYRESOURCENAME` `/AWS1/CHINONEMPTYRESOURCENAME`¶

The name of the AppInstance.

`iv_clientrequesttoken` `TYPE /AWS1/CHICLIENTREQUESTTOKEN` `/AWS1/CHICLIENTREQUESTTOKEN`¶

The unique ID of the request. Use different tokens to create different AppInstances.

Optional arguments:¶

`iv_metadata` `TYPE /AWS1/CHIMETADATA` `/AWS1/CHIMETADATA`¶

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

`it_tags` `TYPE /AWS1/CL_CHITAG=>TT_TAGLIST` `TT_TAGLIST`¶

Tags assigned to the AppInstance.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chicreateappinstrsp` `/AWS1/CL_CHICREATEAPPINSTRSP`¶

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->createappinstance(
  it_tags = VALUE /aws1/cl_chitag=>tt_taglist(
    (
      new /aws1/cl_chitag(
        iv_key = |string|
        iv_value = |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_appinstancearn( ).
ENDIF.

/AWS1/IF_CHI=>CREATEAPPINSTANCE()¶