Skip to content

/AWS1/IF_CNT=>CREATEVOCABULARY()

About CreateVocabulary

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Method Signature

METHODS /AWS1/IF_CNT~CREATEVOCABULARY
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_VOCABULARYNAME TYPE /AWS1/CNTVOCABULARYNAME OPTIONAL
    !IV_LANGUAGECODE TYPE /AWS1/CNTVOCABULARYLANGUAGEC00 OPTIONAL
    !IV_CONTENT TYPE /AWS1/CNTVOCABULARYCONTENT OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcrevocabularyrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCECONFLICTEX
    /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_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

iv_vocabularyname TYPE /AWS1/CNTVOCABULARYNAME /AWS1/CNTVOCABULARYNAME

A unique name of the custom vocabulary.

iv_languagecode TYPE /AWS1/CNTVOCABULARYLANGUAGEC00 /AWS1/CNTVOCABULARYLANGUAGEC00

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

iv_content TYPE /AWS1/CNTVOCABULARYCONTENT /AWS1/CNTVOCABULARYCONTENT

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

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_cntcrevocabularyrsp /AWS1/CL_CNTCREVOCABULARYRSP

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->createvocabulary(
  it_tags = VALUE /aws1/cl_cnttagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnttagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_cnttagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_content = |string|
  iv_instanceid = |string|
  iv_languagecode = |string|
  iv_vocabularyname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_vocabularyarn( ).
  lv_vocabularyid = lo_result->get_vocabularyid( ).
  lv_vocabularystate = lo_result->get_state( ).
ENDIF.