REGISTERAGENT()`¶

About RegisterAgent¶

For use by AWS Ground Station Agent and shouldn't be called directly.

Registers a new agent with AWS Ground Station.

Method Signature¶

METHODS /AWS1/IF_GST~REGISTERAGENT
  IMPORTING
    !IO_DISCOVERYDATA TYPE REF TO /AWS1/CL_GSTDISCOVERYDATA OPTIONAL
    !IO_AGENTDETAILS TYPE REF TO /AWS1/CL_GSTAGENTDETAILS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_GSTTAGSMAP_W=>TT_TAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gstregagentresponse
  RAISING
    /AWS1/CX_GSTDEPENDENCYEX
    /AWS1/CX_GSTINVALIDPARAMETEREX
    /AWS1/CX_GSTRESOURCENOTFOUNDEX
    /AWS1/CX_GSTCLIENTEXC
    /AWS1/CX_GSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_discoverydata` `TYPE REF TO /AWS1/CL_GSTDISCOVERYDATA` `/AWS1/CL_GSTDISCOVERYDATA`¶

Data for associating an agent with the capabilities it is managing.

`io_agentdetails` `TYPE REF TO /AWS1/CL_GSTAGENTDETAILS` `/AWS1/CL_GSTAGENTDETAILS`¶

Detailed information about the agent being registered.

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_GSTTAGSMAP_W=>TT_TAGSMAP` `TT_TAGSMAP`¶

Tags assigned to an Agent.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gstregagentresponse` `/AWS1/CL_GSTREGAGENTRESPONSE`¶

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->registeragent(
  io_agentdetails = new /aws1/cl_gstagentdetails(
    it_agentcpucores = VALUE /aws1/cl_gstagentcpucoreslst_w=>tt_agentcpucoreslist(
      ( new /aws1/cl_gstagentcpucoreslst_w( 123 ) )
    )
    it_componentversions = VALUE /aws1/cl_gstcomponentversion=>tt_componentversionlist(
      (
        new /aws1/cl_gstcomponentversion(
          it_versions = VALUE /aws1/cl_gstvrsstringlist_w=>tt_versionstringlist(
            ( new /aws1/cl_gstvrsstringlist_w( |string| ) )
          )
          iv_componenttype = |string|
        )
      )
    )
    it_reservedcpucores = VALUE /aws1/cl_gstagentcpucoreslst_w=>tt_agentcpucoreslist(
      ( new /aws1/cl_gstagentcpucoreslst_w( 123 ) )
    )
    iv_agentversion = |string|
    iv_instanceid = |string|
    iv_instancetype = |string|
  )
  io_discoverydata = new /aws1/cl_gstdiscoverydata(
    it_capabilityarns = VALUE /aws1/cl_gstcapabilityarnlst_w=>tt_capabilityarnlist(
      ( new /aws1/cl_gstcapabilityarnlst_w( |string| ) )
    )
    it_privateipaddresses = VALUE /aws1/cl_gstipaddresslist_w=>tt_ipaddresslist(
      ( new /aws1/cl_gstipaddresslist_w( |string| ) )
    )
    it_publicipaddresses = VALUE /aws1/cl_gstipaddresslist_w=>tt_ipaddresslist(
      ( new /aws1/cl_gstipaddresslist_w( |string| ) )
    )
  )
  it_tags = VALUE /aws1/cl_gsttagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_gsttagsmap_w=>ts_tagsmap_maprow(
        value = new /aws1/cl_gsttagsmap_w( |string| )
        key = |string|
      )
    )
  )
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uuid = lo_result->get_agentid( ).
ENDIF.

/AWS1/IF_GST=>REGISTERAGENT()¶