// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_metric_data::_get_metric_data_output::GetMetricDataOutputBuilder;
pub use crate::operation::get_metric_data::_get_metric_data_input::GetMetricDataInputBuilder;
impl crate::operation::get_metric_data::builders::GetMetricDataInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_metric_data::GetMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_metric_data::GetMetricDataError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_metric_data();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetMetricData`.
///
/// <p>Gets historical metric data from the specified Amazon Connect instance.</p>
/// <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It provides more flexibility, features, and the ability to query longer time ranges than <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetMetricDataFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_metric_data::builders::GetMetricDataInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
> for GetMetricDataFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetMetricDataFluentBuilder {
/// Creates a new `GetMetricDataFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetMetricData as a reference.
pub fn as_input(&self) -> &crate::operation::get_metric_data::builders::GetMetricDataInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::get_metric_data::GetMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_metric_data::GetMetricDataError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_metric_data::GetMetricData::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_metric_data::GetMetricData::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::get_metric_data::paginator::GetMetricDataPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::get_metric_data::paginator::GetMetricDataPaginator {
crate::operation::get_metric_data::paginator::GetMetricDataPaginator::new(self.handle, self.inner)
}
/// <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>
pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.instance_id(input.into());
self
}
/// <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>
pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_instance_id(input);
self
}
/// <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>
pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_instance_id()
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_start_time()
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.end_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_end_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_end_time()
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn filters(mut self, input: crate::types::Filters) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn set_filters(mut self, input: ::std::option::Option<crate::types::Filters>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn get_filters(&self) -> &::std::option::Option<crate::types::Filters> {
self.inner.get_filters()
}
///
/// Appends an item to `Groupings`.
///
/// To override the contents of this collection use [`set_groupings`](Self::set_groupings).
///
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn groupings(mut self, input: crate::types::Grouping) -> Self {
self.inner = self.inner.groupings(input);
self
}
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn set_groupings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Grouping>>) -> Self {
self.inner = self.inner.set_groupings(input);
self
}
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn get_groupings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Grouping>> {
self.inner.get_groupings()
}
///
/// Appends an item to `HistoricalMetrics`.
///
/// To override the contents of this collection use [`set_historical_metrics`](Self::set_historical_metrics).
///
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a></p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a></p>
/// </dd>
/// <dt>
/// AVG_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold time</a></p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a></p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up first</a></p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled incoming</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled outbound</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold disconnect</a></p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a></p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred out</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average agent interaction and customer hold time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent interaction time</a></p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a></p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer time</a></p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a></p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// </dl>
pub fn historical_metrics(mut self, input: crate::types::HistoricalMetric) -> Self {
self.inner = self.inner.historical_metrics(input);
self
}
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a></p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a></p>
/// </dd>
/// <dt>
/// AVG_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold time</a></p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a></p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up first</a></p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled incoming</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled outbound</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold disconnect</a></p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a></p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred out</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average agent interaction and customer hold time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent interaction time</a></p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a></p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer time</a></p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a></p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// </dl>
pub fn set_historical_metrics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::HistoricalMetric>>) -> Self {
self.inner = self.inner.set_historical_metrics(input);
self
}
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a></p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a></p>
/// </dd>
/// <dt>
/// AVG_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold time</a></p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a></p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up first</a></p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled incoming</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled outbound</a></p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold disconnect</a></p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a></p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred out</a></p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a></p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average agent interaction and customer hold time</a></p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent interaction time</a></p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a></p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer time</a></p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a></p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon time</a></p>
/// </dd>
/// </dl>
pub fn get_historical_metrics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::HistoricalMetric>> {
self.inner.get_historical_metrics()
}
/// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>The maximum number of results to return per page.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of results to return per page.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The maximum number of results to return per page.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
}