Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This operation returns paginated results.
Synopsis
- data DescribeNetworkAcls = DescribeNetworkAcls' {}
- newDescribeNetworkAcls :: DescribeNetworkAcls
- describeNetworkAcls_dryRun :: Lens' DescribeNetworkAcls (Maybe Bool)
- describeNetworkAcls_filters :: Lens' DescribeNetworkAcls (Maybe [Filter])
- describeNetworkAcls_maxResults :: Lens' DescribeNetworkAcls (Maybe Natural)
- describeNetworkAcls_networkAclIds :: Lens' DescribeNetworkAcls (Maybe [Text])
- describeNetworkAcls_nextToken :: Lens' DescribeNetworkAcls (Maybe Text)
- data DescribeNetworkAclsResponse = DescribeNetworkAclsResponse' {
- networkAcls :: Maybe [NetworkAcl]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeNetworkAclsResponse :: Int -> DescribeNetworkAclsResponse
- describeNetworkAclsResponse_networkAcls :: Lens' DescribeNetworkAclsResponse (Maybe [NetworkAcl])
- describeNetworkAclsResponse_nextToken :: Lens' DescribeNetworkAclsResponse (Maybe Text)
- describeNetworkAclsResponse_httpStatus :: Lens' DescribeNetworkAclsResponse Int
Creating a Request
data DescribeNetworkAcls Source #
See: newDescribeNetworkAcls
smart constructor.
DescribeNetworkAcls' | |
|
Instances
newDescribeNetworkAcls :: DescribeNetworkAcls Source #
Create a value of DescribeNetworkAcls
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeNetworkAcls'
, describeNetworkAcls_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
.
$sel:filters:DescribeNetworkAcls'
, describeNetworkAcls_filters
- One or more 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. Specifytrue
for egress rules, orfalse
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
$sel:maxResults:DescribeNetworkAcls'
, describeNetworkAcls_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:networkAclIds:DescribeNetworkAcls'
, describeNetworkAcls_networkAclIds
- One or more network ACL IDs.
Default: Describes all your network ACLs.
DescribeNetworkAcls
, describeNetworkAcls_nextToken
- The token for the next page of results.
Request Lenses
describeNetworkAcls_dryRun :: Lens' DescribeNetworkAcls (Maybe Bool) Source #
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
.
describeNetworkAcls_filters :: Lens' DescribeNetworkAcls (Maybe [Filter]) Source #
One or more 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. Specifytrue
for egress rules, orfalse
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
describeNetworkAcls_maxResults :: Lens' DescribeNetworkAcls (Maybe Natural) Source #
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
describeNetworkAcls_networkAclIds :: Lens' DescribeNetworkAcls (Maybe [Text]) Source #
One or more network ACL IDs.
Default: Describes all your network ACLs.
describeNetworkAcls_nextToken :: Lens' DescribeNetworkAcls (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeNetworkAclsResponse Source #
See: newDescribeNetworkAclsResponse
smart constructor.
DescribeNetworkAclsResponse' | |
|
Instances
newDescribeNetworkAclsResponse Source #
Create a value of DescribeNetworkAclsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:networkAcls:DescribeNetworkAclsResponse'
, describeNetworkAclsResponse_networkAcls
- Information about one or more network ACLs.
DescribeNetworkAcls
, describeNetworkAclsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeNetworkAclsResponse'
, describeNetworkAclsResponse_httpStatus
- The response's http status code.
Response Lenses
describeNetworkAclsResponse_networkAcls :: Lens' DescribeNetworkAclsResponse (Maybe [NetworkAcl]) Source #
Information about one or more network ACLs.
describeNetworkAclsResponse_nextToken :: Lens' DescribeNetworkAclsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeNetworkAclsResponse_httpStatus :: Lens' DescribeNetworkAclsResponse Int Source #
The response's http status code.