Class: Aws::Connect::Types::IntervalDetails

Inherits:

Struct

Object
Struct
Aws::Connect::Types::IntervalDetails

show all

Includes:: Structure

Defined in:: lib/aws-sdk-connect/types.rb

Overview

Information about the interval period to use for returning results.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#interval_period ⇒ String

‘IntervalPeriod`: An aggregated grouping applied to request metrics.
#time_zone ⇒ String

The timezone applied to requested metrics.

Instance Attribute Details

#interval_period ⇒ `String`

For example, if ‘IntervalPeriod` is selected `THIRTY_MIN`, `StartTime` and `EndTime` differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the `TOTAL` interval period.

The following list describes restrictions on ‘StartTime` and `EndTime` based on what `IntervalPeriod` is requested.

‘FIFTEEN_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.
‘THIRTY_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.
‘HOUR`: The difference between `StartTime` and `EndTime` must be less than 3 days.
‘DAY`: The difference between `StartTime` and `EndTime` must be less than 35 days.
‘WEEK`: The difference between `StartTime` and `EndTime` must be less than 35 days.
‘TOTAL`: The difference between `StartTime` and `EndTime` must be less than 35 days.

Returns:

(String)

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

class IntervalDetails < Struct.new(
  :time_zone,
  :interval_period)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone ⇒ `String`

The timezone applied to requested metrics.