aws_sdk_eventbridge/client/
list_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 [`ListEndpoints`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_name_prefix):<br>required: **false**<br><p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p><br>
7    ///   - [`home_region(impl Into<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::home_region) / [`set_home_region(Option<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_home_region):<br>required: **false**<br><p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p>Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results returned by the call.</p><br>
10    /// - On success, responds with [`ListEndpointsOutput`](crate::operation::list_endpoints::ListEndpointsOutput) with field(s):
11    ///   - [`endpoints(Option<Vec::<Endpoint>>)`](crate::operation::list_endpoints::ListEndpointsOutput::endpoints): <p>The endpoints returned by the call.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_endpoints::ListEndpointsOutput::next_token): <p>A token indicating there are more results available. If there are no more results, no token is included in the response.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p>Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>
13    /// - On failure, responds with [`SdkError<ListEndpointsError>`](crate::operation::list_endpoints::ListEndpointsError)
14    pub fn list_endpoints(&self) -> crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder {
15        crate::operation::list_endpoints::builders::ListEndpointsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_eventbridge/client/list_endpoints.rs

aws_sdk_eventbridge/client/
list_endpoints.rs
