Skip to content

/AWS1/IF_SGM=>LISTASSOCIATIONS()

About ListAssociations

Lists the associations in your account and their properties.

Method Signature

METHODS /AWS1/IF_SGM~LISTASSOCIATIONS
  IMPORTING
    !IV_SOURCEARN TYPE /AWS1/SGMASSOCIATIONENTITYARN OPTIONAL
    !IV_DESTINATIONARN TYPE /AWS1/SGMASSOCIATIONENTITYARN OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/SGMSTRING256 OPTIONAL
    !IV_DESTINATIONTYPE TYPE /AWS1/SGMSTRING256 OPTIONAL
    !IV_ASSOCIATIONTYPE TYPE /AWS1/SGMASSOCIATIONEDGETYPE OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTASSOCIATIONSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlstassociationsrsp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sourcearn TYPE /AWS1/SGMASSOCIATIONENTITYARN /AWS1/SGMASSOCIATIONENTITYARN

A filter that returns only associations with the specified source ARN.

iv_destinationarn TYPE /AWS1/SGMASSOCIATIONENTITYARN /AWS1/SGMASSOCIATIONENTITYARN

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

iv_sourcetype TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

A filter that returns only associations with the specified source type.

iv_destinationtype TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

A filter that returns only associations with the specified destination type.

iv_associationtype TYPE /AWS1/SGMASSOCIATIONEDGETYPE /AWS1/SGMASSOCIATIONEDGETYPE

A filter that returns only associations of the specified type.

iv_createdafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only associations created on or after the specified time.

iv_createdbefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only associations created on or before the specified time.

iv_sortby TYPE /AWS1/SGMSORTASSOCIATIONSBY /AWS1/SGMSORTASSOCIATIONSBY

The property used to sort results. The default value is CreationTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order. The default value is Descending.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

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

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlstassociationsrsp /AWS1/CL_SGMLSTASSOCIATIONSRSP

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->listassociations(
  iv_associationtype = |string|
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_destinationarn = |string|
  iv_destinationtype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_sourcearn = |string|
  iv_sourcetype = |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_associationsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_associationentityarn = lo_row_1->get_sourcearn( ).
      lv_associationentityarn = lo_row_1->get_destinationarn( ).
      lv_string256 = lo_row_1->get_sourcetype( ).
      lv_string256 = lo_row_1->get_destinationtype( ).
      lv_associationedgetype = lo_row_1->get_associationtype( ).
      lv_experimententityname = lo_row_1->get_sourcename( ).
      lv_experimententityname = lo_row_1->get_destinationname( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lo_usercontext = lo_row_1->get_createdby( ).
      IF lo_usercontext IS NOT INITIAL.
        lv_string = lo_usercontext->get_userprofilearn( ).
        lv_string = lo_usercontext->get_userprofilename( ).
        lv_string = lo_usercontext->get_domainid( ).
        lo_iamidentity = lo_usercontext->get_iamidentity( ).
        IF lo_iamidentity IS NOT INITIAL.
          lv_string = lo_iamidentity->get_arn( ).
          lv_string = lo_iamidentity->get_principalid( ).
          lv_string = lo_iamidentity->get_sourceidentity( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.