aws_sdk_mailmanager/client/list_archives.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 [`ListArchives`](crate::operation::list_archives::builders::ListArchivesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
8 /// - [`page_size(i32)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_page_size):<br>required: **false**<br><p>The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.</p><br>
9 /// - On success, responds with [`ListArchivesOutput`](crate::operation::list_archives::ListArchivesOutput) with field(s):
10 /// - [`archives(Vec::<Archive>)`](crate::operation::list_archives::ListArchivesOutput::archives): <p>The list of archive details.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_archives::ListArchivesOutput::next_token): <p>If present, use to retrieve the next page of results.</p>
12 /// - On failure, responds with [`SdkError<ListArchivesError>`](crate::operation::list_archives::ListArchivesError)
13 pub fn list_archives(&self) -> crate::operation::list_archives::builders::ListArchivesFluentBuilder {
14 crate::operation::list_archives::builders::ListArchivesFluentBuilder::new(self.handle.clone())
15 }
16}