aws_sdk_amplify/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    ///   - [`app_id(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for an Amplify app.</p><br>
8    ///   - [`branch_name(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::branch_name) / [`set_branch_name(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_branch_name):<br>required: **true**<br><p>The name of the branch to use for the request.</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>A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.</p><br>
10    ///   - [`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>The maximum number of records to list in a single response.</p><br>
11    /// - On success, responds with [`ListJobsOutput`](crate::operation::list_jobs::ListJobsOutput) with field(s):
12    ///   - [`job_summaries(Vec::<JobSummary>)`](crate::operation::list_jobs::ListJobsOutput::job_summaries): <p>The result structure for the list job result request.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_jobs::ListJobsOutput::next_token): <p>A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.</p>
14    /// - On failure, responds with [`SdkError<ListJobsError>`](crate::operation::list_jobs::ListJobsError)
15    pub fn list_jobs(&self) -> crate::operation::list_jobs::builders::ListJobsFluentBuilder {
16        crate::operation::list_jobs::builders::ListJobsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_amplify/client/list_jobs.rs

aws_sdk_amplify/client/
list_jobs.rs
