Interface HistoricalMetric.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<HistoricalMetric.Builder,
,HistoricalMetric> SdkBuilder<HistoricalMetric.Builder,
,HistoricalMetric> SdkPojo
- Enclosing class:
HistoricalMetric
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the metric.name
(HistoricalMetricName name) The name of the metric.The statistic for the metric.The statistic for the metric.default HistoricalMetric.Builder
threshold
(Consumer<Threshold.Builder> threshold) The threshold for the metric, used with service level metrics.The threshold for the metric, used with service level metrics.The unit for the metric.The unit for the metric.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
name
The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide.
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for "Less than").UI name: Service level X
- Parameters:
name
- The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide.- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for "Less than").UI name: Service level X
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide.
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for "Less than").UI name: Service level X
- Parameters:
name
- The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the Amazon Connect Administrator Guide.- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for "Less than").UI name: Service level X
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
threshold
The threshold for the metric, used with service level metrics.
- Parameters:
threshold
- The threshold for the metric, used with service level metrics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
threshold
The threshold for the metric, used with service level metrics.
This is a convenience method that creates an instance of theThreshold.Builder
avoiding the need to create one manually viaThreshold.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothreshold(Threshold)
.- Parameters:
threshold
- a consumer that will call methods onThreshold.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statistic
The statistic for the metric.
- Parameters:
statistic
- The statistic for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statistic
The statistic for the metric.
- Parameters:
statistic
- The statistic for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
unit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
unit
The unit for the metric.
- Parameters:
unit
- The unit for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-