Skip to content

/AWS1/IF_CNT=>SEARCHVOCABULARIES()

About SearchVocabularies

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Method Signature

METHODS /AWS1/IF_CNT~SEARCHVOCABULARIES
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT100 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTVOCABULARYNEXTTOKEN OPTIONAL
    !IV_STATE TYPE /AWS1/CNTVOCABULARYSTATE OPTIONAL
    !IV_NAMESTARTSWITH TYPE /AWS1/CNTVOCABULARYNAME OPTIONAL
    !IV_LANGUAGECODE TYPE /AWS1/CNTVOCABULARYLANGUAGEC00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsrchvocabularies01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /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.

Optional arguments:

iv_maxresults TYPE /AWS1/CNTMAXRESULT100 /AWS1/CNTMAXRESULT100

The maximum number of results to return per page.

iv_nexttoken TYPE /AWS1/CNTVOCABULARYNEXTTOKEN /AWS1/CNTVOCABULARYNEXTTOKEN

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

iv_state TYPE /AWS1/CNTVOCABULARYSTATE /AWS1/CNTVOCABULARYSTATE

The current state of the custom vocabulary.

iv_namestartswith TYPE /AWS1/CNTVOCABULARYNAME /AWS1/CNTVOCABULARYNAME

The starting pattern of the name of the 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?

RETURNING

oo_output TYPE REF TO /aws1/cl_cntsrchvocabularies01 /AWS1/CL_CNTSRCHVOCABULARIES01

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->searchvocabularies(
  iv_instanceid = |string|
  iv_languagecode = |string|
  iv_maxresults = 123
  iv_namestartswith = |string|
  iv_nexttoken = |string|
  iv_state = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_vocabularysummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vocabularyname = lo_row_1->get_name( ).
      lv_vocabularyid = lo_row_1->get_id( ).
      lv_arn = lo_row_1->get_arn( ).
      lv_vocabularylanguagecode = lo_row_1->get_languagecode( ).
      lv_vocabularystate = lo_row_1->get_state( ).
      lv_vocabularylastmodifiedt = lo_row_1->get_lastmodifiedtime( ).
      lv_vocabularyfailurereason = lo_row_1->get_failurereason( ).
    ENDIF.
  ENDLOOP.
  lv_vocabularynexttoken = lo_result->get_nexttoken( ).
ENDIF.