Skip to content

describe_client_vpn_target_networks async

describe_client_vpn_target_networks(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[ClientVpnEndpointId] = None,
    association_ids: Optional[ValueStringList] = None,
    max_results: Optional[DescribeClientVpnTargetNetworksMaxResults] = None,
    next_token: Optional[NextToken] = None,
    filters: Optional[FilterList] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeClientVpnTargetNetworksResult

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

Parameters:

  • client_vpn_endpoint_id (Optional[ClientVpnEndpointId], default: None ) –

    The ID of the Client VPN endpoint.

  • association_ids (Optional[ValueStringList], default: None ) –

    The IDs of the target network associations.

  • max_results (Optional[DescribeClientVpnTargetNetworksMaxResults], default: 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 (Optional[NextToken], default: None ) –

    The token to retrieve the next page of results.

  • filters (Optional[FilterList], default: 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.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_client_vpn_target_networks(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    association_ids: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    max_results: Optional[
        "capo_ec2.types.describe_client_vpn_target_networks_max_results.DescribeClientVpnTargetNetworksMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_client_vpn_target_networks_result.DescribeClientVpnTargetNetworksResult":
    """<p>Describes the target networks associated with the specified Client VPN endpoint.</p>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN endpoint.</p>
        association_ids: <p>The IDs of the target network associations.</p>
        max_results: <p>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.</p>
        next_token: <p>The token to retrieve the next page of results.</p>
        filters: <p>One or more filters. Filter names and values are case-sensitive.</p> <ul> <li> <p> <code>association-id</code> - The ID of the association.</p> </li> <li> <p> <code>target-network-id</code> - The ID of the subnet specified as the target network.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC in which the target network is located.</p> </li> </ul>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_client_vpn_target_networks_request.DescribeClientVpnTargetNetworksRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_client_vpn_target_networks_result.DescribeClientVpnTargetNetworksResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_client_vpn_target_networks

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_client_vpn_target_networks.async_describe_client_vpn_target_networks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClientVpnTargetNetworks")
    )
    input_: capo_ec2.types.describe_client_vpn_target_networks_request.DescribeClientVpnTargetNetworksRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_id
    if association_ids is not None:
        input_["association_ids"] = association_ids
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output