Skip to content

Describe Network Acls

ec2_describe_network_acls R Documentation

Describes your network ACLs

Description

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.

Usage

ec2_describe_network_acls(Filters, DryRun, NetworkAclIds, NextToken,
  MaxResults)

Arguments

Filters

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:\<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.

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

DryRun

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.

NetworkAclIds

The IDs of the network ACLs.

NextToken

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

MaxResults

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.

Value

A list with the following syntax: 

list(
  NetworkAcls = list(
    list(
      Associations = list(
        list(
          NetworkAclAssociationId = "string",
          NetworkAclId = "string",
          SubnetId = "string"
        )
      ),
      Entries = list(
        list(
          CidrBlock = "string",
          Egress = TRUE|FALSE,
          IcmpTypeCode = list(
            Code = 123,
            Type = 123
          ),
          Ipv6CidrBlock = "string",
          PortRange = list(
            From = 123,
            To = 123
          ),
          Protocol = "string",
          RuleAction = "allow"|"deny",
          RuleNumber = 123
        )
      ),
      IsDefault = TRUE|FALSE,
      NetworkAclId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VpcId = "string",
      OwnerId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_network_acls(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  NetworkAclIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example describes the specified network ACL.
svc$describe_network_acls(
  NetworkAclIds = list(
    "acl-5fb85d36"
  )
)

## End(Not run)