aws_sdk_quicksight/client/
search_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 [`SearchDashboards`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.</p><br>
8    ///   - [`filters(DashboardSearchFilter)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::filters) / [`set_filters(Option<Vec::<DashboardSearchFilter>>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::set_filters):<br>required: **true**<br><p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>"Filters": \[ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } \]</code></p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results, or null if there are no more results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to be returned per request.</p><br>
11    /// - On success, responds with [`SearchDashboardsOutput`](crate::operation::search_dashboards::SearchDashboardsOutput) with field(s):
12    ///   - [`dashboard_summary_list(Option<Vec::<DashboardSummary>>)`](crate::operation::search_dashboards::SearchDashboardsOutput::dashboard_summary_list): <p>The list of dashboards owned by the user specified in <code>Filters</code> in your request.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::search_dashboards::SearchDashboardsOutput::next_token): <p>The token for the next set of results, or null if there are no more results.</p>
14    ///   - [`status(i32)`](crate::operation::search_dashboards::SearchDashboardsOutput::status): <p>The HTTP status of the request.</p>
15    ///   - [`request_id(Option<String>)`](crate::operation::search_dashboards::SearchDashboardsOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
16    /// - On failure, responds with [`SdkError<SearchDashboardsError>`](crate::operation::search_dashboards::SearchDashboardsError)
17    pub fn search_dashboards(&self) -> crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder {
18        crate::operation::search_dashboards::builders::SearchDashboardsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_quicksight/client/search_dashboards.rs

aws_sdk_quicksight/client/
search_dashboards.rs
