describe_vpn_connections¶
Operation¶
describe_vpn_connections
¶
describe_vpn_connections(request: DescribeVpnConnectionsInput | DescribeVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpnConnectionsInputDict]) -> DescribeVpnConnectionsOutput
Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpnConnectionsInput | DescribeVpnConnectionsInputDict | 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[DescribeVpnConnectionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpnConnectionsOutput
|
An instance of |
describe_vpn_connections
async
¶
describe_vpn_connections(request: DescribeVpnConnectionsInput | DescribeVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpnConnectionsInputDict]) -> DescribeVpnConnectionsOutput
Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpnConnectionsInput | DescribeVpnConnectionsInputDict | 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[DescribeVpnConnectionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpnConnectionsOutput
|
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.
DescribeVpnConnectionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpnConnectionsInput.
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
One or more filters.
-
customer-gateway-configuration- The configuration information for the customer gateway. -
customer-gateway-id- The ID of a customer gateway associated with the VPN connection. -
state- The state of the VPN connection (pending|available|deleting|deleted). -
option.static-routes-only- Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). -
route.destination-cidr-block- The destination CIDR block. This corresponds to the subnet used in a customer data center. -
bgp-asn- The BGP Autonomous System Number (ASN) associated with a BGP device. -
tag:<key>- 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. -
type- The type of VPN connection. Currently the only supported type isipsec.1. -
vpn-connection-id- The ID of the VPN connection. -
vpn-gateway-id- The ID of a virtual private gateway associated with the VPN connection. -
transit-gateway-id- The ID of a transit gateway associated with the VPN connection.
DescribeVpnConnectionsInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeVpnConnections.
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
¶
One or more filters.
-
customer-gateway-configuration- The configuration information for the customer gateway. -
customer-gateway-id- The ID of a customer gateway associated with the VPN connection. -
state- The state of the VPN connection (pending|available|deleting|deleted). -
option.static-routes-only- Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). -
route.destination-cidr-block- The destination CIDR block. This corresponds to the subnet used in a customer data center. -
bgp-asn- The BGP Autonomous System Number (ASN) associated with a BGP device. -
tag:<key>- 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. -
type- The type of VPN connection. Currently the only supported type isipsec.1. -
vpn-connection-id- The ID of the VPN connection. -
vpn-gateway-id- The ID of a virtual private gateway associated with the VPN connection. -
transit-gateway-id- The ID of a transit gateway associated with the VPN connection.
Output¶
DescribeVpnConnectionsOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeVpnConnections.
Attributes¶
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.
vpn_connections
class-attribute
instance-attribute
¶
vpn_connections: list[VpnConnection] | None = ...
Information about one or more VPN connections.