MetricDefinition

Contains the full definition of a metric, including its calculation, unit, status, and trend indicator.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

The Amazon Resource Name (ARN) of the metric. May be qualified with $SAVED or $LATEST.

Link copied to clipboard

The category of the metric.

Link copied to clipboard

The timestamp of when the metric was created.

Link copied to clipboard

The user that created the metric. The creator for metrics created through the CreateMetric API will be Amazon Connect API.

Link copied to clipboard

The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).

Link copied to clipboard

The default stat aggregation for the metric.

Link copied to clipboard

The description of the metric.

Link copied to clipboard

The earliest time that can be queried for this metric.

Link copied to clipboard

The filters applied to the metric.

Link copied to clipboard

The groupings available for this metric.

Link copied to clipboard
val id: String

The identifier of the metric.

Link copied to clipboard

The region where the metric was last modified.

Link copied to clipboard

The timestamp of when the metric was last modified.

Link copied to clipboard

The user that last modified the metric. For modifications made through the API, this will be Amazon Connect API.

Link copied to clipboard

The calculation definition for the metric.

Link copied to clipboard

The name of the metric.

Link copied to clipboard

How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

Link copied to clipboard

The primary event source for the metric data.

Link copied to clipboard

The timestamp type that determines where the metric appears on a time series.

Link copied to clipboard

The minimum interval, in seconds, between data refreshes for this metric.

Link copied to clipboard

The publish status of the metric. Valid values: PUBLISHED | SAVED.

Link copied to clipboard

The stat aggregations available for this metric.

Link copied to clipboard

Specifies whether the metric can be used as a component of custom metrics.

Link copied to clipboard

Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.

Link copied to clipboard

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Link copied to clipboard

The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

Link copied to clipboard

The display unit for the metric's data.

Functions

Link copied to clipboard
inline fun copy(block: MetricDefinition.Builder.() -> Unit = {}): MetricDefinition
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String