SEARCHAGENTS()`¶

About SearchAgents¶

Searches for agents based on specified filters.

Method Signature¶

METHODS /AWS1/IF_QST~SEARCHAGENTS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_QSTAGENTSEARCHFILTER=>TT_AGENTSEARCHFILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTAGENTSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTSTRING00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstsearchagentsrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /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 ID of the Amazon Web Services account that contains the agents.

`it_filters` `TYPE /AWS1/CL_QSTAGENTSEARCHFILTER=>TT_AGENTSEARCHFILTERLIST` `TT_AGENTSEARCHFILTERLIST`¶

The filters to apply when searching agents.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/QSTAGENTSMAXRESULTS` `/AWS1/QSTAGENTSMAXRESULTS`¶

The maximum number of results to return.

`iv_nexttoken` `TYPE /AWS1/QSTSTRING00` `/AWS1/QSTSTRING00`¶

The token for the next set of results, or null if there are no more results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstsearchagentsrsp` `/AWS1/CL_QSTSEARCHAGENTSRSP`¶

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->searchagents(
  it_filters = VALUE /aws1/cl_qstagentsearchfilter=>tt_agentsearchfilterlist(
    (
      new /aws1/cl_qstagentsearchfilter(
        iv_name = |string|
        iv_operator = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |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_agentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_agentarn = lo_row_1->get_arn( ).
      lv_agentid = lo_row_1->get_agentid( ).
      lv_agentname = lo_row_1->get_name( ).
      lv_agentdescription = lo_row_1->get_description( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lv_iconid = lo_row_1->get_iconid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.

/AWS1/IF_QST=>SEARCHAGENTS()¶