aws_sdk_iot/client/
describe_custom_metric.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 [`DescribeCustomMetric`](crate::operation::describe_custom_metric::builders::DescribeCustomMetricFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`metric_name(impl Into<String>)`](crate::operation::describe_custom_metric::builders::DescribeCustomMetricFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::describe_custom_metric::builders::DescribeCustomMetricFluentBuilder::set_metric_name):<br>required: **true**<br><p>The name of the custom metric.</p><br>
7    /// - On success, responds with [`DescribeCustomMetricOutput`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput) with field(s):
8    ///   - [`metric_name(Option<String>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::metric_name): <p>The name of the custom metric.</p>
9    ///   - [`metric_arn(Option<String>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::metric_arn): <p>The Amazon Resource Number (ARN) of the custom metric.</p>
10    ///   - [`metric_type(Option<CustomMetricType>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::metric_type): <p>The type of the custom metric.</p><important>  <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p> </important>
11    ///   - [`display_name(Option<String>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::display_name): <p>Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.</p>
12    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::creation_date): <p>The creation date of the custom metric in milliseconds since epoch.</p>
13    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_custom_metric::DescribeCustomMetricOutput::last_modified_date): <p>The time the custom metric was last modified in milliseconds since epoch.</p>
14    /// - On failure, responds with [`SdkError<DescribeCustomMetricError>`](crate::operation::describe_custom_metric::DescribeCustomMetricError)
15    pub fn describe_custom_metric(&self) -> crate::operation::describe_custom_metric::builders::DescribeCustomMetricFluentBuilder {
16        crate::operation::describe_custom_metric::builders::DescribeCustomMetricFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_iot/client/describe_custom_metric.rs

aws_sdk_iot/client/
describe_custom_metric.rs
