Skip to content

/AWS1/IF_PTB=>LISTBENEFITAPPLICATIONS()

About ListBenefitApplications

Retrieves a paginated list of benefit applications based on specified filter criteria.

Method Signature

METHODS /AWS1/IF_PTB~LISTBENEFITAPPLICATIONS
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTBCATALOGNAME OPTIONAL
    !IT_PROGRAMS TYPE /AWS1/CL_PTBPROGRAMS_W=>TT_PROGRAMS OPTIONAL
    !IT_FULFILLMENTTYPES TYPE /AWS1/CL_PTBFULFILLMENTTYPES_W=>TT_FULFILLMENTTYPES OPTIONAL
    !IT_BENEFITIDENTIFIERS TYPE /AWS1/CL_PTBBENEFITIDS_W=>TT_BENEFITIDENTIFIERS OPTIONAL
    !IT_STATUS TYPE /AWS1/CL_PTBSTATUSES_W=>TT_STATUSES OPTIONAL
    !IT_STAGES TYPE /AWS1/CL_PTBSTAGES_W=>TT_STAGES OPTIONAL
    !IT_ASSOCIATEDRESOURCES TYPE /AWS1/CL_PTBASSOCIATEDRESOURCE=>TT_ASSOCIATEDRESOURCES OPTIONAL
    !IT_ASSOCIATEDRESOURCEARNS TYPE /AWS1/CL_PTBARNS_W=>TT_ARNS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTBINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptblistbenefappsout
  RAISING
    /AWS1/CX_PTBACCESSDENIEDEX
    /AWS1/CX_PTBINTERNALSERVEREX
    /AWS1/CX_PTBRESOURCENOTFOUNDEX
    /AWS1/CX_PTBTHROTTLINGEX
    /AWS1/CX_PTBVLDTNEXCEPTION
    /AWS1/CX_PTBCLIENTEXC
    /AWS1/CX_PTBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTBCATALOGNAME /AWS1/PTBCATALOGNAME

The catalog identifier to filter benefit applications by catalog.

Optional arguments:

it_programs TYPE /AWS1/CL_PTBPROGRAMS_W=>TT_PROGRAMS TT_PROGRAMS

Filter benefit applications by specific AWS partner programs.

it_fulfillmenttypes TYPE /AWS1/CL_PTBFULFILLMENTTYPES_W=>TT_FULFILLMENTTYPES TT_FULFILLMENTTYPES

Filter benefit applications by specific fulfillment types.

it_benefitidentifiers TYPE /AWS1/CL_PTBBENEFITIDS_W=>TT_BENEFITIDENTIFIERS TT_BENEFITIDENTIFIERS

Filter benefit applications by specific benefit identifiers.

it_status TYPE /AWS1/CL_PTBSTATUSES_W=>TT_STATUSES TT_STATUSES

Filter benefit applications by their current processing status.

it_stages TYPE /AWS1/CL_PTBSTAGES_W=>TT_STAGES TT_STAGES

Filter benefit applications by their current processing stage.

it_associatedresources TYPE /AWS1/CL_PTBASSOCIATEDRESOURCE=>TT_ASSOCIATEDRESOURCES TT_ASSOCIATEDRESOURCES

Filter benefit applications by associated AWS resources.

it_associatedresourcearns TYPE /AWS1/CL_PTBARNS_W=>TT_ARNS TT_ARNS

Filter benefit applications by specific AWS resource ARNs.

iv_maxresults TYPE /AWS1/PTBINTEGER /AWS1/PTBINTEGER

The maximum number of benefit applications to return in a single response.

iv_nexttoken TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING

A pagination token to retrieve the next set of results from a previous request.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptblistbenefappsout /AWS1/CL_PTBLISTBENEFAPPSOUT

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->listbenefitapplications(
  it_associatedresourcearns = VALUE /aws1/cl_ptbarns_w=>tt_arns(
    ( new /aws1/cl_ptbarns_w( |string| ) )
  )
  it_associatedresources = VALUE /aws1/cl_ptbassociatedresource=>tt_associatedresources(
    (
      new /aws1/cl_ptbassociatedresource(
        iv_resourcearn = |string|
        iv_resourceidentifier = |string|
        iv_resourcetype = |string|
      )
    )
  )
  it_benefitidentifiers = VALUE /aws1/cl_ptbbenefitids_w=>tt_benefitidentifiers(
    ( new /aws1/cl_ptbbenefitids_w( |string| ) )
  )
  it_fulfillmenttypes = VALUE /aws1/cl_ptbfulfillmenttypes_w=>tt_fulfillmenttypes(
    ( new /aws1/cl_ptbfulfillmenttypes_w( |string| ) )
  )
  it_programs = VALUE /aws1/cl_ptbprograms_w=>tt_programs(
    ( new /aws1/cl_ptbprograms_w( |string| ) )
  )
  it_stages = VALUE /aws1/cl_ptbstages_w=>tt_stages(
    ( new /aws1/cl_ptbstages_w( |string| ) )
  )
  it_status = VALUE /aws1/cl_ptbstatuses_w=>tt_statuses(
    ( new /aws1/cl_ptbstatuses_w( |string| ) )
  )
  iv_catalog = |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_benefitappsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_catalogname = lo_row_1->get_catalog( ).
      lv_benefitapplicationname = lo_row_1->get_name( ).
      lv_benefitapplicationid = lo_row_1->get_id( ).
      lv_string = lo_row_1->get_arn( ).
      lv_benefitid = lo_row_1->get_benefitid( ).
      LOOP AT lo_row_1->get_programs( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_program = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_fulfillmenttypes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_fulfillmenttype = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_benefitapplicationstatu = lo_row_1->get_status( ).
      lv_benefitapplicationstage = lo_row_1->get_stage( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      LOOP AT lo_row_1->get_benefitappdetails( ) into ls_row_6.
        lv_key = ls_row_6-key.
        lo_value = ls_row_6-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_associatedresources( ) into lo_row_7.
        lo_row_8 = lo_row_7.
        IF lo_row_8 IS NOT INITIAL.
          lv_arn = lo_row_8->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.