Class: Aws::Connect::Types::MetricFilterV2

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::MetricFilterV2

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

Contains information about the filter used when retrieving metrics. ‘MetricFiltersV2` can be used on the following metrics: `AVG_AGENT_CONNECTING_TIME`, `CONTACTS_CREATED`, `CONTACTS_HANDLED`, `SUM_CONTACTS_DISCONNECTED`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #metric_filter_key ⇒ String

  The key to use for filtering data.

• #metric_filter_values ⇒ Array<String>

  The values to use for filtering data.

• #negate ⇒ Boolean

  The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.

Instance Attribute Details

#metric_filter_key ⇒ String

The key to use for filtering data.

Valid metric filter keys: ‘INITIATION_METHOD`, `DISCONNECT_REASON`. These are the same values as the `InitiationMethod` and `DisconnectReason` in the contact record. For more information, see

ContactTraceRecord][1

in the *Amazon Connect Administrator’s

Guide*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 12948

class MetricFilterV2 < Struct.new(
  :metric_filter_key,
  :metric_filter_values,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#metric_filter_values ⇒ Array<String>

The values to use for filtering data.

Valid metric filter values for ‘INITIATION_METHOD`: `INBOUND` | `OUTBOUND` | `TRANSFER` | `QUEUE_TRANSFER` | `CALLBACK` | `API`

Valid metric filter values for ‘DISCONNECT_REASON`: `CUSTOMER_DISCONNECT` | `AGENT_DISCONNECT` | `THIRD_PARTY_DISCONNECT` | `TELECOM_PROBLEM` | `BARGED` | `CONTACT_FLOW_DISCONNECT` | `OTHER` | `EXPIRED` | `API`

Returns:

• (Array<String>)

# File 'lib/aws-sdk-connect/types.rb', line 12948

class MetricFilterV2 < Struct.new(
  :metric_filter_key,
  :metric_filter_values,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end

#negate ⇒ Boolean

The flag to use to filter on requested metric filter values or to not filter on requested metric filter values. By default the negate is ‘false`, which indicates to filter on the requested metric filter.

Returns:

• (Boolean)

# File 'lib/aws-sdk-connect/types.rb', line 12948

class MetricFilterV2 < Struct.new(
  :metric_filter_key,
  :metric_filter_values,
  :negate)
  SENSITIVE = []
  include Aws::Structure
end