aws_sdk_mailmanager/client/
list_relays.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 [`ListRelays`](crate::operation::list_relays::builders::ListRelaysFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_relays::builders::ListRelaysFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`page_size(i32)`](crate::operation::list_relays::builders::ListRelaysFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_relays::builders::ListRelaysFluentBuilder::set_page_size):<br>required: **false**<br><p>The number of relays to be returned in one request.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_relays::builders::ListRelaysFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_relays::builders::ListRelaysFluentBuilder::set_next_token):<br>required: **false**<br><p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p><br>
9    /// - On success, responds with [`ListRelaysOutput`](crate::operation::list_relays::ListRelaysOutput) with field(s):
10    ///   - [`relays(Vec::<Relay>)`](crate::operation::list_relays::ListRelaysOutput::relays): <p>The list of returned relays.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_relays::ListRelaysOutput::next_token): <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
12    /// - On failure, responds with [`SdkError<ListRelaysError>`](crate::operation::list_relays::ListRelaysError)
13    pub fn list_relays(&self) -> crate::operation::list_relays::builders::ListRelaysFluentBuilder {
14        crate::operation::list_relays::builders::ListRelaysFluentBuilder::new(self.handle.clone())
15    }
16}