Amazonka.CloudWatch.Types.MetricDatum

Documentation

data MetricDatum

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

See: newMetricDatum smart constructor.

Constructors

MetricDatum'

Fields

• counts :: Maybe [Double]

  Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

  If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

• dimensions :: Maybe [Dimension]

  The dimensions associated with the metric.

• statisticValues :: Maybe StatisticSet

  The statistical values for the metric.

• storageResolution :: Maybe Natural

  Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

  This field is optional, if you do not specify it the default of 60 is used.

• timestamp :: Maybe ISO8601

  The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

• unit :: Maybe StandardUnit

  When you are using a Put operation, this defines what unit you want to use when storing the metric.

  In a Get operation, this displays the unit that is used for the metric.

• value :: Maybe Double

  The value for the metric.

  Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

• values :: Maybe [Double]

  Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

  Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

• metricName :: Text

  The name of the metric.

Instances

ToQuery MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

toQuery :: MetricDatum -> QueryString

Generic MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Associated Types

type Rep MetricDatum :: Type -> Type

Methods

from :: MetricDatum -> Rep MetricDatum x

to :: Rep MetricDatum x -> MetricDatum

Read MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

readsPrec :: Int -> ReadS MetricDatum

readList :: ReadS [MetricDatum]

readPrec :: ReadPrec MetricDatum

readListPrec :: ReadPrec [MetricDatum]

Show MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

showsPrec :: Int -> MetricDatum -> ShowS

show :: MetricDatum -> String

showList :: [MetricDatum] -> ShowS

NFData MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

rnf :: MetricDatum -> ()

Eq MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

(==) :: MetricDatum -> MetricDatum -> Bool

(/=) :: MetricDatum -> MetricDatum -> Bool

Hashable MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

Methods

hashWithSalt :: Int -> MetricDatum -> Int

hash :: MetricDatum -> Int

type Rep MetricDatum

Defined in Amazonka.CloudWatch.Types.MetricDatum

type Rep MetricDatum = D1 ('MetaData "MetricDatum" "Amazonka.CloudWatch.Types.MetricDatum" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "MetricDatum'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "counts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dimension]))) :*: (S1 ('MetaSel ('Just "statisticValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatisticSet)) :*: S1 ('MetaSel ('Just "storageResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StandardUnit))) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :*: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newMetricDatum

Arguments

:: Text

$sel:metricName:MetricDatum'

-> MetricDatum

Create a value of MetricDatum with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:counts:MetricDatum', metricDatum_counts - Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

$sel:dimensions:MetricDatum', metricDatum_dimensions - The dimensions associated with the metric.

$sel:statisticValues:MetricDatum', metricDatum_statisticValues - The statistical values for the metric.

$sel:storageResolution:MetricDatum', metricDatum_storageResolution - Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.

$sel:timestamp:MetricDatum', metricDatum_timestamp - The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

$sel:unit:MetricDatum', metricDatum_unit - When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.

MetricDatum, metricDatum_value - The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

$sel:values:MetricDatum', metricDatum_values - Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

$sel:metricName:MetricDatum', metricDatum_metricName - The name of the metric.

metricDatum_counts :: Lens' MetricDatum (Maybe [Double])

Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])

The dimensions associated with the metric.

metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)

The statistical values for the metric.

metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural)

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.

metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime)

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit)

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.

metricDatum_value :: Lens' MetricDatum (Maybe Double)

The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

metricDatum_values :: Lens' MetricDatum (Maybe [Double])

Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

metricDatum_metricName :: Lens' MetricDatum Text

The name of the metric.