aws_sdk_connect/client/
get_contact_metrics.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 [`GetContactMetrics`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect 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    ///   - [`contact_id(impl Into<String>)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::set_contact_id):<br>required: **true**<br><p>The identifier of the contact in this instance of Amazon Connect.</p><br>
8    ///   - [`metrics(ContactMetricInfo)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::metrics) / [`set_metrics(Option<Vec::<ContactMetricInfo>>)`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::set_metrics):<br>required: **true**<br><p>A list of contact-level metrics to retrieve.</p><br>
9    /// - On success, responds with [`GetContactMetricsOutput`](crate::operation::get_contact_metrics::GetContactMetricsOutput) with field(s):
10    ///   - [`metric_results(Option<Vec::<ContactMetricResult>>)`](crate::operation::get_contact_metrics::GetContactMetricsOutput::metric_results): <p>A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding calculated value.</p>
11    ///   - [`id(Option<String>)`](crate::operation::get_contact_metrics::GetContactMetricsOutput::id): <p>The unique identifier of the contact for which metrics were retrieved.</p>
12    ///   - [`arn(Option<String>)`](crate::operation::get_contact_metrics::GetContactMetricsOutput::arn): <p>The ARN of the contact for which metrics were retrieved.</p>
13    /// - On failure, responds with [`SdkError<GetContactMetricsError>`](crate::operation::get_contact_metrics::GetContactMetricsError)
14    pub fn get_contact_metrics(&self) -> crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder {
15        crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::new(self.handle.clone())
16    }
17}