Skip to main content

aws_sdk_location/client/
list_jobs.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 [`ListJobs`](crate::operation::list_jobs::builders::ListJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filter(JobsFilter)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::filter) / [`set_filter(Option<JobsFilter>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_filter):<br>required: **false**<br><p>An optional structure containing criteria by which to filter job results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of jobs to return.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p><br>
10    /// - On success, responds with [`ListJobsOutput`](crate::operation::list_jobs::ListJobsOutput) with field(s):
11    ///   - [`entries(Vec::<ListJobsResponseEntry>)`](crate::operation::list_jobs::ListJobsOutput::entries): <p>List of jobs in your Amazon Web Services account.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_jobs::ListJobsOutput::next_token): <p>Token for retrieving the next page (present if more results available).</p>
13    /// - On failure, responds with [`SdkError<ListJobsError>`](crate::operation::list_jobs::ListJobsError)
14    pub fn list_jobs(&self) -> crate::operation::list_jobs::builders::ListJobsFluentBuilder {
15        crate::operation::list_jobs::builders::ListJobsFluentBuilder::new(self.handle.clone())
16    }
17}