CreateMetricRequest ¶

class CreateMetricRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    name: "capo_connect.types.metric_name.MetricName"
    """<p>The name of the metric.</p>"""
    metric_calculation: "capo_connect.types.metric_calculation.MetricCalculation"
    """<p>The calculation definition for the metric, including the formula expression and the component metrics it references.</p>"""
    unit: "capo_connect.types.metric_unit.MetricUnit"
    """<p>The display unit for the metric's data.</p>"""
    status: NotRequired["capo_connect.types.metric_status.MetricStatus"]
    """<p>The publish status of the metric. Set to <code>PUBLISHED</code> to make the metric available for use in dashboards and reports, or <code>SAVED</code> to keep it in draft state.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    description: NotRequired["capo_connect.types.metric_description.MetricDescription"]
    """<p>The description of the metric.</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>"""
    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>"""