aws_sdk_mailmanager/client/
start_archive_search.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 [`StartArchiveSearch`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`archive_id(impl Into<String>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::archive_id) / [`set_archive_id(Option<String>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::set_archive_id):<br>required: **true**<br><p>The identifier of the archive to search emails in.</p><br>
7    ///   - [`filters(ArchiveFilters)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::filters) / [`set_filters(Option<ArchiveFilters>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::set_filters):<br>required: **false**<br><p>Criteria to filter which emails are included in the search results.</p><br>
8    ///   - [`from_timestamp(DateTime)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::from_timestamp) / [`set_from_timestamp(Option<DateTime>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::set_from_timestamp):<br>required: **true**<br><p>The start timestamp of the range to search emails from.</p><br>
9    ///   - [`to_timestamp(DateTime)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::to_timestamp) / [`set_to_timestamp(Option<DateTime>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::set_to_timestamp):<br>required: **true**<br><p>The end timestamp of the range to search emails from.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::set_max_results):<br>required: **true**<br><p>The maximum number of search results to return.</p><br>
11    /// - On success, responds with [`StartArchiveSearchOutput`](crate::operation::start_archive_search::StartArchiveSearchOutput) with field(s):
12    ///   - [`search_id(Option<String>)`](crate::operation::start_archive_search::StartArchiveSearchOutput::search_id): <p>The unique identifier for the initiated search job.</p>
13    /// - On failure, responds with [`SdkError<StartArchiveSearchError>`](crate::operation::start_archive_search::StartArchiveSearchError)
14    pub fn start_archive_search(&self) -> crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder {
15        crate::operation::start_archive_search::builders::StartArchiveSearchFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_mailmanager/client/start_archive_search.rs

aws_sdk_mailmanager/client/
start_archive_search.rs
