Skip to content

/AWS1/IF_QST=>DESCRIBEACTIONCONNECTOR()

About DescribeActionConnector

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.

Method Signature

METHODS /AWS1/IF_QST~DESCRIBEACTIONCONNECTOR
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_ACTIONCONNECTORID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescractcnctorrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The Amazon Web Services account ID that contains the action connector.

iv_actionconnectorid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The unique identifier of the action connector to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstdescractcnctorrsp /AWS1/CL_QSTDESCRACTCNCTORRSP

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->describeactionconnector(
  iv_actionconnectorid = |string|
  iv_awsaccountid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_actionconnector = lo_result->get_actionconnector( ).
  IF lo_actionconnector IS NOT INITIAL.
    lv_arn = lo_actionconnector->get_arn( ).
    lv_shortrestrictiveresourc = lo_actionconnector->get_actionconnectorid( ).
    lv_actionconnectortype = lo_actionconnector->get_type( ).
    lv_actionconnectorname = lo_actionconnector->get_name( ).
    lv_timestamp = lo_actionconnector->get_createdtime( ).
    lv_timestamp = lo_actionconnector->get_lastupdatedtime( ).
    lv_resourcestatus = lo_actionconnector->get_status( ).
    lo_actionconnectorerror = lo_actionconnector->get_error( ).
    IF lo_actionconnectorerror IS NOT INITIAL.
      lv_string = lo_actionconnectorerror->get_message( ).
      lv_actionconnectorerrortyp = lo_actionconnectorerror->get_type( ).
    ENDIF.
    lv_actionconnectordescript = lo_actionconnector->get_description( ).
    lo_readauthconfig = lo_actionconnector->get_authenticationconfig( ).
    IF lo_readauthconfig IS NOT INITIAL.
      lv_connectionauthtype = lo_readauthconfig->get_authenticationtype( ).
      lo_readauthenticationmetad = lo_readauthconfig->get_authenticationmetadata( ).
      IF lo_readauthenticationmetad IS NOT INITIAL.
        lo_readauthorizationcodegr = lo_readauthenticationmetad->get_authcodegrantmetadata( ).
        IF lo_readauthorizationcodegr IS NOT INITIAL.
          lv_endpoint = lo_readauthorizationcodegr->get_baseendpoint( ).
          lv_endpoint = lo_readauthorizationcodegr->get_redirecturl( ).
          lo_readauthorizationcodegr_1 = lo_readauthorizationcodegr->get_readauthcodegrantcreds00( ).
          IF lo_readauthorizationcodegr_1 IS NOT INITIAL.
            lo_readauthorizationcodegr_2 = lo_readauthorizationcodegr_1->get_readauthcodegrantdetails( ).
            IF lo_readauthorizationcodegr_2 IS NOT INITIAL.
              lv_clientid = lo_readauthorizationcodegr_2->get_clientid( ).
              lv_endpoint = lo_readauthorizationcodegr_2->get_tokenendpoint( ).
              lv_endpoint = lo_readauthorizationcodegr_2->get_authorizationendpoint( ).
            ENDIF.
          ENDIF.
          lv_authorizationcodegrantc = lo_readauthorizationcodegr->get_authcodegrantcredssource( ).
        ENDIF.
        lo_readclientcredentialsgr = lo_readauthenticationmetad->get_clientcredsgrantmetadata( ).
        IF lo_readclientcredentialsgr IS NOT INITIAL.
          lv_endpoint = lo_readclientcredentialsgr->get_baseendpoint( ).
          lo_readclientcredentialsde = lo_readclientcredentialsgr->get_readclientcredsdetails( ).
          IF lo_readclientcredentialsde IS NOT INITIAL.
            lo_readclientcredentialsgr_1 = lo_readclientcredentialsde->get_readclientcredsgrantdets( ).
            IF lo_readclientcredentialsgr_1 IS NOT INITIAL.
              lv_clientid = lo_readclientcredentialsgr_1->get_clientid( ).
              lv_endpoint = lo_readclientcredentialsgr_1->get_tokenendpoint( ).
            ENDIF.
          ENDIF.
          lv_clientcredentialssource = lo_readclientcredentialsgr->get_clientcredentialssource( ).
        ENDIF.
        lo_readbasicauthconnection = lo_readauthenticationmetad->get_basicauthconnmetadata( ).
        IF lo_readbasicauthconnection IS NOT INITIAL.
          lv_endpoint = lo_readbasicauthconnection->get_baseendpoint( ).
          lv_actionusername = lo_readbasicauthconnection->get_username( ).
        ENDIF.
        lo_readapikeyconnectionmet = lo_readauthenticationmetad->get_apikeyconnectionmetadata( ).
        IF lo_readapikeyconnectionmet IS NOT INITIAL.
          lv_endpoint = lo_readapikeyconnectionmet->get_baseendpoint( ).
          lv_email = lo_readapikeyconnectionmet->get_email( ).
        ENDIF.
        lo_readnoneconnectionmetad = lo_readauthenticationmetad->get_noneconnectionmetadata( ).
        IF lo_readnoneconnectionmetad IS NOT INITIAL.
          lv_endpoint = lo_readnoneconnectionmetad->get_baseendpoint( ).
        ENDIF.
        lo_readiamconnectionmetada = lo_readauthenticationmetad->get_iamconnectionmetadata( ).
        IF lo_readiamconnectionmetada IS NOT INITIAL.
          lv_rolearn = lo_readiamconnectionmetada->get_rolearn( ).
          lv_resourcearn = lo_readiamconnectionmetada->get_sourcearn( ).
        ENDIF.
      ENDIF.
    ENDIF.
    LOOP AT lo_actionconnector->get_enabledactions( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_actionid = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_arn = lo_actionconnector->get_vpcconnectionarn( ).
  ENDIF.
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.