aws_sdk_opensearchserverless/client/
list_vpc_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 [`ListVpcEndpoints`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`vpc_endpoint_filters(VpcEndpointFilters)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::vpc_endpoint_filters) / [`set_vpc_endpoint_filters(Option<VpcEndpointFilters>)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::set_vpc_endpoint_filters):<br>required: **false**<br><p>Filter the results according to the current status of the VPC endpoint. Possible statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p><br>
10    /// - On success, responds with [`ListVpcEndpointsOutput`](crate::operation::list_vpc_endpoints::ListVpcEndpointsOutput) with field(s):
11    ///   - [`vpc_endpoint_summaries(Option<Vec::<VpcEndpointSummary>>)`](crate::operation::list_vpc_endpoints::ListVpcEndpointsOutput::vpc_endpoint_summaries): <p>Details about each VPC endpoint, including the name and current status.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_vpc_endpoints::ListVpcEndpointsOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
13    /// - On failure, responds with [`SdkError<ListVpcEndpointsError>`](crate::operation::list_vpc_endpoints::ListVpcEndpointsError)
14    pub fn list_vpc_endpoints(&self) -> crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder {
15        crate::operation::list_vpc_endpoints::builders::ListVpcEndpointsFluentBuilder::new(self.handle.clone())
16    }
17}