CreateFleetMetricRequest ¶

class CreateFleetMetricRequest(TypedDict, closed=True):
    metric_name: "capo_iot.types.fleet_metric_name.FleetMetricName"
    """<p>The name of the fleet metric to create.</p>"""
    query_string: "capo_iot.types.query_string.QueryString"
    """<p>The search query string.</p>"""
    aggregation_type: "capo_iot.types.aggregation_type.AggregationType"
    """<p>The type of the aggregation query.</p>"""
    period: "capo_iot.types.fleet_metric_period.FleetMetricPeriod"
    """<p>The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.</p>"""
    aggregation_field: "capo_iot.types.aggregation_field.AggregationField"
    """<p>The field to aggregate.</p>"""
    description: NotRequired[
        "capo_iot.types.fleet_metric_description.FleetMetricDescription"
    ]
    """<p>The fleet metric description.</p>"""
    query_version: NotRequired["capo_iot.types.query_version.QueryVersion"]
    """<p>The query version.</p>"""
    index_name: NotRequired["capo_iot.types.index_name.IndexName"]
    """<p>The name of the index to search.</p>"""
    unit: NotRequired["capo_iot.types.fleet_metric_unit.FleetMetricUnit"]
    """<p>Used to support unit transformation such as milliseconds to seconds. The unit must be supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. Default to null.</p>"""
    tags: NotRequired["capo_iot.types.tag_list.TagList"]
    """<p>Metadata, which can be used to manage the fleet metric.</p>"""