aws_sdk_backupsearch/client/
list_search_jobs.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListSearchJobs`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`by_status(SearchJobState)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::by_status) / [`set_by_status(Option<SearchJobState>)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::set_by_status):<br>required: **false**<br><p>Include this parameter to filter list by search job status.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned search jobs.</p> <p>For example, if a request is made to return <code>MaxResults</code> number of backups, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of resource list items to be returned.</p><br>
    /// - On success, responds with [`ListSearchJobsOutput`](crate::operation::list_search_jobs::ListSearchJobsOutput) with field(s):
    ///   - [`search_jobs(Vec::<SearchJobSummary>)`](crate::operation::list_search_jobs::ListSearchJobsOutput::search_jobs): <p>The search jobs among the list, with details of the returned search jobs.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_search_jobs::ListSearchJobsOutput::next_token): <p>The next item following a partial list of returned backups included in a search job.</p> <p>For example, if a request is made to return <code>MaxResults</code> number of backups, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
    /// - On failure, responds with [`SdkError<ListSearchJobsError>`](crate::operation::list_search_jobs::ListSearchJobsError)
    pub fn list_search_jobs(&self) -> crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder {
        crate::operation::list_search_jobs::builders::ListSearchJobsFluentBuilder::new(self.handle.clone())
    }
}