aws_sdk_iotsitewise/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    ///   - [`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 of the dashboard.</p><br>
7    /// - On success, responds with [`DescribeDashboardOutput`](crate::operation::describe_dashboard::DescribeDashboardOutput) with field(s):
8    ///   - [`dashboard_id(String)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_id): <p>The ID of the dashboard.</p>
9    ///   - [`dashboard_arn(String)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code></p>
10    ///   - [`dashboard_name(String)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_name): <p>The name of the dashboard.</p>
11    ///   - [`project_id(String)`](crate::operation::describe_dashboard::DescribeDashboardOutput::project_id): <p>The ID of the project that the dashboard is in.</p>
12    ///   - [`dashboard_description(Option<String>)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_description): <p>The dashboard's description.</p>
13    ///   - [`dashboard_definition(String)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_definition): <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
14    ///   - [`dashboard_creation_date(DateTime)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_creation_date): <p>The date the dashboard was created, in Unix epoch time.</p>
15    ///   - [`dashboard_last_update_date(DateTime)`](crate::operation::describe_dashboard::DescribeDashboardOutput::dashboard_last_update_date): <p>The date the dashboard was last updated, in Unix epoch time.</p>
16    /// - On failure, responds with [`SdkError<DescribeDashboardError>`](crate::operation::describe_dashboard::DescribeDashboardError)
17    pub fn describe_dashboard(&self) -> crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder {
18        crate::operation::describe_dashboard::builders::DescribeDashboardFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_iotsitewise/client/describe_dashboard.rs

aws_sdk_iotsitewise/client/
describe_dashboard.rs
