UpdateFleetMetricRequest ¶

class UpdateFleetMetricRequest(TypedDict, closed=True):
    metric_name: "capo_iot.types.fleet_metric_name.FleetMetricName"
    """<p>The name of the fleet metric to update.</p>"""
    query_string: NotRequired["capo_iot.types.query_string.QueryString"]
    """<p>The search query string.</p>"""
    aggregation_type: NotRequired["capo_iot.types.aggregation_type.AggregationType"]
    """<p>The type of the aggregation query.</p>"""
    period: NotRequired["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: NotRequired["capo_iot.types.aggregation_field.AggregationField"]
    """<p>The field to aggregate.</p>"""
    description: NotRequired[
        "capo_iot.types.fleet_metric_description.FleetMetricDescription"
    ]
    """<p>The description of the fleet metric.</p>"""
    query_version: NotRequired["capo_iot.types.query_version.QueryVersion"]
    """<p>The version of the query.</p>"""
    index_name: "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>.</p>"""
    expected_version: NotRequired["capo_iot.types.optional_version.OptionalVersion"]
    """<p>The expected version of the fleet metric record in the registry.</p>"""