STARTDATACOLLBYAGENTIDS()`¶

About StartDataCollectionByAgentIds¶

Instructs the specified agents to start collecting data.

Method Signature¶

METHODS /AWS1/IF_ADS~STARTDATACOLLBYAGENTIDS
  IMPORTING
    !IT_AGENTIDS TYPE /AWS1/CL_ADSAGENTIDS_W=>TT_AGENTIDS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_adsstrtdatacollbyag01
  RAISING
    /AWS1/CX_ADSAUTHERROREXCEPTION
    /AWS1/CX_ADSHOMEREGIONNOTSETEX
    /AWS1/CX_ADSINVALIDPARAMETEREX
    /AWS1/CX_ADSINVPARAMVALUEEX
    /AWS1/CX_ADSSERVERINTERNALER00
    /AWS1/CX_ADSCLIENTEXC
    /AWS1/CX_ADSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_agentids` `TYPE /AWS1/CL_ADSAGENTIDS_W=>TT_AGENTIDS` `TT_AGENTIDS`¶

The IDs of the agents from which to start collecting data. If you send a request to an agent ID that you do not have permission to contact, according to your Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents and you do not have permission to contact some of those agents, the system does not throw an exception. Instead, the system shows Failed in the Description field.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_adsstrtdatacollbyag01` `/AWS1/CL_ADSSTRTDATACOLLBYAG01`¶

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->startdatacollbyagentids(
  it_agentids = VALUE /aws1/cl_adsagentids_w=>tt_agentids(
    ( new /aws1/cl_adsagentids_w( |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_agentsconfstatus( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_agentid( ).
      lv_boolean = lo_row_1->get_operationsucceeded( ).
      lv_string = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_ADS=>STARTDATACOLLBYAGENTIDS()¶