aws_sdk_ec2/client/
describe_client_vpn_endpoints.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeClientVpnEndpoints`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`client_vpn_endpoint_ids(impl Into<String>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::client_vpn_endpoint_ids) / [`set_client_vpn_endpoint_ids(Option<Vec::<String>>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::set_client_vpn_endpoint_ids):<br>required: **false**<br><p>The ID of the Client VPN endpoint.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to retrieve the next page of results.</p><br>
10    ///   - [`filters(Filter)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters. Filter names and values are case-sensitive.</p> <ul>  <li>   <p><code>endpoint-id</code> - The ID of the Client VPN endpoint.</p></li>  <li>   <p><code>transport-protocol</code> - The transport protocol (<code>tcp</code> | <code>udp</code>).</p></li> </ul><br>
11    ///   - [`dry_run(bool)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
12    /// - On success, responds with [`DescribeClientVpnEndpointsOutput`](crate::operation::describe_client_vpn_endpoints::DescribeClientVpnEndpointsOutput) with field(s):
13    ///   - [`client_vpn_endpoints(Option<Vec::<ClientVpnEndpoint>>)`](crate::operation::describe_client_vpn_endpoints::DescribeClientVpnEndpointsOutput::client_vpn_endpoints): <p>Information about the Client VPN endpoints.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_client_vpn_endpoints::DescribeClientVpnEndpointsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
15    /// - On failure, responds with [`SdkError<DescribeClientVpnEndpointsError>`](crate::operation::describe_client_vpn_endpoints::DescribeClientVpnEndpointsError)
16    pub fn describe_client_vpn_endpoints(
17        &self,
18    ) -> crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder {
19        crate::operation::describe_client_vpn_endpoints::builders::DescribeClientVpnEndpointsFluentBuilder::new(self.handle.clone())
20    }
21}