describe_vpc_peering_connections¶
Operation¶
describe_vpc_peering_connections
¶
describe_vpc_peering_connections(request: DescribeVpcPeeringConnectionsInput | DescribeVpcPeeringConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcPeeringConnectionsInputDict]) -> DescribeVpcPeeringConnectionsOutput
Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcPeeringConnectionsInput | DescribeVpcPeeringConnectionsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeVpcPeeringConnectionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcPeeringConnectionsOutput
|
An instance of |
describe_vpc_peering_connections
async
¶
describe_vpc_peering_connections(request: DescribeVpcPeeringConnectionsInput | DescribeVpcPeeringConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcPeeringConnectionsInputDict]) -> DescribeVpcPeeringConnectionsOutput
Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcPeeringConnectionsInput | DescribeVpcPeeringConnectionsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeVpcPeeringConnectionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcPeeringConnectionsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeVpcPeeringConnectionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpcPeeringConnectionsInput.
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.
-
accepter-vpc-info.cidr-block- The IPv4 CIDR block of the accepter VPC. -
accepter-vpc-info.owner-id- The ID of the Amazon Web Services account that owns the accepter VPC. -
accepter-vpc-info.vpc-id- The ID of the accepter VPC. -
expiration-time- The expiration date and time for the VPC peering connection. -
requester-vpc-info.cidr-block- The IPv4 CIDR block of the requester's VPC. -
requester-vpc-info.owner-id- The ID of the Amazon Web Services account that owns the requester VPC. -
requester-vpc-info.vpc-id- The ID of the requester VPC. -
status-code- The status of the VPC peering connection (pending-acceptance|failed|expired|provisioning|active|deleting|deleted|rejected). -
status-message- A message that provides more information about the status of the VPC peering connection, if applicable. -
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-peering-connection-id- The ID of the VPC peering connection.
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.
DescribeVpcPeeringConnectionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcPeeringConnectionsInput 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.
-
accepter-vpc-info.cidr-block- The IPv4 CIDR block of the accepter VPC. -
accepter-vpc-info.owner-id- The ID of the Amazon Web Services account that owns the accepter VPC. -
accepter-vpc-info.vpc-id- The ID of the accepter VPC. -
expiration-time- The expiration date and time for the VPC peering connection. -
requester-vpc-info.cidr-block- The IPv4 CIDR block of the requester's VPC. -
requester-vpc-info.owner-id- The ID of the Amazon Web Services account that owns the requester VPC. -
requester-vpc-info.vpc-id- The ID of the requester VPC. -
status-code- The status of the VPC peering connection (pending-acceptance|failed|expired|provisioning|active|deleting|deleted|rejected). -
status-message- A message that provides more information about the status of the VPC peering connection, if applicable. -
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-peering-connection-id- The ID of the VPC peering connection.
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.
Output¶
DescribeVpcPeeringConnectionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcPeeringConnectionsOutput 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.
vpc_peering_connections
class-attribute
instance-attribute
¶
vpc_peering_connections: list[VpcPeeringConnection] | None = ...
Information about the VPC peering connections.