aws_sdk_iot/client/update_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 [`UpdateCustomMetric`](crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`metric_name(impl Into<String>)`](crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder::set_metric_name):<br>required: **true**<br><p>The name of the custom metric. Cannot be updated.</p><br>
7 /// - [`display_name(impl Into<String>)`](crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder::set_display_name):<br>required: **true**<br><p>Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.</p><br>
8 /// - On success, responds with [`UpdateCustomMetricOutput`](crate::operation::update_custom_metric::UpdateCustomMetricOutput) with field(s):
9 /// - [`metric_name(Option<String>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::metric_name): <p>The name of the custom metric.</p>
10 /// - [`metric_arn(Option<String>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::metric_arn): <p>The Amazon Resource Number (ARN) of the custom metric.</p>
11 /// - [`metric_type(Option<CustomMetricType>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::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>
12 /// - [`display_name(Option<String>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::display_name): <p>A friendly name in the console for the custom metric</p>
13 /// - [`creation_date(Option<DateTime>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::creation_date): <p>The creation date of the custom metric in milliseconds since epoch.</p>
14 /// - [`last_modified_date(Option<DateTime>)`](crate::operation::update_custom_metric::UpdateCustomMetricOutput::last_modified_date): <p>The time the custom metric was last modified in milliseconds since epoch.</p>
15 /// - On failure, responds with [`SdkError<UpdateCustomMetricError>`](crate::operation::update_custom_metric::UpdateCustomMetricError)
16 pub fn update_custom_metric(&self) -> crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder {
17 crate::operation::update_custom_metric::builders::UpdateCustomMetricFluentBuilder::new(self.handle.clone())
18 }
19}