Skip to content

describe_client_vpn_target_networks

Operation

describe_client_vpn_target_networks

describe_client_vpn_target_networks(request: DescribeClientVpnTargetNetworksInput | DescribeClientVpnTargetNetworksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnTargetNetworksInputDict]) -> DescribeClientVpnTargetNetworksOutput

Describes the target networks associated with the specified Client VPN endpoint.

Parameters:

Name Type Description Default
request DescribeClientVpnTargetNetworksInput | DescribeClientVpnTargetNetworksInputDict | 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[DescribeClientVpnTargetNetworksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClientVpnTargetNetworksOutput

An instance of DescribeClientVpnTargetNetworksOutput.

describe_client_vpn_target_networks async

describe_client_vpn_target_networks(request: DescribeClientVpnTargetNetworksInput | DescribeClientVpnTargetNetworksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnTargetNetworksInputDict]) -> DescribeClientVpnTargetNetworksOutput

Describes the target networks associated with the specified Client VPN endpoint.

Parameters:

Name Type Description Default
request DescribeClientVpnTargetNetworksInput | DescribeClientVpnTargetNetworksInputDict | 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[DescribeClientVpnTargetNetworksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClientVpnTargetNetworksOutput

An instance of DescribeClientVpnTargetNetworksOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeClientVpnTargetNetworksInputDict

Bases: TypedDict

Dictionary form of DescribeClientVpnTargetNetworksInput.

Attributes

association_ids instance-attribute
association_ids: Sequence[str] | None

The IDs of the target network associations.

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

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.

  • association-id - The ID of the association.

  • target-network-id - The ID of the subnet specified as the target network.

  • vpc-id - The ID of the VPC in which the target network is located.

max_results instance-attribute
max_results: int | None

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

DescribeClientVpnTargetNetworksInput dataclass

Bases: _SerdeShape

Dataclass for DescribeClientVpnTargetNetworksInput structure.

Attributes

association_ids class-attribute instance-attribute
association_ids: list[str] | None = ...

The IDs of the target network associations.

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
filters: list[Filter] | None = ...

One or more filters. Filter names and values are case-sensitive.

  • association-id - The ID of the association.

  • target-network-id - The ID of the subnet specified as the target network.

  • vpc-id - The ID of the VPC in which the target network is located.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to retrieve the next page of results.

Output

DescribeClientVpnTargetNetworksOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeClientVpnTargetNetworksOutput structure.

Attributes

client_vpn_target_networks class-attribute instance-attribute
client_vpn_target_networks: list[TargetNetwork] | None = ...

Information about the associated target networks.

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
response_metadata: ResponseMetadata = ...

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.