DESCRIBETRANSITGATEWAYS()`¶

About DescribeTransitGateways¶

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBETRANSITGATEWAYS
  IMPORTING
    !IT_TRANSITGATEWAYIDS TYPE /AWS1/CL_EC2TGWIDSTRINGLIST_W=>TT_TRANSITGATEWAYIDSTRINGLIST 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_ec2describetgwsresult
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_transitgatewayids` `TYPE /AWS1/CL_EC2TGWIDSTRINGLIST_W=>TT_TRANSITGATEWAYIDSTRINGLIST` `TT_TRANSITGATEWAYIDSTRINGLIST`¶

The IDs of the transit gateways.

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

One or more filters. The possible values are:

options.propagation-default-route-table-id - The ID of the default propagation route table.

options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

options.association-default-route-table-id - The ID of the default association route table.

options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

options.dns-support - Indicates whether DNS support is enabled (enable | disable).

options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

state - The state of the transit gateway (available | deleted | deleting | modifying | pending).

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

tag-key - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

`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_ec2describetgwsresult` `/AWS1/CL_EC2DESCRIBETGWSRESULT`¶

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->describetransitgateways(
  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|
      )
    )
  )
  it_transitgatewayids = VALUE /aws1/cl_ec2tgwidstringlist_w=>tt_transitgatewayidstringlist(
    ( new /aws1/cl_ec2tgwidstringlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  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_transitgateways( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_transitgatewayid( ).
      lv_string = lo_row_1->get_transitgatewayarn( ).
      lv_transitgatewaystate = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_ownerid( ).
      lv_string = lo_row_1->get_description( ).
      lv_datetime = lo_row_1->get_creationtime( ).
      lo_transitgatewayoptions = lo_row_1->get_options( ).
      IF lo_transitgatewayoptions IS NOT INITIAL.
        lv_long = lo_transitgatewayoptions->get_amazonsideasn( ).
        LOOP AT lo_transitgatewayoptions->get_transitgatewaycidrblocks( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_autoacceptsharedattachm = lo_transitgatewayoptions->get_autoaccsharedattachments( ).
        lv_defaultroutetableassoci = lo_transitgatewayoptions->get_defroutetableassociation( ).
        lv_string = lo_transitgatewayoptions->get_associationdefroutetblid( ).
        lv_defaultroutetablepropag = lo_transitgatewayoptions->get_defroutetablepropagation( ).
        lv_string = lo_transitgatewayoptions->get_propagationdefroutetblid( ).
        lv_vpnecmpsupportvalue = lo_transitgatewayoptions->get_vpnecmpsupport( ).
        lv_dnssupportvalue = lo_transitgatewayoptions->get_dnssupport( ).
        lv_securitygroupreferencin = lo_transitgatewayoptions->get_secgroupreferencingsupp( ).
        lv_multicastsupportvalue = lo_transitgatewayoptions->get_multicastsupport( ).
      ENDIF.
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_key( ).
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBETRANSITGATEWAYS()¶