/AWS1/IF_CNT=>CREATEINSTANCE()

About CreateInstance

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Method Signature

METHODS /AWS1/IF_CNT~CREATEINSTANCE
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_IDENTITYMANAGEMENTTYPE TYPE /AWS1/CNTDIRECTORYTYPE OPTIONAL
    !IV_INSTANCEALIAS TYPE /AWS1/CNTDIRECTORYALIAS OPTIONAL
    !IV_DIRECTORYID TYPE /AWS1/CNTDIRECTORYID OPTIONAL
    !IV_INBOUNDCALLSENABLED TYPE /AWS1/CNTINBOUNDCALLSENABLED OPTIONAL
    !IV_OUTBOUNDCALLSENABLED TYPE /AWS1/CNTOUTBOUNDCALLSENABLED OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcreateinstresponse
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_identitymanagementtype TYPE /AWS1/CNTDIRECTORYTYPE /AWS1/CNTDIRECTORYTYPE

The type of identity management for your Amazon Connect users.

iv_inboundcallsenabled TYPE /AWS1/CNTINBOUNDCALLSENABLED /AWS1/CNTINBOUNDCALLSENABLED

Your contact center handles incoming contacts.

iv_outboundcallsenabled TYPE /AWS1/CNTOUTBOUNDCALLSENABLED /AWS1/CNTOUTBOUNDCALLSENABLED

Your contact center allows outbound calls.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

The idempotency token.

iv_instancealias TYPE /AWS1/CNTDIRECTORYALIAS /AWS1/CNTDIRECTORYALIAS

The name for your instance.

iv_directoryid TYPE /AWS1/CNTDIRECTORYID /AWS1/CNTDIRECTORYID

The identifier for the directory.

it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntcreateinstresponse /AWS1/CL_CNTCREATEINSTRESPONSE

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->createinstance(
  it_tags = VALUE /aws1/cl_cnttagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnttagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_cnttagmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_directoryid = |string|
  iv_identitymanagementtype = |string|
  iv_inboundcallsenabled = ABAP_TRUE
  iv_instancealias = |string|
  iv_outboundcallsenabled = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_instanceid = lo_result->get_id( ).
  lv_arn = lo_result->get_arn( ).
ENDIF.