Skip to content

IntervalDetails

Used by
Source code in docs_src/capo_connect/types/interval_details.py 
12
13
14
15
16
class IntervalDetails(TypedDict, closed=True):
    time_zone: NotRequired["capo_connect.types.string.String"]
    """<p>The timezone applied to requested metrics.</p>"""
    interval_period: NotRequired["capo_connect.types.interval_period.IntervalPeriod"]
    """<p> <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> | <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p> <p>For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Connect Customer returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Connect Customer aggregates results based on the <code>TOTAL</code> interval period. </p> <p>The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code> based on what <code>IntervalPeriod</code> is requested. </p> <ul> <li> <p> <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>HOUR</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 3 days.</p> </li> <li> <p> <code>DAY</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>WEEK</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> <li> <p> <code>TOTAL</code>: The difference between <code>StartTime</code> and <code>EndTime</code> must be less than 35 days.</p> </li> </ul>"""

interval_period instance-attribute 

interval_period: NotRequired[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 Connect Customer returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Connect Customer 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.

time_zone instance-attribute 

time_zone: NotRequired[String]

The timezone applied to requested metrics.