aws-sdk-connect 1.166.0

AWS SDK for Amazon Connect Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetContactMetrics`](crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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>
    ///   - [`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>
    ///   - [`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.Supported metrics include POSITION_IN_QUEUE (the contact's current position in the queue) and ESTIMATED_WAIT_TIME (the predicted time in seconds until the contact is connected to an agent)</p><br>
    /// - On success, responds with [`GetContactMetricsOutput`](crate::operation::get_contact_metrics::GetContactMetricsOutput) with field(s):
    ///   - [`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 value. For example, POSITION_IN_QUEUE returns a numeric value representing the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.</p>
    ///   - [`id(Option<String>)`](crate::operation::get_contact_metrics::GetContactMetricsOutput::id): <p>The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided in the request.</p>
    ///   - [`arn(Option<String>)`](crate::operation::get_contact_metrics::GetContactMetricsOutput::arn): <p>The ARN of the contact for which metrics were retrieved.</p>
    /// - On failure, responds with [`SdkError<GetContactMetricsError>`](crate::operation::get_contact_metrics::GetContactMetricsError)
    pub fn get_contact_metrics(&self) -> crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder {
        crate::operation::get_contact_metrics::builders::GetContactMetricsFluentBuilder::new(self.handle.clone())
    }
}