aws_sdk_amplifyuibuilder/client/
list_codegen_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 [`ListCodegenJobs`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`app_id(impl Into<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for the Amplify app.</p><br>
8    ///   - [`environment_name(impl Into<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::environment_name) / [`set_environment_name(Option<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::set_environment_name):<br>required: **true**<br><p>The name of the backend environment that is a part of the Amplify app.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to request the next page of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of jobs to retrieve.</p><br>
11    /// - On success, responds with [`ListCodegenJobsOutput`](crate::operation::list_codegen_jobs::ListCodegenJobsOutput) with field(s):
12    ///   - [`entities(Vec::<CodegenJobSummary>)`](crate::operation::list_codegen_jobs::ListCodegenJobsOutput::entities): <p>The list of code generation jobs for the Amplify app.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_codegen_jobs::ListCodegenJobsOutput::next_token): <p>The pagination token that's included if more results are available.</p>
14    /// - On failure, responds with [`SdkError<ListCodegenJobsError>`](crate::operation::list_codegen_jobs::ListCodegenJobsError)
15    pub fn list_codegen_jobs(&self) -> crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder {
16        crate::operation::list_codegen_jobs::builders::ListCodegenJobsFluentBuilder::new(self.handle.clone())
17    }
18}