Skip to main content

aws_sdk_connect/client/
describe_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 [`DescribeMetric`](crate::operation::describe_metric::builders::DescribeMetricFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::describe_metric::builders::DescribeMetricFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::describe_metric::builders::DescribeMetricFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
7    ///   - [`metric_id(impl Into<String>)`](crate::operation::describe_metric::builders::DescribeMetricFluentBuilder::metric_id) / [`set_metric_id(Option<String>)`](crate::operation::describe_metric::builders::DescribeMetricFluentBuilder::set_metric_id):<br>required: **true**<br><p>The identifier of the metric to describe. Adding the <code>$SAVED</code> qualifier will describe the saved version of the metric. Adding <code>$LATEST</code> or omitting a qualifier will describe the published version.</p><br>
8    /// - On success, responds with [`DescribeMetricOutput`](crate::operation::describe_metric::DescribeMetricOutput) with field(s):
9    ///   - [`metric(Option<MetricDefinition>)`](crate::operation::describe_metric::DescribeMetricOutput::metric): <p>The metric definition.</p>
10    /// - On failure, responds with [`SdkError<DescribeMetricError>`](crate::operation::describe_metric::DescribeMetricError)
11    pub fn describe_metric(&self) -> crate::operation::describe_metric::builders::DescribeMetricFluentBuilder {
12        crate::operation::describe_metric::builders::DescribeMetricFluentBuilder::new(self.handle.clone())
13    }
14}