DESCRIBEHANDSHAKE()`¶

About DescribeHandshake¶

Returns details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.

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

You can call this operation from any account in a organization.

Method Signature¶

METHODS /AWS1/IF_ORG~DESCRIBEHANDSHAKE
  IMPORTING
    !IV_HANDSHAKEID TYPE /AWS1/ORGHANDSHAKEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_orgdescrhandshakersp
  RAISING
    /AWS1/CX_ORGACCESSDENIEDEX
    /AWS1/CX_ORGCONCURRENTMODEX
    /AWS1/CX_ORGHANDSHAKENOTFNDEX
    /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¶

Required arguments:¶

`iv_handshakeid` `TYPE /AWS1/ORGHANDSHAKEID` `/AWS1/ORGHANDSHAKEID`¶

ID for the handshake that you want information about.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_orgdescrhandshakersp` `/AWS1/CL_ORGDESCRHANDSHAKERSP`¶

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->describehandshake( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_handshake = lo_result->get_handshake( ).
  IF lo_handshake IS NOT INITIAL.
    lv_handshakeid = lo_handshake->get_id( ).
    lv_handshakearn = lo_handshake->get_arn( ).
    LOOP AT lo_handshake->get_parties( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_handshakepartyid = lo_row_1->get_id( ).
        lv_handshakepartytype = lo_row_1->get_type( ).
      ENDIF.
    ENDLOOP.
    lv_handshakestate = lo_handshake->get_state( ).
    lv_timestamp = lo_handshake->get_requestedtimestamp( ).
    lv_timestamp = lo_handshake->get_expirationtimestamp( ).
    lv_actiontype = lo_handshake->get_action( ).
    LOOP AT lo_handshake->get_resources( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_handshakeresourcevalue = lo_row_3->get_value( ).
        lv_handshakeresourcetype = lo_row_3->get_type( ).
        LOOP AT lo_row_3->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( ).
            " Skipping lo_row_4 to avoid recursion
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

To get information about a handshake¶

The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization":

DATA(lo_result) = lo_client->describehandshake( |h-examplehandshakeid111| ).

/AWS1/IF_ORG=>DESCRIBEHANDSHAKE()¶