GETBOTCHANNELASSOCIATIONS()`¶

About GetBotChannelAssociations¶

Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

Method Signature¶

METHODS /AWS1/IF_LXB~GETBOTCHANNELASSOCIATIONS
  IMPORTING
    !IV_BOTNAME TYPE /AWS1/LXBBOTNAME OPTIONAL
    !IV_BOTALIAS TYPE /AWS1/LXBALIASNAMEORLISTALL OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LXBNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LXBMAXRESULTS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/LXBBOTCHANNELNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lxbgetbotchannelass03
  RAISING
    /AWS1/CX_LXBBADREQUESTEX
    /AWS1/CX_LXBINTERNALFAILUREEX
    /AWS1/CX_LXBLIMITEXCEEDEDEX
    /AWS1/CX_LXBCLIENTEXC
    /AWS1/CX_LXBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_botname` `TYPE /AWS1/LXBBOTNAME` `/AWS1/LXBBOTNAME`¶

The name of the Amazon Lex bot in the association.

`iv_botalias` `TYPE /AWS1/LXBALIASNAMEORLISTALL` `/AWS1/LXBALIASNAMEORLISTALL`¶

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Optional arguments:¶

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

A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

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

The maximum number of associations to return in the response. The default is 50.

`iv_namecontains` `TYPE /AWS1/LXBBOTCHANNELNAME` `/AWS1/LXBBOTCHANNELNAME`¶

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lxbgetbotchannelass03` `/AWS1/CL_LXBGETBOTCHANNELASS03`¶

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->getbotchannelassociations(
  iv_botalias = |string|
  iv_botname = |string|
  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_botchannelassociations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_botchannelname = lo_row_1->get_name( ).
      lv_description = lo_row_1->get_description( ).
      lv_aliasname = lo_row_1->get_botalias( ).
      lv_botname = lo_row_1->get_botname( ).
      lv_timestamp = lo_row_1->get_createddate( ).
      lv_channeltype = lo_row_1->get_type( ).
      LOOP AT lo_row_1->get_botconfiguration( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_channelstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_failurereason( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_LXB=>GETBOTCHANNELASSOCIATIONS()¶