describe_internet_gateways¶
Operation¶
describe_internet_gateways
async
¶
describe_internet_gateways(request: DescribeInternetGatewaysInput | DescribeInternetGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeInternetGatewaysOutput
describe_internet_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInternetGatewaysInputDict]) -> DescribeInternetGatewaysOutput
Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet 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 |
|---|---|
DescribeInternetGatewaysOutput
|
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¶
DescribeInternetGatewaysInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInternetGatewaysInput 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.
-
attachment.state- The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. -
attachment.vpc-id- The ID of an attached VPC. -
internet-gateway-id- The ID of the Internet gateway. -
owner-id- The ID of the Amazon Web Services account that owns the internet gateway. -
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.
internet_gateway_ids
class-attribute
instance-attribute
¶
The IDs of the internet gateways.
Default: Describes all your internet gateways.
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.
Dictionaries¶
DescribeInternetGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of DescribeInternetGatewaysInput.
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.
-
attachment.state- The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. -
attachment.vpc-id- The ID of an attached VPC. -
internet-gateway-id- The ID of the Internet gateway. -
owner-id- The ID of the Amazon Web Services account that owns the internet gateway. -
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.
internet_gateway_ids
instance-attribute
¶
The IDs of the internet gateways.
Default: Describes all your internet gateways.
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.
Output¶
DescribeInternetGatewaysOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInternetGatewaysOutput structure.
Attributes¶
internet_gateways
class-attribute
instance-attribute
¶
internet_gateways: list[InternetGateway] | None = ...
Information about the internet 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.