describe_vpn_concentrators¶
Operation¶
describe_vpn_concentrators
async
¶
describe_vpn_concentrators(request: DescribeVpnConcentratorsInput | DescribeVpnConcentratorsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVpnConcentratorsOutput
describe_vpn_concentrators(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpnConcentratorsInputDict]) -> DescribeVpnConcentratorsOutput
Describes one or more of your VPN concentrators.
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 |
|---|---|
DescribeVpnConcentratorsOutput
|
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¶
DescribeVpnConcentratorsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpnConcentratorsInput 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
¶
One or more filters to limit the results.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
Dictionaries¶
DescribeVpnConcentratorsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpnConcentratorsInput.
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 to limit the results.
Output¶
DescribeVpnConcentratorsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpnConcentratorsOutput 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.
vpn_concentrators
class-attribute
instance-attribute
¶
vpn_concentrators: list[VpnConcentrator] | None = ...
Information about the VPN concentrators.