SEARCHTGWMULTICASTGROUPS()`¶

About SearchTransitGatewayMulticastGroups¶

Searches one or more transit gateway multicast groups and returns the group membership information.

Method Signature¶

METHODS /AWS1/IF_EC2~SEARCHTGWMULTICASTGROUPS
  IMPORTING
    !IV_TGWMULTICASTDOMAINID TYPE /AWS1/EC2TGWMULTICASTDOMAINID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2TGWMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2srchtgwmulticast01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_tgwmulticastdomainid` `TYPE /AWS1/EC2TGWMULTICASTDOMAINID` `/AWS1/EC2TGWMULTICASTDOMAINID`¶

The ID of the transit gateway multicast domain.

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

One or more filters. The possible values are:

group-ip-address - The IP address of the transit gateway multicast group.

is-group-member - The resource is a group member. Valid values are true | false.

is-group-source - The resource is a group source. Valid values are true | false.

member-type - The member type. Valid values are igmp | static.

resource-id - The ID of the resource.

resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.

source-type - The source type. Valid values are igmp | static.

subnet-id - The ID of the subnet.

transit-gateway-attachment-id - The id of the transit gateway attachment.

`iv_maxresults` `TYPE /AWS1/EC2TGWMAXRESULTS` `/AWS1/EC2TGWMAXRESULTS`¶

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token for the next page of results.

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2srchtgwmulticast01` `/AWS1/CL_EC2SRCHTGWMULTICAST01`¶

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->searchtgwmulticastgroups(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_tgwmulticastdomainid = |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_multicastgroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_groupipaddress( ).
      lv_string = lo_row_1->get_tgwattachmentid( ).
      lv_string = lo_row_1->get_subnetid( ).
      lv_string = lo_row_1->get_resourceid( ).
      lv_transitgatewayattachmen = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_resourceownerid( ).
      lv_string = lo_row_1->get_networkinterfaceid( ).
      lv_boolean = lo_row_1->get_groupmember( ).
      lv_boolean = lo_row_1->get_groupsource( ).
      lv_membershiptype = lo_row_1->get_membertype( ).
      lv_membershiptype = lo_row_1->get_sourcetype( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>SEARCHTGWMULTICASTGROUPS()¶