aws_sdk_bcmdashboards/client/
list_dashboards.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 [`ListDashboards`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call. The default value is 20.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results. Use the value returned in the previous response.</p><br>
9    /// - On success, responds with [`ListDashboardsOutput`](crate::operation::list_dashboards::ListDashboardsOutput) with field(s):
10    ///   - [`dashboards(Vec::<DashboardReference>)`](crate::operation::list_dashboards::ListDashboardsOutput::dashboards): <p>An array of dashboard references, containing basic information about each dashboard.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_dashboards::ListDashboardsOutput::next_token): <p>The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.</p>
12    /// - On failure, responds with [`SdkError<ListDashboardsError>`](crate::operation::list_dashboards::ListDashboardsError)
13    pub fn list_dashboards(&self) -> crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder {
14        crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::new(self.handle.clone())
15    }
16}