LISTCOMPOSITIONS()`¶

About ListCompositions¶

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Method Signature¶

METHODS /AWS1/IF_IVR~LISTCOMPOSITIONS
  IMPORTING
    !IV_FILTERBYSTAGEARN TYPE /AWS1/IVRSTAGEARN OPTIONAL
    !IV_FILTERBYENCODERCONFARN TYPE /AWS1/IVRENCODERCONFARN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IVRPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IVRMAXCOMPOSITIONRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivrlstcompositionsrsp
  RAISING
    /AWS1/CX_IVRACCESSDENIEDEX
    /AWS1/CX_IVRCONFLICTEXCEPTION
    /AWS1/CX_IVRINTERNALSERVEREX
    /AWS1/CX_IVRSERVICEQUOTAEXCDEX
    /AWS1/CX_IVRVALIDATIONEX
    /AWS1/CX_IVRCLIENTEXC
    /AWS1/CX_IVRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_filterbystagearn` `TYPE /AWS1/IVRSTAGEARN` `/AWS1/IVRSTAGEARN`¶

Filters the Composition list to match the specified Stage ARN.

`iv_filterbyencoderconfarn` `TYPE /AWS1/IVRENCODERCONFARN` `/AWS1/IVRENCODERCONFARN`¶

Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

`iv_nexttoken` `TYPE /AWS1/IVRPAGINATIONTOKEN` `/AWS1/IVRPAGINATIONTOKEN`¶

The first Composition to retrieve. This is used for pagination; see the nextToken response field.

`iv_maxresults` `TYPE /AWS1/IVRMAXCOMPOSITIONRESULTS` `/AWS1/IVRMAXCOMPOSITIONRESULTS`¶

Maximum number of results to return. Default: 100.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ivrlstcompositionsrsp` `/AWS1/CL_IVRLSTCOMPOSITIONSRSP`¶

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->listcompositions(
  iv_filterbyencoderconfarn = |string|
  iv_filterbystagearn = |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_compositions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_compositionarn = lo_row_1->get_arn( ).
      lv_stagearn = lo_row_1->get_stagearn( ).
      LOOP AT lo_row_1->get_destinations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_id( ).
          lv_destinationstate = lo_row_3->get_state( ).
          lv_time = lo_row_3->get_starttime( ).
          lv_time = lo_row_3->get_endtime( ).
        ENDIF.
      ENDLOOP.
      lv_compositionstate = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_time = lo_row_1->get_starttime( ).
      lv_time = lo_row_1->get_endtime( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IVR=>LISTCOMPOSITIONS()¶