describe_vpcs¶
Operation¶
describe_vpcs
async
¶
describe_vpcs(request: DescribeVpcsInput | DescribeVpcsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVpcsOutput
describe_vpcs(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcsInputDict]) -> DescribeVpcsOutput
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs 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 |
|---|---|
DescribeVpcsOutput
|
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¶
DescribeVpcsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcsInput 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.
-
cidr- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example,/28). -
cidr-block-association.cidr-block- An IPv4 CIDR block associated with the VPC. -
cidr-block-association.association-id- The association ID for an IPv4 CIDR block associated with the VPC. -
cidr-block-association.state- The state of an IPv4 CIDR block associated with the VPC. -
dhcp-options-id- The ID of a set of DHCP options. -
ipv6-cidr-block-association.ipv6-cidr-block- An IPv6 CIDR block associated with the VPC. -
ipv6-cidr-block-association.ipv6-pool- The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. -
ipv6-cidr-block-association.association-id- The association ID for an IPv6 CIDR block associated with the VPC. -
ipv6-cidr-block-association.state- The state of an IPv6 CIDR block associated with the VPC. -
is-default- Indicates whether the VPC is the default VPC. -
owner-id- The ID of the Amazon Web Services account that owns the VPC. -
state- The state of the VPC (pending|available). -
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.
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¶
DescribeVpcsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpcsInput.
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.
-
cidr- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example,/28). -
cidr-block-association.cidr-block- An IPv4 CIDR block associated with the VPC. -
cidr-block-association.association-id- The association ID for an IPv4 CIDR block associated with the VPC. -
cidr-block-association.state- The state of an IPv4 CIDR block associated with the VPC. -
dhcp-options-id- The ID of a set of DHCP options. -
ipv6-cidr-block-association.ipv6-cidr-block- An IPv6 CIDR block associated with the VPC. -
ipv6-cidr-block-association.ipv6-pool- The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. -
ipv6-cidr-block-association.association-id- The association ID for an IPv6 CIDR block associated with the VPC. -
ipv6-cidr-block-association.state- The state of an IPv6 CIDR block associated with the VPC. -
is-default- Indicates whether the VPC is the default VPC. -
owner-id- The ID of the Amazon Web Services account that owns the VPC. -
state- The state of the VPC (pending|available). -
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.
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¶
DescribeVpcsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcsOutput structure.
Attributes¶
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.