aws_sdk_cloudtrail/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    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::set_name_prefix):<br>required: **false**<br><p>Specify a name prefix to filter on.</p><br>
7    ///   - [`r#type(DashboardType)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::type) / [`set_type(Option<DashboardType>)`](crate::operation::list_dashboards::builders::ListDashboardsFluentBuilder::set_type):<br>required: **false**<br><p>Specify a dashboard type to filter on: <code>CUSTOM</code> or <code>MANAGED</code>.</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>A token you can use to get the next page of dashboard 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 dashboards to display on a single page.</p><br>
10    /// - On success, responds with [`ListDashboardsOutput`](crate::operation::list_dashboards::ListDashboardsOutput) with field(s):
11    ///   - [`dashboards(Option<Vec::<DashboardDetail>>)`](crate::operation::list_dashboards::ListDashboardsOutput::dashboards): <p>Contains information about dashboards in the account, in the current Region that match the applied filters.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_dashboards::ListDashboardsOutput::next_token): <p>A token you can use to get the next page of dashboard 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}