aws_sdk_cloudwatch/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    ///   - [`dashboard_name(impl Into<String>)`](crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::dashboard_name) / [`set_dashboard_name(Option<String>)`](crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::set_dashboard_name):<br>required: **true**<br><p>The name of the dashboard to be described.</p><br>
7    /// - On success, responds with [`GetDashboardOutput`](crate::operation::get_dashboard::GetDashboardOutput) with field(s):
8    ///   - [`dashboard_arn(Option<String>)`](crate::operation::get_dashboard::GetDashboardOutput::dashboard_arn): <p>The Amazon Resource Name (ARN) of the dashboard.</p>
9    ///   - [`dashboard_body(Option<String>)`](crate::operation::get_dashboard::GetDashboardOutput::dashboard_body): <p>The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the <code>DashboardBody</code> syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
10    ///   - [`dashboard_name(Option<String>)`](crate::operation::get_dashboard::GetDashboardOutput::dashboard_name): <p>The name of the dashboard.</p>
11    /// - On failure, responds with [`SdkError<GetDashboardError>`](crate::operation::get_dashboard::GetDashboardError)
12    pub fn get_dashboard(&self) -> crate::operation::get_dashboard::builders::GetDashboardFluentBuilder {
13        crate::operation::get_dashboard::builders::GetDashboardFluentBuilder::new(self.handle.clone())
14    }
15}