You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Connect::Types::HistoricalMetric

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HistoricalMetric as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
  threshold: {
    comparison: "LT", # accepts LT
    threshold_value: 1.0,
  },
  statistic: "SUM", # accepts SUM, MAX, AVG
  unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
}

A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold for the metric.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the historical metric.

Possible values:

  • CONTACTS_QUEUED
  • CONTACTS_HANDLED
  • CONTACTS_ABANDONED
  • CONTACTS_CONSULTED
  • CONTACTS_AGENT_HUNG_UP_FIRST
  • CONTACTS_HANDLED_INCOMING
  • CONTACTS_HANDLED_OUTBOUND
  • CONTACTS_HOLD_ABANDONS
  • CONTACTS_TRANSFERRED_IN
  • CONTACTS_TRANSFERRED_OUT
  • CONTACTS_TRANSFERRED_IN_FROM_QUEUE
  • CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
  • CONTACTS_MISSED
  • CALLBACK_CONTACTS_HANDLED
  • API_CONTACTS_HANDLED
  • OCCUPANCY
  • HANDLE_TIME
  • AFTER_CONTACT_WORK_TIME
  • QUEUED_TIME
  • ABANDON_TIME
  • QUEUE_ANSWER_TIME
  • HOLD_TIME
  • INTERACTION_TIME
  • INTERACTION_AND_HOLD_TIME
  • SERVICE_LEVEL

Returns:

  • (String)

    The name of the historical metric.

#statisticString

The statistic for the metric.

Possible values:

  • SUM
  • MAX
  • AVG

Returns:

  • (String)

    The statistic for the metric.

#thresholdTypes::Threshold

The threshold for the metric, used with service level metrics.

Returns:

  • (Types::Threshold)

    The threshold for the metric, used with service level metrics.

#unitString

The unit for the metric.

Possible values:

  • SECONDS
  • COUNT
  • PERCENT

Returns:

  • (String)

    The unit for the metric.