DESCRIBECUSTOMERGATEWAYS()`¶

About DescribeCustomerGateways¶

Describes one or more of your VPN customer 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¶

METHODS /AWS1/IF_EC2~DESCRIBECUSTOMERGATEWAYS
  IMPORTING
    !IT_CUSTOMERGATEWAYIDS TYPE /AWS1/CL_EC2CUSGWIDSTRLIST_W=>TT_CUSTOMERGATEWAYIDSTRINGLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrcusgwsresult
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_customergatewayids` `TYPE /AWS1/CL_EC2CUSGWIDSTRLIST_W=>TT_CUSTOMERGATEWAYIDSTRINGLIST` `TT_CUSTOMERGATEWAYIDSTRINGLIST`¶

One or more customer gateway IDs.

Default: Describes all your customer gateways.

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

One or more filters.

bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

ip-address - The IP address of the customer gateway device's external interface.

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

type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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.

`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_ec2descrcusgwsresult` `/AWS1/CL_EC2DESCRCUSGWSRESULT`¶

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->describecustomergateways(
  it_customergatewayids = VALUE /aws1/cl_ec2cusgwidstrlist_w=>tt_customergatewayidstringlist(
    ( new /aws1/cl_ec2cusgwidstrlist_w( |string| ) )
  )
  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
).

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_customergateways( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_certificatearn( ).
      lv_string = lo_row_1->get_devicename( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_bgpasnextended( ).
      lv_string = lo_row_1->get_customergatewayid( ).
      lv_string = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_type( ).
      lv_string = lo_row_1->get_ipaddress( ).
      lv_string = lo_row_1->get_bgpasn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe a customer gateway¶

This example describes the specified customer gateway.

DATA(lo_result) = lo_client->describecustomergateways(
  it_customergatewayids = VALUE /aws1/cl_ec2cusgwidstrlist_w=>tt_customergatewayidstringlist(
    ( new /aws1/cl_ec2cusgwidstrlist_w( |cgw-0e11f167| ) )
  )
).

/AWS1/IF_EC2=>DESCRIBECUSTOMERGATEWAYS()¶