aws_sdk_amplifybackend/client/
list_backend_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 [`ListBackendJobs`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_id(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_app_id):<br>required: **true**<br><p>The app ID.</p><br>
7    ///   - [`backend_environment_name(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::backend_environment_name) / [`set_backend_environment_name(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_backend_environment_name):<br>required: **true**<br><p>The name of the backend environment.</p><br>
8    ///   - [`job_id(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_job_id):<br>required: **false**<br><p>The ID for the job.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that you want in the response.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results.</p><br>
11    ///   - [`operation(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::operation) / [`set_operation(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_operation):<br>required: **false**<br><p>Filters the list of response objects to include only those with the specified operation name.</p><br>
12    ///   - [`status(impl Into<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::status) / [`set_status(Option<String>)`](crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::set_status):<br>required: **false**<br><p>Filters the list of response objects to include only those with the specified status.</p><br>
13    /// - On success, responds with [`ListBackendJobsOutput`](crate::operation::list_backend_jobs::ListBackendJobsOutput) with field(s):
14    ///   - [`jobs(Option<Vec::<BackendJobRespObj>>)`](crate::operation::list_backend_jobs::ListBackendJobsOutput::jobs): <p>An array of jobs and their properties.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_backend_jobs::ListBackendJobsOutput::next_token): <p>The token for the next set of results.</p>
16    /// - On failure, responds with [`SdkError<ListBackendJobsError>`](crate::operation::list_backend_jobs::ListBackendJobsError)
17    pub fn list_backend_jobs(&self) -> crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder {
18        crate::operation::list_backend_jobs::builders::ListBackendJobsFluentBuilder::new(self.handle.clone())
19    }
20}