aws_sdk_amplify/client/
list_branches.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 [`ListBranches`](crate::operation::list_branches::builders::ListBranchesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`app_id(impl Into<String>)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for an Amplify app.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_branches::builders::ListBranchesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of records to list in a single response.</p><br>
10    /// - On success, responds with [`ListBranchesOutput`](crate::operation::list_branches::ListBranchesOutput) with field(s):
11    ///   - [`branches(Vec::<Branch>)`](crate::operation::list_branches::ListBranchesOutput::branches): <p>A list of branches for an Amplify app.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_branches::ListBranchesOutput::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>
13    /// - On failure, responds with [`SdkError<ListBranchesError>`](crate::operation::list_branches::ListBranchesError)
14    pub fn list_branches(&self) -> crate::operation::list_branches::builders::ListBranchesFluentBuilder {
15        crate::operation::list_branches::builders::ListBranchesFluentBuilder::new(self.handle.clone())
16    }
17}