Skip to content

UpdateCustomMetricResponse

Source code in docs_src/capo_iot/types/update_custom_metric_response.py
class UpdateCustomMetricResponse(TypedDict, closed=True):
    metric_name: NotRequired["capo_iot.types.metric_name.MetricName"]
    """<p> The name of the custom metric. </p>"""
    metric_arn: NotRequired["capo_iot.types.custom_metric_arn.CustomMetricArn"]
    """<p> The Amazon Resource Number (ARN) of the custom metric. </p>"""
    metric_type: NotRequired["capo_iot.types.custom_metric_type.CustomMetricType"]
    """<p> The type of the custom metric. </p> <important> <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p> </important>"""
    display_name: NotRequired[
        "capo_iot.types.custom_metric_display_name.CustomMetricDisplayName"
    ]
    """<p> A friendly name in the console for the custom metric </p>"""
    creation_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The creation date of the custom metric in milliseconds since epoch. </p>"""
    last_modified_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The time the custom metric was last modified in milliseconds since epoch. </p>"""

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The creation date of the custom metric in milliseconds since epoch.

display_name instance-attribute

display_name: NotRequired[CustomMetricDisplayName]

A friendly name in the console for the custom metric

last_modified_date instance-attribute

last_modified_date: NotRequired[Timestamp]

The time the custom metric was last modified in milliseconds since epoch.

metric_arn instance-attribute

metric_arn: NotRequired[CustomMetricArn]

The Amazon Resource Number (ARN) of the custom metric.

metric_name instance-attribute

metric_name: NotRequired[MetricName]

The name of the custom metric.

metric_type instance-attribute

metric_type: NotRequired[CustomMetricType]

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.