DESCRIBERCSAGENTS()`¶

About DescribeRcsAgents¶

Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account.

If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.

Method Signature¶

METHODS /AWS1/IF_PP2~DESCRIBERCSAGENTS
  IMPORTING
    !IT_RCSAGENTIDS TYPE /AWS1/CL_PP2RCSAGENTIDLIST_W=>TT_RCSAGENTIDLIST OPTIONAL
    !IV_OWNER TYPE /AWS1/PP2OWNER OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_PP2RCSAGENTFILTER=>TT_RCSAGENTFILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PP2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PP2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2descrrcsagentsrslt
  RAISING
    /AWS1/CX_PP2ACCESSDENIEDEX
    /AWS1/CX_PP2INTERNALSERVEREX
    /AWS1/CX_PP2RESOURCENOTFOUNDEX
    /AWS1/CX_PP2THROTTLINGEX
    /AWS1/CX_PP2VALIDATIONEX
    /AWS1/CX_PP2CLIENTEXC
    /AWS1/CX_PP2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_rcsagentids` `TYPE /AWS1/CL_PP2RCSAGENTIDLIST_W=>TT_RCSAGENTIDLIST` `TT_RCSAGENTIDLIST`¶

An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

`iv_owner` `TYPE /AWS1/PP2OWNER` `/AWS1/PP2OWNER`¶

Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.

`it_filters` `TYPE /AWS1/CL_PP2RCSAGENTFILTER=>TT_RCSAGENTFILTERLIST` `TT_RCSAGENTFILTERLIST`¶

An array of RcsAgentFilter objects to filter the results.

`iv_nexttoken` `TYPE /AWS1/PP2NEXTTOKEN` `/AWS1/PP2NEXTTOKEN`¶

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

`iv_maxresults` `TYPE /AWS1/PP2MAXRESULTS` `/AWS1/PP2MAXRESULTS`¶

The maximum number of results to return per each request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2descrrcsagentsrslt` `/AWS1/CL_PP2DESCRRCSAGENTSRSLT`¶

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->describercsagents(
  it_filters = VALUE /aws1/cl_pp2rcsagentfilter=>tt_rcsagentfilterlist(
    (
      new /aws1/cl_pp2rcsagentfilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_rcsagentids = VALUE /aws1/cl_pp2rcsagentidlist_w=>tt_rcsagentidlist(
    ( new /aws1/cl_pp2rcsagentidlist_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_owner = |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_rcsagents( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_rcsagentarn( ).
      lv_string = lo_row_1->get_rcsagentid( ).
      lv_rcsagentstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdtimestamp( ).
      lv_primitiveboolean = lo_row_1->get_deletionprotectionenbd( ).
      lv_optoutlistname = lo_row_1->get_optoutlistname( ).
      lv_primitiveboolean = lo_row_1->get_selfmanagedoptoutsenbd( ).
      lv_twowaychannelarn = lo_row_1->get_twowaychannelarn( ).
      lv_iamrolearn = lo_row_1->get_twowaychannelrole( ).
      lv_primitiveboolean = lo_row_1->get_twowayenabled( ).
      lv_string = lo_row_1->get_poolid( ).
      lo_testingagentinformation = lo_row_1->get_testingagent( ).
      IF lo_testingagentinformation IS NOT INITIAL.
        lv_testingagentstatus = lo_testingagentinformation->get_status( ).
        lv_string = lo_testingagentinformation->get_testingagentid( ).
        lv_string = lo_testingagentinformation->get_registrationid( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PP2=>DESCRIBERCSAGENTS()¶