DESCRIBEVPCS()`¶

About DescribeVpcs¶

Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.

Method Signature¶

IMPORTING¶

Optional arguments:¶

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

The filters.

cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

dhcp-options-id - The ID of a set of DHCP options.

ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

is-default - Indicates whether the VPC is the default VPC.

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

state - The state of the VPC (pending | available).

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.

vpc-id - The ID of the VPC.

`it_vpcids` `TYPE /AWS1/CL_EC2VPCIDSTRINGLIST_W=>TT_VPCIDSTRINGLIST` `TT_VPCIDSTRINGLIST`¶

The IDs of the VPCs.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

`iv_maxresults` `TYPE /AWS1/EC2DESCRVPCSMAXRESULTS` `/AWS1/EC2DESCRVPCSMAXRESULTS`¶

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

`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_ec2describevpcsresult` `/AWS1/CL_EC2DESCRIBEVPCSRESULT`¶

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~describevpcs(
  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_vpcids = VALUE /aws1/cl_ec2vpcidstringlist_w=>tt_vpcidstringlist(
    ( new /aws1/cl_ec2vpcidstringlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lv_string = lo_result->get_nexttoken( ).
LOOP AT lo_result->get_vpcs( ) into lo_row.
  lv_string = lo_row_1->get_ownerid( ).
  lv_tenancy = lo_row_1->get_instancetenancy( ).
  LOOP AT lo_row_1->get_ipv6cidrblkassociation00( ) into lo_row_2.
    lv_string = lo_row_3->get_associationid( ).
    lv_string = lo_row_3->get_ipv6cidrblock( ).
    lv_vpccidrblockstatecode = lo_vpccidrblockstate->get_state( ).
    lv_string = lo_vpccidrblockstate->get_statusmessage( ).
    lv_string = lo_row_3->get_networkbordergroup( ).
    lv_string = lo_row_3->get_ipv6pool( ).
    lv_ipv6addressattribute = lo_row_3->get_ipv6addressattribute( ).
    lv_ipsource = lo_row_3->get_ipsource( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_cidrblockassociationset( ) into lo_row_4.
    lv_string = lo_row_5->get_associationid( ).
    lv_string = lo_row_5->get_cidrblock( ).
    lv_vpccidrblockstatecode = lo_vpccidrblockstate->get_state( ).
    lv_string = lo_vpccidrblockstate->get_statusmessage( ).
  ENDLOOP.
  lv_boolean = lo_row_1->get_isdefault( ).
  lv_vpcid = lo_vpcencryptioncontrol->get_vpcid( ).
  lv_vpcencryptioncontrolid = lo_vpcencryptioncontrol->get_vpcencryptioncontrolid( ).
  lv_vpcencryptioncontrolmod = lo_vpcencryptioncontrol->get_mode( ).
  lv_vpcencryptioncontrolsta = lo_vpcencryptioncontrol->get_state( ).
  lv_string = lo_vpcencryptioncontrol->get_statemessage( ).
  lv_vpcencryptioncontrolexc_2 = lo_vpcencryptioncontrolexc_1->get_state( ).
  lv_string = lo_vpcencryptioncontrolexc_1->get_statemessage( ).
  lv_vpcencryptioncontrolexc_2 = lo_vpcencryptioncontrolexc_1->get_state( ).
  lv_string = lo_vpcencryptioncontrolexc_1->get_statemessage( ).
  lv_vpcencryptioncontrolexc_2 = lo_vpcencryptioncontrolexc_1->get_state( ).
  lv_string = lo_vpcencryptioncontrolexc_1->get_statemessage( ).
  lv_vpcencryptioncontrolexc_2 = lo_vpcencryptioncontrolexc_1->get_state( ).
  lv_string = lo_vpcencryptioncontrolexc_1->get_statemessage( ).
  lv_vpcencryptioncontrolexc_2 = lo_vpcencryptioncontrolexc_1->get_state( ).
  lv_string = lo_vpcencryptioncontrolexc_1->get_statemessage( ).
  LOOP AT lo_vpcencryptioncontrol->get_tags( ) into lo_row_6.
    lv_string = lo_row_7->get_key( ).
    lv_string = lo_row_7->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_tags( ) into lo_row_6.
    lv_string = lo_row_7->get_key( ).
    lv_string = lo_row_7->get_value( ).
  ENDLOOP.
  lv_blockpublicaccessmode = lo_blockpublicaccessstates->get_internetgatewayblockmode( ).
  lv_string = lo_row_1->get_vpcid( ).
  lv_vpcstate = lo_row_1->get_state( ).
  lv_string = lo_row_1->get_cidrblock( ).
  lv_string = lo_row_1->get_dhcpoptionsid( ).
ENDLOOP.

To describe a VPC¶

This example describes the specified VPC.

DATA(lo_result) = lo_client->/aws1/if_ec2~describevpcs(
  it_vpcids = VALUE /aws1/cl_ec2vpcidstringlist_w=>tt_vpcidstringlist(
    ( new /aws1/cl_ec2vpcidstringlist_w( |vpc-a01106c2| ) )
  )
).

/AWS1/CL_EC2=>DESCRIBEVPCS()¶