aws_sdk_mailmanager/client/
list_archive_searches.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 [`ListArchiveSearches`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`archive_id(impl Into<String>)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::archive_id) / [`set_archive_id(Option<String>)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::set_archive_id):<br>required: **true**<br><p>The identifier of the archive.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::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>
9    ///   - [`page_size(i32)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::set_page_size):<br>required: **false**<br><p>The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.</p><br>
10    /// - On success, responds with [`ListArchiveSearchesOutput`](crate::operation::list_archive_searches::ListArchiveSearchesOutput) with field(s):
11    ///   - [`searches(Option<Vec::<SearchSummary>>)`](crate::operation::list_archive_searches::ListArchiveSearchesOutput::searches): <p>The list of search job identifiers and statuses.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_archive_searches::ListArchiveSearchesOutput::next_token): <p>If present, use to retrieve the next page of results.</p>
13    /// - On failure, responds with [`SdkError<ListArchiveSearchesError>`](crate::operation::list_archive_searches::ListArchiveSearchesError)
14    pub fn list_archive_searches(&self) -> crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder {
15        crate::operation::list_archive_searches::builders::ListArchiveSearchesFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_mailmanager/client/list_archive_searches.rs

aws_sdk_mailmanager/client/
list_archive_searches.rs
