Skip to content

DescribeFleetMetricResponse

Source code in docs_src/capo_iot/types/describe_fleet_metric_response.py
class DescribeFleetMetricResponse(TypedDict, closed=True):
    metric_name: NotRequired["capo_iot.types.fleet_metric_name.FleetMetricName"]
    """<p>The name of the fleet metric to describe.</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 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>"""
    creation_date: NotRequired["capo_iot.types.creation_date.CreationDate"]
    """<p>The date when the fleet metric is created.</p>"""
    last_modified_date: NotRequired[
        "capo_iot.types.last_modified_date.LastModifiedDate"
    ]
    """<p>The date when the fleet metric is last modified.</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>"""
    version: "capo_iot.types.version.Version"
    """<p>The version of the fleet metric.</p>"""
    metric_arn: NotRequired["capo_iot.types.fleet_metric_arn.FleetMetricArn"]
    """<p>The ARN of the fleet metric to describe.</p>"""

aggregation_field instance-attribute

aggregation_field: NotRequired[AggregationField]

The field to aggregate.

aggregation_type instance-attribute

aggregation_type: NotRequired[AggregationType]

The type of the aggregation query.

creation_date instance-attribute

creation_date: NotRequired[CreationDate]

The date when the fleet metric is created.

description instance-attribute

description: NotRequired[FleetMetricDescription]

The fleet metric description.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the index to search.

last_modified_date instance-attribute

last_modified_date: NotRequired[LastModifiedDate]

The date when the fleet metric is last modified.

metric_arn instance-attribute

metric_arn: NotRequired[FleetMetricArn]

The ARN of the fleet metric to describe.

metric_name instance-attribute

metric_name: NotRequired[FleetMetricName]

The name of the fleet metric to describe.

period instance-attribute

period: NotRequired[FleetMetricPeriod]

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

query_string instance-attribute

query_string: NotRequired[QueryString]

The search query string.

query_version instance-attribute

query_version: NotRequired[QueryVersion]

The query version.

unit instance-attribute

unit: NotRequired[FleetMetricUnit]

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

version instance-attribute

version: Version

The version of the fleet metric.