describe_nat_gateways¶
Operation¶
describe_nat_gateways
async
¶
describe_nat_gateways(request: DescribeNatGatewaysInput | DescribeNatGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeNatGatewaysOutput
describe_nat_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeNatGatewaysInputDict]) -> DescribeNatGatewaysOutput
Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.
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 |
|---|---|
DescribeNatGatewaysOutput
|
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¶
DescribeNatGatewaysInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNatGatewaysInput 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.
filter
class-attribute
instance-attribute
¶
The filters.
-
nat-gateway-id- The ID of the NAT gateway. -
state- The state of the NAT gateway (pending|failed|available|deleting|deleted). -
subnet-id- The ID of the subnet in which the NAT gateway resides. -
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 in which the NAT gateway resides.
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.
nat_gateway_ids
class-attribute
instance-attribute
¶
The IDs of the NAT gateways.
Dictionaries¶
DescribeNatGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of DescribeNatGatewaysInput.
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.
filter
instance-attribute
¶
filter: Sequence[Filter | FilterDict] | None
The filters.
-
nat-gateway-id- The ID of the NAT gateway. -
state- The state of the NAT gateway (pending|failed|available|deleting|deleted). -
subnet-id- The ID of the subnet in which the NAT gateway resides. -
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 in which the NAT gateway resides.
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.
nat_gateway_ids
instance-attribute
¶
The IDs of the NAT gateways.
Output¶
DescribeNatGatewaysOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNatGatewaysOutput structure.
Attributes¶
nat_gateways
class-attribute
instance-attribute
¶
nat_gateways: list[NatGateway] | None = ...
Information about the NAT gateways.
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.