describe_customer_gateways¶
Operation¶
describe_customer_gateways
async
¶
describe_customer_gateways(request: DescribeCustomerGatewaysInput | DescribeCustomerGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCustomerGatewaysOutput
describe_customer_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCustomerGatewaysInputDict]) -> DescribeCustomerGatewaysOutput
Describes one or more of your VPN customer gateways.
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 |
|---|---|---|---|
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 |
|---|---|
DescribeCustomerGatewaysOutput
|
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¶
DescribeCustomerGatewaysInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeCustomerGateways.
Attributes¶
customer_gateway_ids
class-attribute
instance-attribute
¶
One or more customer gateway IDs.
Default: Describes all your customer gateways.
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.
-
bgp-asn- The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). -
customer-gateway-id- The ID of the customer gateway. -
ip-address- The IP address of the customer gateway device's external interface. -
state- The state of the customer gateway (pending|available|deleting|deleted). -
type- The type of customer gateway. Currently, the only supported type isipsec.1. -
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.
Dictionaries¶
DescribeCustomerGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCustomerGatewaysInput.
Attributes¶
customer_gateway_ids
instance-attribute
¶
One or more customer gateway IDs.
Default: Describes all your customer gateways.
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.
-
bgp-asn- The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). -
customer-gateway-id- The ID of the customer gateway. -
ip-address- The IP address of the customer gateway device's external interface. -
state- The state of the customer gateway (pending|available|deleting|deleted). -
type- The type of customer gateway. Currently, the only supported type isipsec.1. -
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.
Output¶
DescribeCustomerGatewaysOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeCustomerGateways.
Attributes¶
customer_gateways
class-attribute
instance-attribute
¶
customer_gateways: list[CustomerGateway] | None = ...
Information about one or more customer gateways.
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.