Skip to content

/AWS1/IF_ORG=>LISTHANDSHAKESFORORG()

About ListHandshakesForOrganization

Lists the recent handshakes that you have sent.

You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted.

You can only call this operation from the management account or a member account that is a delegated administrator.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

Method Signature

METHODS /AWS1/IF_ORG~LISTHANDSHAKESFORORG
  IMPORTING
    !IO_FILTER TYPE REF TO /AWS1/CL_ORGHANDSHAKEFILTER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ORGNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ORGMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_orglsthandshakesfor03
  RAISING
    /AWS1/CX_ORGACCESSDENIEDEX
    /AWS1/CX_ORGAWSORGSNOTINUSEEX
    /AWS1/CX_ORGCONCURRENTMODEX
    /AWS1/CX_ORGINVALIDINPUTEX
    /AWS1/CX_ORGSERVICEEXCEPTION
    /AWS1/CX_ORGTOOMANYREQUESTSEX
    /AWS1/CX_ORGCLIENTEXC
    /AWS1/CX_ORGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

io_filter TYPE REF TO /AWS1/CL_ORGHANDSHAKEFILTER /AWS1/CL_ORGHANDSHAKEFILTER

A HandshakeFilter object. Contains the filer used to select the handshakes for an operation.

iv_nexttoken TYPE /AWS1/ORGNEXTTOKEN /AWS1/ORGNEXTTOKEN

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

iv_maxresults TYPE /AWS1/ORGMAXRESULTS /AWS1/ORGMAXRESULTS

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

RETURNING

oo_output TYPE REF TO /aws1/cl_orglsthandshakesfor03 /AWS1/CL_ORGLSTHANDSHAKESFOR03

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->listhandshakesfororg(
  io_filter = new /aws1/cl_orghandshakefilter(
    iv_actiontype = |string|
    iv_parenthandshakeid = |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_handshakes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_handshakeid = lo_row_1->get_id( ).
      lv_handshakearn = lo_row_1->get_arn( ).
      LOOP AT lo_row_1->get_parties( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_handshakepartyid = lo_row_3->get_id( ).
          lv_handshakepartytype = lo_row_3->get_type( ).
        ENDIF.
      ENDLOOP.
      lv_handshakestate = lo_row_1->get_state( ).
      lv_timestamp = lo_row_1->get_requestedtimestamp( ).
      lv_timestamp = lo_row_1->get_expirationtimestamp( ).
      lv_actiontype = lo_row_1->get_action( ).
      LOOP AT lo_row_1->get_resources( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_handshakeresourcevalue = lo_row_5->get_value( ).
          lv_handshakeresourcetype = lo_row_5->get_type( ).
          LOOP AT lo_row_5->get_resources( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_handshakeresourcevalue = lo_row_7->get_value( ).
              lv_handshakeresourcetype = lo_row_7->get_type( ).
              " Skipping lo_row_6 to avoid recursion
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To retrieve a list of the handshakes associated with an organization

The following example shows you how to get a list of handshakes associated with the current organization:

DATA(lo_result) = lo_client->listhandshakesfororg( ).