/AWS1/CL_EC2=>DESCRIBEVPNGATEWAYS()

About DescribeVpnGateways

Describes one or more of your virtual private gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Method Signature

IMPORTING

Optional arguments:

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

• tag: - 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.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

it_vpngatewayids TYPE /AWS1/CL_EC2VPNGWIDSTRLIST_W=>TT_VPNGATEWAYIDSTRINGLIST TT_VPNGATEWAYIDSTRINGLIST

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

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_ec2descrvpngwsresult /AWS1/CL_EC2DESCRVPNGWSRESULT

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->/aws1/if_ec2~describevpngateways(
  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_vpngatewayids = VALUE /aws1/cl_ec2vpngwidstrlist_w=>tt_vpngatewayidstringlist(
    ( new /aws1/cl_ec2vpngwidstrlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
).

This is an example of reading all possible response values

LOOP AT lo_result->get_vpngateways( ) into lo_row.
  lv_long = lo_row_1->get_amazonsideasn( ).
  LOOP AT lo_row_1->get_tags( ) into lo_row_2.
    lv_string = lo_row_3->get_key( ).
    lv_string = lo_row_3->get_value( ).
  ENDLOOP.
  lv_string = lo_row_1->get_vpngatewayid( ).
  lv_vpnstate = lo_row_1->get_state( ).
  lv_gatewaytype = lo_row_1->get_type( ).
  lv_string = lo_row_1->get_availabilityzone( ).
  LOOP AT lo_row_1->get_vpcattachments( ) into lo_row_4.
    lv_string = lo_row_5->get_vpcid( ).
    lv_attachmentstatus = lo_row_5->get_state( ).
  ENDLOOP.
ENDLOOP.