Struct IntervalDetails

#[non_exhaustive]
pub struct IntervalDetails {
    pub time_zone: Option<String>,
    pub interval_period: Option<IntervalPeriod>,
}

Information about the interval period to use for returning results.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time_zone: Option<String>

The timezone applied to requested metrics.

interval_period: Option<IntervalPeriod>

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

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.

Implementations

impl IntervalDetails

pub fn time_zone(&self) -> Option<&str>

The timezone applied to requested metrics.

pub fn interval_period(&self) -> Option<&IntervalPeriod>

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

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.

impl IntervalDetails

pub fn builder() -> IntervalDetailsBuilder

Creates a new builder-style object to manufacture IntervalDetails.

Trait Implementations

impl Clone for IntervalDetails

fn clone(&self) -> IntervalDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IntervalDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for IntervalDetails

fn eq(&self, other: &IntervalDetails) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IntervalDetails