aws_sdk_bcmdashboards/client/
get_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 [`GetDashboard`](crate::operation::get_dashboard::builders::GetDashboardFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`arn(impl Into<String>)`](crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::set_arn):<br>required: **true**<br><p>The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.</p><br>
7    /// - On success, responds with [`GetDashboardOutput`](crate::operation::get_dashboard::GetDashboardOutput) with field(s):
8    ///   - [`arn(String)`](crate::operation::get_dashboard::GetDashboardOutput::arn): <p>The ARN of the retrieved dashboard.</p>
9    ///   - [`name(String)`](crate::operation::get_dashboard::GetDashboardOutput::name): <p>The name of the retrieved dashboard.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_dashboard::GetDashboardOutput::description): <p>The description of the retrieved dashboard.</p>
11    ///   - [`r#type(DashboardType)`](crate::operation::get_dashboard::GetDashboardOutput::type): <p>Indicates the dashboard type.</p>
12    ///   - [`widgets(Vec::<Widget>)`](crate::operation::get_dashboard::GetDashboardOutput::widgets): <p>An array of widget configurations that make up the dashboard.</p>
13    ///   - [`created_at(DateTime)`](crate::operation::get_dashboard::GetDashboardOutput::created_at): <p>The timestamp when the dashboard was created.</p>
14    ///   - [`updated_at(DateTime)`](crate::operation::get_dashboard::GetDashboardOutput::updated_at): <p>The timestamp when the dashboard was last modified.</p>
15    /// - On failure, responds with [`SdkError<GetDashboardError>`](crate::operation::get_dashboard::GetDashboardError)
16    pub fn get_dashboard(&self) -> crate::operation::get_dashboard::builders::GetDashboardFluentBuilder {
17        crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::new(self.handle.clone())
18    }
19}