Skip to content

/AWS1/IF_EC2=>DESCRIBENETWORKACLS()

About DescribeNetworkAcls

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

For more information, see Network ACLs in the Amazon VPC User Guide.

Method Signature

METHODS /AWS1/IF_EC2~DESCRIBENETWORKACLS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCNETWORKACLSMAXRSS OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_NETWORKACLIDS TYPE /AWS1/CL_EC2NETWORKACLIDSTRL00=>TT_NETWORKACLIDSTRINGLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscnetworkaclsrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

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/EC2DSCNETWORKACLSMAXRSS /AWS1/EC2DSCNETWORKACLSMAXRSS

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.

it_networkaclids TYPE /AWS1/CL_EC2NETWORKACLIDSTRL00=>TT_NETWORKACLIDSTRINGLIST TT_NETWORKACLIDSTRINGLIST

The IDs of the network ACLs.

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

The filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the Amazon Web Services account that owns the network ACL.

  • 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 for the network ACL.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2dscnetworkaclsrs /AWS1/CL_EC2DSCNETWORKACLSRS

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->describenetworkacls(
  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_networkaclids = VALUE /aws1/cl_ec2networkaclidstrl00=>tt_networkaclidstringlist(
    ( new /aws1/cl_ec2networkaclidstrl00( |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_networkacls( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_associations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_networkaclassociationid( ).
          lv_string = lo_row_3->get_networkaclid( ).
          lv_string = lo_row_3->get_subnetid( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_entries( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_cidrblock( ).
          lv_boolean = lo_row_5->get_egress( ).
          lo_icmptypecode = lo_row_5->get_icmptypecode( ).
          IF lo_icmptypecode IS NOT INITIAL.
            lv_integer = lo_icmptypecode->get_code( ).
            lv_integer = lo_icmptypecode->get_type( ).
          ENDIF.
          lv_string = lo_row_5->get_ipv6cidrblock( ).
          lo_portrange = lo_row_5->get_portrange( ).
          IF lo_portrange IS NOT INITIAL.
            lv_integer = lo_portrange->get_from( ).
            lv_integer = lo_portrange->get_to( ).
          ENDIF.
          lv_string = lo_row_5->get_protocol( ).
          lv_ruleaction = lo_row_5->get_ruleaction( ).
          lv_integer = lo_row_5->get_rulenumber( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_isdefault( ).
      lv_string = lo_row_1->get_networkaclid( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_key( ).
          lv_string = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_vpcid( ).
      lv_string = lo_row_1->get_ownerid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe a network ACL

This example describes the specified network ACL.

DATA(lo_result) = lo_client->describenetworkacls(
  it_networkaclids = VALUE /aws1/cl_ec2networkaclidstrl00=>tt_networkaclidstringlist(
    ( new /aws1/cl_ec2networkaclidstrl00( |acl-5fb85d36| ) )
  )
).