LISTBUILTININTENTS()`¶

About ListBuiltInIntents¶

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

Method Signature¶

METHODS /AWS1/IF_LM2~LISTBUILTININTENTS
  IMPORTING
    !IV_LOCALEID TYPE /AWS1/LM2LOCALEID OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_LM2BUILTININTENTSOR00 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2BUILTINSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2lstbuiltinintent01
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2SERVICEQUOTAEXCDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_localeid` `TYPE /AWS1/LM2LOCALEID` `/AWS1/LM2LOCALEID`¶

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional arguments:¶

`io_sortby` `TYPE REF TO /AWS1/CL_LM2BUILTININTENTSOR00` `/AWS1/CL_LM2BUILTININTENTSOR00`¶

Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

`iv_maxresults` `TYPE /AWS1/LM2BUILTINSMAXRESULTS` `/AWS1/LM2BUILTINSMAXRESULTS`¶

The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

`iv_nexttoken` `TYPE /AWS1/LM2NEXTTOKEN` `/AWS1/LM2NEXTTOKEN`¶

If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2lstbuiltinintent01` `/AWS1/CL_LM2LSTBUILTININTENT01`¶

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->listbuiltinintents(
  io_sortby = new /aws1/cl_lm2builtinintentsor00(
    iv_attribute = |string|
    iv_order = |string|
  )
  iv_localeid = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_builtinintentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_intentsignature = lo_row_1->get_intentsignature( ).
      lv_description = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_localeid = lo_result->get_localeid( ).
ENDIF.

/AWS1/IF_LM2=>LISTBUILTININTENTS()¶