aws_sdk_quicksight/client/
describe_dashboard.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 [`DescribeDashboard`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p><br>
7    ///   - [`dashboard_id(impl Into<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::dashboard_id) / [`set_dashboard_id(Option<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::set_dashboard_id):<br>required: **true**<br><p>The ID for the dashboard.</p><br>
8    ///   - [`version_number(i64)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::version_number) / [`set_version_number(Option<i64>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::set_version_number):<br>required: **false**<br><p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.</p><br>
9    ///   - [`alias_name(impl Into<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::alias_name) / [`set_alias_name(Option<String>)`](crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::set_alias_name):<br>required: **false**<br><p>The alias name.</p><br>
10    /// - On success, responds with [`DescribeDashboardOutput`](crate::operation::describe_dashboard::DescribeDashboardOutput) with field(s):
11    ///   - [`dashboard(Option<Dashboard>)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard): <p>Information about the dashboard.</p>
12    ///   - [`status(i32)`](crate::operation::describe_dashboard::DescribeDashboardOutput::status): <p>The HTTP status of this request.</p>
13    ///   - [`request_id(Option<String>)`](crate::operation::describe_dashboard::DescribeDashboardOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
14    /// - On failure, responds with [`SdkError<DescribeDashboardError>`](crate::operation::describe_dashboard::DescribeDashboardError)
15    pub fn describe_dashboard(&self) -> crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder {
16        crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::new(self.handle.clone())
17    }
18}