aws_sdk_iotsitewise/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    ///   - [`project_id(impl Into<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::project_id) / [`set_project_id(Option<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::set_project_id):<br>required: **true**<br><p>The ID of the project.</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 to be used for the next set of paginated results.</p><br>
9    ///   - [`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 for each paginated request.</p> <p>Default: 50</p><br>
10    /// - On success, responds with [`ListDashboardsOutput`](crate::operation::list_dashboards::ListDashboardsOutput) with field(s):
11    ///   - [`dashboard_summaries(Vec::<DashboardSummary>)`](crate::operation::list_dashboards::ListDashboardsOutput::dashboard_summaries): <p>A list that summarizes each dashboard in the project.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_dashboards::ListDashboardsOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
13    /// - On failure, responds with [`SdkError<ListDashboardsError>`](crate::operation::list_dashboards::ListDashboardsError)
14    pub fn list_dashboards(&self) -> crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder {
15        crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::new(self.handle.clone())
16    }
17}