aws_sdk_lookoutmetrics/client/
describe_metric_set.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 [`DescribeMetricSet`](crate::operation::describe_metric_set::builders::DescribeMetricSetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`metric_set_arn(impl Into<String>)`](crate::operation::describe_metric_set::builders::DescribeMetricSetFluentBuilder::metric_set_arn) / [`set_metric_set_arn(Option<String>)`](crate::operation::describe_metric_set::builders::DescribeMetricSetFluentBuilder::set_metric_set_arn):<br>required: **true**<br><p>The ARN of the dataset.</p><br>
7    /// - On success, responds with [`DescribeMetricSetOutput`](crate::operation::describe_metric_set::DescribeMetricSetOutput) with field(s):
8    ///   - [`metric_set_arn(Option<String>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_set_arn): <p>The ARN of the dataset.</p>
9    ///   - [`anomaly_detector_arn(Option<String>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::anomaly_detector_arn): <p>The ARN of the detector that contains the dataset.</p>
10    ///   - [`metric_set_name(Option<String>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_set_name): <p>The name of the dataset.</p>
11    ///   - [`metric_set_description(Option<String>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_set_description): <p>The dataset's description.</p>
12    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::creation_time): <p>The time at which the dataset was created.</p>
13    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::last_modification_time): <p>The time at which the dataset was last modified.</p>
14    ///   - [`offset(Option<i32>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::offset): <p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.</p>
15    ///   - [`metric_list(Option<Vec::<Metric>>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_list): <p>A list of the metrics defined by the dataset.</p>
16    ///   - [`timestamp_column(Option<TimestampColumn>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::timestamp_column): <p>Contains information about the column used for tracking time in your source data.</p>
17    ///   - [`dimension_list(Option<Vec::<String>>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::dimension_list): <p>A list of the dimensions chosen for analysis.</p>
18    ///   - [`metric_set_frequency(Option<Frequency>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_set_frequency): <p>The interval at which the data will be analyzed for anomalies.</p>
19    ///   - [`timezone(Option<String>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::timezone): <p>The time zone in which the dataset's data was recorded.</p>
20    ///   - [`metric_source(Option<MetricSource>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::metric_source): <p>Contains information about the dataset's source data.</p>
21    ///   - [`dimension_filter_list(Option<Vec::<MetricSetDimensionFilter>>)`](crate::operation::describe_metric_set::DescribeMetricSetOutput::dimension_filter_list): <p>The dimensions and their values that were used to filter the dataset.</p>
22    /// - On failure, responds with [`SdkError<DescribeMetricSetError>`](crate::operation::describe_metric_set::DescribeMetricSetError)
23    pub fn describe_metric_set(&self) -> crate::operation::describe_metric_set::builders::DescribeMetricSetFluentBuilder {
24        crate::operation::describe_metric_set::builders::DescribeMetricSetFluentBuilder::new(self.handle.clone())
25    }
26}