aws_sdk_amplifyuibuilder/client/list_components.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 [`ListComponents`](crate::operation::list_components::builders::ListComponentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_components::builders::ListComponentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`app_id(impl Into<String>)`](crate::operation::list_components::builders::ListComponentsFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_components::builders::ListComponentsFluentBuilder::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_components::builders::ListComponentsFluentBuilder::environment_name) / [`set_environment_name(Option<String>)`](crate::operation::list_components::builders::ListComponentsFluentBuilder::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_components::builders::ListComponentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_components::builders::ListComponentsFluentBuilder::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_components::builders::ListComponentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_components::builders::ListComponentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of components to retrieve.</p><br>
11 /// - On success, responds with [`ListComponentsOutput`](crate::operation::list_components::ListComponentsOutput) with field(s):
12 /// - [`entities(Vec::<ComponentSummary>)`](crate::operation::list_components::ListComponentsOutput::entities): <p>The list of components for the Amplify app.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_components::ListComponentsOutput::next_token): <p>The pagination token that's included if more results are available.</p>
14 /// - On failure, responds with [`SdkError<ListComponentsError>`](crate::operation::list_components::ListComponentsError)
15 pub fn list_components(&self) -> crate::operation::list_components::builders::ListComponentsFluentBuilder {
16 crate::operation::list_components::builders::ListComponentsFluentBuilder::new(self.handle.clone())
17 }
18}