aws_sdk_amplify/client/list_artifacts.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 [`ListArtifacts`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`app_id(impl Into<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for an Amplify app.</p><br>
7 /// - [`branch_name(impl Into<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::branch_name) / [`set_branch_name(Option<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::set_branch_name):<br>required: **true**<br><p>The name of a branch that is part of an Amplify app.</p><br>
8 /// - [`job_id(impl Into<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::set_job_id):<br>required: **true**<br><p>The unique ID for a job.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.</p><br>
10 /// - [`max_results(i32)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::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 [`ListArtifactsOutput`](crate::operation::list_artifacts::ListArtifactsOutput) with field(s):
12 /// - [`artifacts(Vec::<Artifact>)`](crate::operation::list_artifacts::ListArtifactsOutput::artifacts): <p>A list of artifacts.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_artifacts::ListArtifactsOutput::next_token): <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
14 /// - On failure, responds with [`SdkError<ListArtifactsError>`](crate::operation::list_artifacts::ListArtifactsError)
15 pub fn list_artifacts(&self) -> crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder {
16 crate::operation::list_artifacts::builders::ListArtifactsFluentBuilder::new(self.handle.clone())
17 }
18}