/AWS1/IF_MPC=>LISTENTITIES()

About ListEntities

Provides the list of entities of a given type.

Method Signature

METHODS /AWS1/IF_MPC~LISTENTITIES
  IMPORTING
    !IV_CATALOG TYPE /AWS1/MPCCATALOG OPTIONAL
    !IV_ENTITYTYPE TYPE /AWS1/MPCENTITYTYPE OPTIONAL
    !IT_FILTERLIST TYPE /AWS1/CL_MPCFILTER=>TT_FILTERLIST OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_MPCSORT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MPCNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MPCLSTENTSMAXRSLTINTEGER OPTIONAL
    !IV_OWNERSHIPTYPE TYPE /AWS1/MPCOWNERSHIPTYPE OPTIONAL
    !IO_ENTITYTYPEFILTERS TYPE REF TO /AWS1/CL_MPCENTITYTYPEFILTERS OPTIONAL
    !IO_ENTITYTYPESORT TYPE REF TO /AWS1/CL_MPCENTITYTYPESORT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpclistentsresponse
  RAISING
    /AWS1/CX_MPCACCESSDENIEDEX
    /AWS1/CX_MPCINTERNALSERVICEEX
    /AWS1/CX_MPCRESOURCENOTFOUNDEX
    /AWS1/CX_MPCTHROTTLINGEX
    /AWS1/CX_MPCVALIDATIONEX
    /AWS1/CX_MPCCLIENTEXC
    /AWS1/CX_MPCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/MPCCATALOG /AWS1/MPCCATALOG

The catalog related to the request. Fixed value: AWSMarketplace

iv_entitytype TYPE /AWS1/MPCENTITYTYPE /AWS1/MPCENTITYTYPE

The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

Optional arguments:

it_filterlist TYPE /AWS1/CL_MPCFILTER=>TT_FILTERLIST TT_FILTERLIST

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

io_sort TYPE REF TO /AWS1/CL_MPCSORT /AWS1/CL_MPCSORT

An object that contains two attributes, SortBy and SortOrder.

iv_nexttoken TYPE /AWS1/MPCNEXTTOKEN /AWS1/MPCNEXTTOKEN

The value of the next token, if it exists. Null if there are no more results.

iv_maxresults TYPE /AWS1/MPCLSTENTSMAXRSLTINTEGER /AWS1/MPCLSTENTSMAXRSLTINTEGER

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

iv_ownershiptype TYPE /AWS1/MPCOWNERSHIPTYPE /AWS1/MPCOWNERSHIPTYPE

Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

io_entitytypefilters TYPE REF TO /AWS1/CL_MPCENTITYTYPEFILTERS /AWS1/CL_MPCENTITYTYPEFILTERS

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

io_entitytypesort TYPE REF TO /AWS1/CL_MPCENTITYTYPESORT /AWS1/CL_MPCENTITYTYPESORT

A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

RETURNING

oo_output TYPE REF TO /aws1/cl_mpclistentsresponse /AWS1/CL_MPCLISTENTSRESPONSE

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->listentities(
  io_entitytypefilters = new /aws1/cl_mpcentitytypefilters(
    io_amiproductfilters = new /aws1/cl_mpcamiproductfilters(
      io_entityid = new /aws1/cl_mpcamiproductentidf00(
        it_valuelist = VALUE /aws1/cl_mpcamiproductentidf01=>tt_amiproductentidfiltvallist(
          ( new /aws1/cl_mpcamiproductentidf01( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcamiproductlastmo00(
        io_daterange = new /aws1/cl_mpcamiproductlastmo01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_producttitle = new /aws1/cl_mpcamiproducttitlef00(
        it_valuelist = VALUE /aws1/cl_mpcamiproducttitlef01=>tt_amiproducttitlefiltvallist(
          ( new /aws1/cl_mpcamiproducttitlef01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_visibility = new /aws1/cl_mpcamiproductvisibi00(
        it_valuelist = VALUE /aws1/cl_mpcamiproductvisibi01=>tt_amiproductvisibilityfiltv00(
          ( new /aws1/cl_mpcamiproductvisibi01( |string| ) )
        )
      )
    )
    io_containerproductfilters = new /aws1/cl_mpccontainerproduct00(
      io_entityid = new /aws1/cl_mpccontainerproduct01(
        it_valuelist = VALUE /aws1/cl_mpccontainerproduct02=>tt_containerproductentidfilt00(
          ( new /aws1/cl_mpccontainerproduct02( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpccontainerproduct03(
        io_daterange = new /aws1/cl_mpccontainerproduct04(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_producttitle = new /aws1/cl_mpccontainerproduct05(
        it_valuelist = VALUE /aws1/cl_mpccontainerproduct06=>tt_containerproducttitlefilt00(
          ( new /aws1/cl_mpccontainerproduct06( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_visibility = new /aws1/cl_mpccontainerproduct07(
        it_valuelist = VALUE /aws1/cl_mpccontainerproduct08=>tt_containerproductvisibilit00(
          ( new /aws1/cl_mpccontainerproduct08( |string| ) )
        )
      )
    )
    io_dataproductfilters = new /aws1/cl_mpcdataproductfilters(
      io_entityid = new /aws1/cl_mpcdataproductentid00(
        it_valuelist = VALUE /aws1/cl_mpcdataproductentid01=>tt_dataproductentidfiltvallist(
          ( new /aws1/cl_mpcdataproductentid01( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcdataproductlastm00(
        io_daterange = new /aws1/cl_mpcdataproductlastm01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_producttitle = new /aws1/cl_mpcdataproducttitle00(
        it_valuelist = VALUE /aws1/cl_mpcdataproducttitle01=>tt_dataproducttitlefiltvallist(
          ( new /aws1/cl_mpcdataproducttitle01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_visibility = new /aws1/cl_mpcdataproductvisib00(
        it_valuelist = VALUE /aws1/cl_mpcdataproductvisib01=>tt_dataproductvisibilityfilt00(
          ( new /aws1/cl_mpcdataproductvisib01( |string| ) )
        )
      )
    )
    io_mlproductfilters = new /aws1/cl_mpcmlproductfilters(
      io_entityid = new /aws1/cl_mpcmlproductentidfilt(
        it_valuelist = VALUE /aws1/cl_mpcmlproductentidfi00=>tt_mlproductentidfiltvaluelist(
          ( new /aws1/cl_mpcmlproductentidfi00( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcmlproductlastmod00(
        io_daterange = new /aws1/cl_mpcmlproductlastmod01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_producttitle = new /aws1/cl_mpcmlproducttitlefilt(
        it_valuelist = VALUE /aws1/cl_mpcmlproducttitlefi00=>tt_mlproducttitlefiltvaluelist(
          ( new /aws1/cl_mpcmlproducttitlefi00( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_visibility = new /aws1/cl_mpcmlproductvisibil00(
        it_valuelist = VALUE /aws1/cl_mpcmlproductvisibil01=>tt_mlproductvisibilityfiltva00(
          ( new /aws1/cl_mpcmlproductvisibil01( |string| ) )
        )
      )
    )
    io_offerfilters = new /aws1/cl_mpcofferfilters(
      io_availabilityenddate = new /aws1/cl_mpcofferavailabilit00(
        io_daterange = new /aws1/cl_mpcofferavailabilit01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_buyeraccounts = new /aws1/cl_mpcofferbuyeracctsf00( |string| )
      io_entityid = new /aws1/cl_mpcofferentityidfilt(
        it_valuelist = VALUE /aws1/cl_mpcofferentidfiltva00=>tt_offerentityidfiltvaluelist(
          ( new /aws1/cl_mpcofferentidfiltva00( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcofferlastmoddate00(
        io_daterange = new /aws1/cl_mpcofferlastmoddate01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_name = new /aws1/cl_mpcoffernamefilter(
        it_valuelist = VALUE /aws1/cl_mpcoffernamefiltval00=>tt_offernamefiltervaluelist(
          ( new /aws1/cl_mpcoffernamefiltval00( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_productid = new /aws1/cl_mpcofferproductidfilt(
        it_valuelist = VALUE /aws1/cl_mpcofferproductidfi00=>tt_offerproductidfiltvaluelist(
          ( new /aws1/cl_mpcofferproductidfi00( |string| ) )
        )
      )
      io_releasedate = new /aws1/cl_mpcofferreleasedate00(
        io_daterange = new /aws1/cl_mpcofferreleasedate01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_resaleauthorizationid = new /aws1/cl_mpcofferresaleauthi00(
        it_valuelist = VALUE /aws1/cl_mpcofferresaleauthi01=>tt_offerresaleauthidfiltvallst(
          ( new /aws1/cl_mpcofferresaleauthi01( |string| ) )
        )
      )
      io_state = new /aws1/cl_mpcofferstatefilter(
        it_valuelist = VALUE /aws1/cl_mpcofferstatefiltva00=>tt_offerstatefiltervaluelist(
          ( new /aws1/cl_mpcofferstatefiltva00( |string| ) )
        )
      )
      io_targeting = new /aws1/cl_mpcoffertgtingfilter(
        it_valuelist = VALUE /aws1/cl_mpcoffertgtingfiltv00=>tt_offertgtingfiltervaluelist(
          ( new /aws1/cl_mpcoffertgtingfiltv00( |string| ) )
        )
      )
    )
    io_resaleauthfilters = new /aws1/cl_mpcresaleauthfilters(
      io_availabilityenddate = new /aws1/cl_mpcresaleauthavaila00(
        io_daterange = new /aws1/cl_mpcresaleauthavaila01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
        it_valuelist = VALUE /aws1/cl_mpcresaleauthavaila02=>tt_resaleauthavailabilityend00(
          ( new /aws1/cl_mpcresaleauthavaila02( |string| ) )
        )
      )
      io_createddate = new /aws1/cl_mpcresaleauthcredda00(
        io_daterange = new /aws1/cl_mpcresaleauthcredda01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
        it_valuelist = VALUE /aws1/cl_mpcresaleauthcredda02=>tt_resaleauthcreddatefiltval00(
          ( new /aws1/cl_mpcresaleauthcredda02( |string| ) )
        )
      )
      io_entityid = new /aws1/cl_mpcresaleauthentidf00(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthentidf01=>tt_resaleauthentidfiltvallist(
          ( new /aws1/cl_mpcresaleauthentidf01( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcresaleauthlastmo00(
        io_daterange = new /aws1/cl_mpcresaleauthlastmo01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_manufactureraccountid = new /aws1/cl_mpcresaleauthmanufa00(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthmanufa01=>tt_resaleauthmanufactureraci00(
          ( new /aws1/cl_mpcresaleauthmanufa01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_manufacturerlegalname = new /aws1/cl_mpcresaleauthmanufa02(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthmanufa03=>tt_resaleauthmanufacturerleg00(
          ( new /aws1/cl_mpcresaleauthmanufa03( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_name = new /aws1/cl_mpcresaleauthnamefilt(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthnamefi00=>tt_resaleauthnamefiltvaluelist(
          ( new /aws1/cl_mpcresaleauthnamefi00( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_offerextendedstatus = new /aws1/cl_mpcresaleauthoffere00(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthoffere01=>tt_resaleauthofferextendedst00(
          ( new /aws1/cl_mpcresaleauthoffere01( |string| ) )
        )
      )
      io_productid = new /aws1/cl_mpcresaleauthproduc00(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthproduc01=>tt_resaleauthproductidfiltva00(
          ( new /aws1/cl_mpcresaleauthproduc01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_productname = new /aws1/cl_mpcresaleauthproduc02(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthproduc03=>tt_resaleauthproductnamefilt00(
          ( new /aws1/cl_mpcresaleauthproduc03( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_reselleraccountid = new /aws1/cl_mpcresaleauthresell00(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthresell01=>tt_resaleauthreselleracidfil00(
          ( new /aws1/cl_mpcresaleauthresell01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_resellerlegalname = new /aws1/cl_mpcresaleauthresell02(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthresell03=>tt_resaleauthresellerlegalna00(
          ( new /aws1/cl_mpcresaleauthresell03( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_status = new /aws1/cl_mpcresaleauthstatfilt(
        it_valuelist = VALUE /aws1/cl_mpcresaleauthstatfi00=>tt_resaleauthstatfiltvaluelist(
          ( new /aws1/cl_mpcresaleauthstatfi00( |string| ) )
        )
      )
    )
    io_saasproductfilters = new /aws1/cl_mpcsaasproductfilters(
      io_entityid = new /aws1/cl_mpcsaasproductentid00(
        it_valuelist = VALUE /aws1/cl_mpcsaasproductentid01=>tt_saasproductentidfiltvallist(
          ( new /aws1/cl_mpcsaasproductentid01( |string| ) )
        )
      )
      io_lastmodifieddate = new /aws1/cl_mpcsaasproductlastm00(
        io_daterange = new /aws1/cl_mpcsaasproductlastm01(
          iv_aftervalue = |string|
          iv_beforevalue = |string|
        )
      )
      io_producttitle = new /aws1/cl_mpcsaasproducttitle00(
        it_valuelist = VALUE /aws1/cl_mpcsaasproducttitle01=>tt_saasproducttitlefiltvallist(
          ( new /aws1/cl_mpcsaasproducttitle01( |string| ) )
        )
        iv_wildcardvalue = |string|
      )
      io_visibility = new /aws1/cl_mpcsaasproductvisib00(
        it_valuelist = VALUE /aws1/cl_mpcsaasproductvisib01=>tt_saasproductvisibilityfilt00(
          ( new /aws1/cl_mpcsaasproductvisib01( |string| ) )
        )
      )
    )
  )
  io_entitytypesort = new /aws1/cl_mpcentitytypesort(
    io_amiproductsort = new /aws1/cl_mpcamiproductsort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_containerproductsort = new /aws1/cl_mpccontainerproduct09(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_dataproductsort = new /aws1/cl_mpcdataproductsort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_mlproductsort = new /aws1/cl_mpcmlproductsort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_offersort = new /aws1/cl_mpcoffersort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_resaleauthorizationsort = new /aws1/cl_mpcresaleauthsort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_saasproductsort = new /aws1/cl_mpcsaasproductsort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
  )
  io_sort = new /aws1/cl_mpcsort(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  it_filterlist = VALUE /aws1/cl_mpcfilter=>tt_filterlist(
    (
      new /aws1/cl_mpcfilter(
        it_valuelist = VALUE /aws1/cl_mpcvaluelist_w=>tt_valuelist(
          ( new /aws1/cl_mpcvaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_catalog = |string|
  iv_entitytype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_ownershiptype = |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_entitysummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entitynamestring = lo_row_1->get_name( ).
      lv_entitytype = lo_row_1->get_entitytype( ).
      lv_resourceid = lo_row_1->get_entityid( ).
      lv_arn = lo_row_1->get_entityarn( ).
      lv_datetimeiso8601 = lo_row_1->get_lastmodifieddate( ).
      lv_visibilityvalue = lo_row_1->get_visibility( ).
      lo_amiproductsummary = lo_row_1->get_amiproductsummary( ).
      IF lo_amiproductsummary IS NOT INITIAL.
        lv_amiproducttitlestring = lo_amiproductsummary->get_producttitle( ).
        lv_amiproductvisibilitystr = lo_amiproductsummary->get_visibility( ).
      ENDIF.
      lo_containerproductsummary = lo_row_1->get_containerproductsummary( ).
      IF lo_containerproductsummary IS NOT INITIAL.
        lv_containerproducttitlest = lo_containerproductsummary->get_producttitle( ).
        lv_containerproductvisibil = lo_containerproductsummary->get_visibility( ).
      ENDIF.
      lo_dataproductsummary = lo_row_1->get_dataproductsummary( ).
      IF lo_dataproductsummary IS NOT INITIAL.
        lv_dataproducttitlestring = lo_dataproductsummary->get_producttitle( ).
        lv_dataproductvisibilityst = lo_dataproductsummary->get_visibility( ).
      ENDIF.
      lo_saasproductsummary = lo_row_1->get_saasproductsummary( ).
      IF lo_saasproductsummary IS NOT INITIAL.
        lv_saasproducttitlestring = lo_saasproductsummary->get_producttitle( ).
        lv_saasproductvisibilityst = lo_saasproductsummary->get_visibility( ).
      ENDIF.
      lo_offersummary = lo_row_1->get_offersummary( ).
      IF lo_offersummary IS NOT INITIAL.
        lv_offernamestring = lo_offersummary->get_name( ).
        lv_offerproductidstring = lo_offersummary->get_productid( ).
        lv_offerresaleauthorizatio = lo_offersummary->get_resaleauthorizationid( ).
        lv_datetimeiso8601 = lo_offersummary->get_releasedate( ).
        lv_datetimeiso8601 = lo_offersummary->get_availabilityenddate( ).
        LOOP AT lo_offersummary->get_buyeraccounts( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_offerbuyeraccountsstrin = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_offerstatestring = lo_offersummary->get_state( ).
        LOOP AT lo_offersummary->get_targeting( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_offertargetingstring = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_resaleauthorizationsumm = lo_row_1->get_resaleauthsummary( ).
      IF lo_resaleauthorizationsumm IS NOT INITIAL.
        lv_resaleauthorizationname = lo_resaleauthorizationsumm->get_name( ).
        lv_resaleauthorizationprod = lo_resaleauthorizationsumm->get_productid( ).
        lv_resaleauthorizationprod_1 = lo_resaleauthorizationsumm->get_productname( ).
        lv_resaleauthorizationmanu = lo_resaleauthorizationsumm->get_manufactureraccountid( ).
        lv_resaleauthorizationmanu_1 = lo_resaleauthorizationsumm->get_manufacturerlegalname( ).
        lv_resaleauthorizationrese = lo_resaleauthorizationsumm->get_reselleraccountid( ).
        lv_resaleauthorizationrese_1 = lo_resaleauthorizationsumm->get_resellerlegalname( ).
        lv_resaleauthorizationstat = lo_resaleauthorizationsumm->get_status( ).
        lv_resaleauthorizationoffe = lo_resaleauthorizationsumm->get_offerextendedstatus( ).
        lv_datetimeiso8601 = lo_resaleauthorizationsumm->get_createddate( ).
        lv_datetimeiso8601 = lo_resaleauthorizationsumm->get_availabilityenddate( ).
      ENDIF.
      lo_machinelearningproducts = lo_row_1->get_mlproductsummary( ).
      IF lo_machinelearningproducts IS NOT INITIAL.
        lv_machinelearningproductt = lo_machinelearningproducts->get_producttitle( ).
        lv_machinelearningproductv = lo_machinelearningproducts->get_visibility( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.