aws_sdk_sesv2/client/list_multi_region_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 [`ListMultiRegionEndpoints`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from a previous call to <code>ListMultiRegionEndpoints</code> to indicate the position in the list of multi-region endpoints (global-endpoints).</p><br>
8 /// - [`page_size(i32)`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::set_page_size):<br>required: **false**<br><p>The number of results to show in a single call to <code>ListMultiRegionEndpoints</code>. If the number of results is larger than the number you specified in this parameter, the response includes a <code>NextToken</code> element that you can use to retrieve the next page of results.</p><br>
9 /// - On success, responds with [`ListMultiRegionEndpointsOutput`](crate::operation::list_multi_region_endpoints::ListMultiRegionEndpointsOutput) with field(s):
10 /// - [`multi_region_endpoints(Option<Vec::<MultiRegionEndpoint>>)`](crate::operation::list_multi_region_endpoints::ListMultiRegionEndpointsOutput::multi_region_endpoints): <p>An array that contains key multi-region endpoint (global-endpoint) properties.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_multi_region_endpoints::ListMultiRegionEndpointsOutput::next_token): <p>A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed. Pass this token to a subsequent <code>ListMultiRegionEndpoints</code> call to retrieve the next page.</p>
12 /// - On failure, responds with [`SdkError<ListMultiRegionEndpointsError>`](crate::operation::list_multi_region_endpoints::ListMultiRegionEndpointsError)
13 pub fn list_multi_region_endpoints(&self) -> crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder {
14 crate::operation::list_multi_region_endpoints::builders::ListMultiRegionEndpointsFluentBuilder::new(self.handle.clone())
15 }
16}