GETINTENTS()`¶

About GetIntents¶

Returns intent information as follows:

If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST version of all intents.

The operation requires permission for the lex:GetIntents action.

Method Signature¶

METHODS /AWS1/IF_LXB~GETINTENTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/LXBNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LXBMAXRESULTS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/LXBINTENTNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lxbgetintentsresponse
  RAISING
    /AWS1/CX_LXBBADREQUESTEX
    /AWS1/CX_LXBINTERNALFAILUREEX
    /AWS1/CX_LXBLIMITEXCEEDEDEX
    /AWS1/CX_LXBNOTFOUNDEXCEPTION
    /AWS1/CX_LXBCLIENTEXC
    /AWS1/CX_LXBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/LXBNEXTTOKEN` `/AWS1/LXBNEXTTOKEN`¶

A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

`iv_maxresults` `TYPE /AWS1/LXBMAXRESULTS` `/AWS1/LXBMAXRESULTS`¶

The maximum number of intents to return in the response. The default is 10.

`iv_namecontains` `TYPE /AWS1/LXBINTENTNAME` `/AWS1/LXBINTENTNAME`¶

Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lxbgetintentsresponse` `/AWS1/CL_LXBGETINTENTSRESPONSE`¶

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->getintents(
  iv_maxresults = 123
  iv_namecontains = |string|
  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_intents( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_intentname = lo_row_1->get_name( ).
      lv_description = lo_row_1->get_description( ).
      lv_timestamp = lo_row_1->get_lastupdateddate( ).
      lv_timestamp = lo_row_1->get_createddate( ).
      lv_version = lo_row_1->get_version( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To get a list of intents¶

This example shows how to get a list of all of the intents in your account.

DATA(lo_result) = lo_client->getintents(
  iv_maxresults = 10
  iv_nexttoken = ||
).

/AWS1/IF_LXB=>GETINTENTS()¶