Skip to content

/AWS1/IF_APY=>LISTTYPESBYASSOCIATION()

About ListTypesByAssociation

Lists Type objects by the source API association ID.

Method Signature

METHODS /AWS1/IF_APY~LISTTYPESBYASSOCIATION
  IMPORTING
    !IV_MERGEDAPIIDENTIFIER TYPE /AWS1/APYSTRING OPTIONAL
    !IV_ASSOCIATIONID TYPE /AWS1/APYSTRING OPTIONAL
    !IV_FORMAT TYPE /AWS1/APYTYPEDEFINITIONFORMAT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/APYPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/APYMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apylsttypesbyassoci01
  RAISING
    /AWS1/CX_APYBADREQUESTEX
    /AWS1/CX_APYCONCURRENTMODEX
    /AWS1/CX_APYINTERNALFAILUREEX
    /AWS1/CX_APYNOTFOUNDEXCEPTION
    /AWS1/CX_APYUNAUTHORIZEDEX
    /AWS1/CX_APYCLIENTEXC
    /AWS1/CX_APYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_mergedapiidentifier TYPE /AWS1/APYSTRING /AWS1/APYSTRING

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

iv_associationid TYPE /AWS1/APYSTRING /AWS1/APYSTRING

The ID generated by the AppSync service for the source API association.

iv_format TYPE /AWS1/APYTYPEDEFINITIONFORMAT /AWS1/APYTYPEDEFINITIONFORMAT

The format type.

Optional arguments:

iv_nexttoken TYPE /AWS1/APYPAGINATIONTOKEN /AWS1/APYPAGINATIONTOKEN

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

iv_maxresults TYPE /AWS1/APYMAXRESULTS /AWS1/APYMAXRESULTS

The maximum number of results that you want the request to return.

RETURNING

oo_output TYPE REF TO /aws1/cl_apylsttypesbyassoci01 /AWS1/CL_APYLSTTYPESBYASSOCI01

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->listtypesbyassociation(
  iv_associationid = |string|
  iv_format = |string|
  iv_maxresults = 123
  iv_mergedapiidentifier = |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_types( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcename = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_definition( ).
      lv_typedefinitionformat = lo_row_1->get_format( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.