describe_client_vpn_routes¶
Operation¶
describe_client_vpn_routes
¶
describe_client_vpn_routes(request: DescribeClientVpnRoutesInput | DescribeClientVpnRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnRoutesInputDict]) -> DescribeClientVpnRoutesOutput
Describes the routes for the specified Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeClientVpnRoutesInput | DescribeClientVpnRoutesInputDict | 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[DescribeClientVpnRoutesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeClientVpnRoutesOutput
|
An instance of |
describe_client_vpn_routes
async
¶
describe_client_vpn_routes(request: DescribeClientVpnRoutesInput | DescribeClientVpnRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnRoutesInputDict]) -> DescribeClientVpnRoutesOutput
Describes the routes for the specified Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeClientVpnRoutesInput | DescribeClientVpnRoutesInputDict | 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[DescribeClientVpnRoutesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeClientVpnRoutesOutput
|
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.
DescribeClientVpnRoutesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeClientVpnRoutesInput.
Attributes¶
client_vpn_endpoint_id
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.
-
destination-cidr- The CIDR of the route destination. -
origin- How the route was associated with the Client VPN endpoint (associate|add-route). -
target-subnet- The ID of the subnet through which traffic is routed.
DescribeClientVpnRoutesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnRoutesInput structure.
Attributes¶
client_vpn_endpoint_id
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
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.
-
destination-cidr- The CIDR of the route destination. -
origin- How the route was associated with the Client VPN endpoint (associate|add-route). -
target-subnet- The ID of the subnet through which traffic is routed.
Output¶
DescribeClientVpnRoutesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeClientVpnRoutesOutput structure.
Attributes¶
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.
routes
class-attribute
instance-attribute
¶
routes: list[ClientVpnRoute] | None = ...
Information about the Client VPN endpoint routes.