aws_sdk_iot/client/
create_fleet_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 [`CreateFleetMetric`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`metric_name(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_metric_name):<br>required: **true**<br><p>The name of the fleet metric to create.</p><br>
7    ///   - [`query_string(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::query_string) / [`set_query_string(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_query_string):<br>required: **true**<br><p>The search query string.</p><br>
8    ///   - [`aggregation_type(AggregationType)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::aggregation_type) / [`set_aggregation_type(Option<AggregationType>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_aggregation_type):<br>required: **true**<br><p>The type of the aggregation query.</p><br>
9    ///   - [`period(i32)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::period) / [`set_period(Option<i32>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_period):<br>required: **true**<br><p>The time in seconds between fleet metric emissions. Range \[60(1 min), 86400(1 day)\] and must be multiple of 60.</p><br>
10    ///   - [`aggregation_field(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::aggregation_field) / [`set_aggregation_field(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_aggregation_field):<br>required: **true**<br><p>The field to aggregate.</p><br>
11    ///   - [`description(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_description):<br>required: **false**<br><p>The fleet metric description.</p><br>
12    ///   - [`query_version(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::query_version) / [`set_query_version(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_query_version):<br>required: **false**<br><p>The query version.</p><br>
13    ///   - [`index_name(impl Into<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_index_name):<br>required: **false**<br><p>The name of the index to search.</p><br>
14    ///   - [`unit(FleetMetricUnit)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::unit) / [`set_unit(Option<FleetMetricUnit>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_unit):<br>required: **false**<br><p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. Default to null.</p><br>
15    ///   - [`tags(Tag)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata, which can be used to manage the fleet metric.</p><br>
16    /// - On success, responds with [`CreateFleetMetricOutput`](crate::operation::create_fleet_metric::CreateFleetMetricOutput) with field(s):
17    ///   - [`metric_name(Option<String>)`](crate::operation::create_fleet_metric::CreateFleetMetricOutput::metric_name): <p>The name of the fleet metric to create.</p>
18    ///   - [`metric_arn(Option<String>)`](crate::operation::create_fleet_metric::CreateFleetMetricOutput::metric_arn): <p>The Amazon Resource Name (ARN) of the new fleet metric.</p>
19    /// - On failure, responds with [`SdkError<CreateFleetMetricError>`](crate::operation::create_fleet_metric::CreateFleetMetricError)
20    pub fn create_fleet_metric(&self) -> crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder {
21        crate::operation::create_fleet_metric::builders::CreateFleetMetricFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_iot/client/create_fleet_metric.rs

aws_sdk_iot/client/
create_fleet_metric.rs
