describe_client_vpn_endpoints¶
Operation¶
describe_client_vpn_endpoints
async
¶
describe_client_vpn_endpoints(request: DescribeClientVpnEndpointsInput | DescribeClientVpnEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeClientVpnEndpointsOutput
describe_client_vpn_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnEndpointsInputDict]) -> DescribeClientVpnEndpointsOutput
Describes one or more Client VPN endpoints in the account.
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 |
|---|---|
DescribeClientVpnEndpointsOutput
|
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¶
DescribeClientVpnEndpointsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnEndpointsInput structure.
Attributes¶
client_vpn_endpoint_ids
class-attribute
instance-attribute
¶
The ID of the Client VPN endpoint.
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. Filter names and values are case-sensitive.
-
endpoint-id- The ID of the Client VPN endpoint. -
transport-protocol- The transport protocol (tcp|udp).
Dictionaries¶
DescribeClientVpnEndpointsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeClientVpnEndpointsInput.
Attributes¶
client_vpn_endpoint_ids
instance-attribute
¶
The ID of the Client VPN endpoint.
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. Filter names and values are case-sensitive.
-
endpoint-id- The ID of the Client VPN endpoint. -
transport-protocol- The transport protocol (tcp|udp).
Output¶
DescribeClientVpnEndpointsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnEndpointsOutput structure.
Attributes¶
client_vpn_endpoints
class-attribute
instance-attribute
¶
client_vpn_endpoints: list[ClientVpnEndpoint] | None = ...
Information about the Client VPN endpoints.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results 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.