Skip to content

DataQuery

Source code in docs_src/capo_ec2/types/data_query.py
class DataQuery(TypedDict, closed=True):
    id: NotRequired["capo_ec2.types.string.String"]
    """<p>A user-defined ID associated with a data query that's returned in the <code>dataResponse</code> identifying the query. For example, if you set the Id to <code>MyQuery01</code>in the query, the <code>dataResponse</code> identifies the query as <code>MyQuery01</code>.</p>"""
    source: NotRequired["capo_ec2.types.string.String"]
    """<p>The Region or Availability Zone that's the source for the data query. For example, <code>us-east-1</code>.</p>"""
    destination: NotRequired["capo_ec2.types.string.String"]
    """<p>The Region or Availability Zone that's the target for the data query. For example, <code>eu-north-1</code>.</p>"""
    metric: NotRequired["capo_ec2.types.metric_type.MetricType"]
    """<p>The metric used for the network performance request.</p>"""
    statistic: NotRequired["capo_ec2.types.statistic_type.StatisticType"]
    """<p>The metric data aggregation period, <code>p50</code>, between the specified <code>startDate</code> and <code>endDate</code>. For example, a metric of <code>five_minutes</code> is the median of all the data points gathered within those five minutes. <code>p50</code> is the only supported metric.</p>"""
    period: NotRequired["capo_ec2.types.period_type.PeriodType"]
    """<p>The aggregation period used for the data query.</p>"""

destination instance-attribute

destination: NotRequired[String]

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

id instance-attribute

id: NotRequired[String]

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

metric instance-attribute

metric: NotRequired[MetricType]

The metric used for the network performance request.

period instance-attribute

period: NotRequired[PeriodType]

The aggregation period used for the data query.

source instance-attribute

source: NotRequired[String]

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

statistic instance-attribute

statistic: NotRequired[StatisticType]

The metric data aggregation period, p50, between the specified startDate and endDate. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes. p50 is the only supported metric.