describe_network_acls¶
Operation¶
describe_network_acls
async
¶
describe_network_acls(request: DescribeNetworkAclsInput | DescribeNetworkAclsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeNetworkAclsOutput
describe_network_acls(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeNetworkAclsInputDict]) -> DescribeNetworkAclsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeNetworkAclsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeNetworkAclsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNetworkAclsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
filters
class-attribute
instance-attribute
¶
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|icmpor a protocol number). -
entry.rule-action- Allows or denies the matching traffic (allow|deny). -
entry.egress- A Boolean that indicates the type of rule. Specifytruefor egress rules, orfalsefor 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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
network_acl_ids
class-attribute
instance-attribute
¶
The IDs of the network ACLs.
Dictionaries¶
DescribeNetworkAclsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeNetworkAclsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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|icmpor a protocol number). -
entry.rule-action- Allows or denies the matching traffic (allow|deny). -
entry.egress- A Boolean that indicates the type of rule. Specifytruefor egress rules, orfalsefor 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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
max_results
instance-attribute
¶
max_results: int | None
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.
network_acl_ids
instance-attribute
¶
The IDs of the network ACLs.
Output¶
DescribeNetworkAclsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNetworkAclsOutput structure.
Attributes¶
network_acls
class-attribute
instance-attribute
¶
network_acls: list[NetworkAcl] | None = ...
Information about the network ACLs.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.