MetricDefinition ¶

class MetricDefinition(TypedDict, closed=True):
    arn: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the metric. May be qualified with <code>$SAVED</code> or <code>$LATEST</code>.</p>"""
    id: "capo_connect.types.metric_id.MetricId"
    """<p>The identifier of the metric.</p>"""
    name: "capo_connect.types.metric_name.MetricName"
    """<p>The name of the metric.</p>"""
    description: NotRequired["capo_connect.types.metric_description.MetricDescription"]
    """<p>The description of the metric.</p>"""
    metric_calculation: NotRequired[
        "capo_connect.types.metric_calculation.MetricCalculation"
    ]
    """<p>The calculation definition for the metric.</p>"""
    creation_method: NotRequired[
        "capo_connect.types.metric_creation_method.MetricCreationMethod"
    ]
    """<p>The method used to create the metric. Valid values: <code>SERVICE_LEVEL_BUILDER</code> (created with the guided service-level experience) | <code>METRIC_BUILDER</code> (created with the free-form metric builder).</p>"""
    status: NotRequired["capo_connect.types.metric_status.MetricStatus"]
    """<p>The publish status of the metric. Valid values: <code>PUBLISHED</code> | <code>SAVED</code>.</p>"""
    type: "capo_connect.types.metric_type.MetricType"
    """<p>The type of the metric. Valid values: <code>AWS_MANAGED</code> | <code>CUSTOMER_MANAGED</code>.</p>"""
    unit: "capo_connect.types.metric_unit.MetricUnit"
    """<p>The display unit for the metric's data.</p>"""
    positive_trend_indicator: NotRequired[
        "capo_connect.types.trend_indicator.TrendIndicator"
    ]
    """<p>How an increase in the metric value should be interpreted. Valid values: <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>NEGATIVE</code>.</p>"""
    groupings: "capo_connect.types.metric_grouping_list.MetricGroupingList"
    """<p>The groupings available for this metric.</p>"""
    filters: "capo_connect.types.available_filter_list.AvailableFilterList"
    """<p>The filters applied to the metric.</p>"""
    effective_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The earliest time that can be queried for this metric.</p>"""
    refresh_rate: "capo_connect.types.refresh_rate.RefreshRate"
    """<p>The minimum interval, in seconds, between data refreshes for this metric.</p>"""
    category: "capo_connect.types.metric_category.MetricCategory"
    """<p>The category of the metric.</p>"""
    supported_stats: NotRequired[
        "capo_connect.types.supported_stats_list.SupportedStatsList"
    ]
    """<p>The stat aggregations available for this metric.</p>"""
    default_stat: NotRequired["capo_connect.types.default_stat.DefaultStat"]
    """<p>The default stat aggregation for the metric.</p>"""
    supports_preaggregate_calculation: "capo_connect.types.supports_preaggregate_calculation.SupportsPreaggregateCalculation"
    """<p>Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.</p>"""
    supports_custom_calculation: (
        "capo_connect.types.supports_custom_calculation.SupportsCustomCalculation"
    )
    """<p>Specifies whether the metric can be used as a component of custom metrics.</p>"""
    primary_event_source: NotRequired[
        "capo_connect.types.primary_event_source.PrimaryEventSource"
    ]
    """<p>The primary event source for the metric data.</p>"""
    primary_event_source_effective_timestamp_type: NotRequired[
        "capo_connect.types.primary_event_source_effective_timestamp_type.PrimaryEventSourceEffectiveTimestampType"
    ]
    """<p>The timestamp type that determines where the metric appears on a time series.</p>"""
    created_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp of when the metric was created.</p>"""
    created_user: NotRequired["capo_connect.types.created_by_info.CreatedByInfo"]
    """<p>The user that created the metric. The creator for metrics created through the CreateMetric API will be <code>Amazon Connect API</code>.</p>"""
    last_modified_region: NotRequired["capo_connect.types.region_name.RegionName"]
    """<p>The region where the metric was last modified.</p>"""
    last_modified_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp of when the metric was last modified.</p>"""
    last_modified_user: NotRequired["capo_connect.types.created_by_info.CreatedByInfo"]
    """<p>The user that last modified the metric. For modifications made through the API, this will be <code>Amazon Connect API</code>.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""