Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MetricDataQuery = MetricDataQuery' {
- expression :: Maybe Text
- label :: Maybe Text
- metricStat :: Maybe MetricStat
- returnData :: Maybe Bool
- id :: Text
- newMetricDataQuery :: Text -> MetricDataQuery
- metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text)
- metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text)
- metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat)
- metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool)
- metricDataQuery_id :: Lens' MetricDataQuery Text
Documentation
data MetricDataQuery Source #
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
See: newMetricDataQuery
smart constructor.
MetricDataQuery' | |
|
Instances
Create a value of MetricDataQuery
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:expression:MetricDataQuery'
, metricDataQuery_expression
- The math expression to perform on the returned data, if this object is
performing a math expression. This expression can use the Id
of the
other metrics to refer to those metrics, and can also use the Id
of
other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery
object, you must specify
either Expression
or MetricStat
, but not both.
$sel:label:MetricDataQuery'
, metricDataQuery_label
- A human-readable label for this metric or expression. This is especially
useful if this is a math expression, so that you know what the value
represents.
$sel:metricStat:MetricDataQuery'
, metricDataQuery_metricStat
- Information about the metric data to return.
Conditional: Within each MetricDataQuery
object, you must specify
either Expression
or MetricStat
, but not both.
$sel:returnData:MetricDataQuery'
, metricDataQuery_returnData
- Indicates whether to return the timestamps and raw data values of this
metric.
If you use any math expressions, specify true
for this value for only
the final math expression that the metric specification is based on. You
must specify false
for ReturnData
for all the other metrics and
expressions used in the metric specification.
If you are only retrieving metrics and not performing any math
expressions, do not specify anything for ReturnData
. This sets it to
its default (true
).
$sel:id:MetricDataQuery'
, metricDataQuery_id
- A short name that identifies the object's results in the response. This
name must be unique among all MetricDataQuery
objects specified for a
single scaling policy. If you are performing math expressions on this
set of data, this name represents that data and can serve as a variable
in the mathematical expression. The valid characters are letters,
numbers, and underscores. The first character must be a lowercase
letter.
metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text) Source #
The math expression to perform on the returned data, if this object is
performing a math expression. This expression can use the Id
of the
other metrics to refer to those metrics, and can also use the Id
of
other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery
object, you must specify
either Expression
or MetricStat
, but not both.
metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text) Source #
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat) Source #
Information about the metric data to return.
Conditional: Within each MetricDataQuery
object, you must specify
either Expression
or MetricStat
, but not both.
metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool) Source #
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only
the final math expression that the metric specification is based on. You
must specify false
for ReturnData
for all the other metrics and
expressions used in the metric specification.
If you are only retrieving metrics and not performing any math
expressions, do not specify anything for ReturnData
. This sets it to
its default (true
).
metricDataQuery_id :: Lens' MetricDataQuery Text Source #
A short name that identifies the object's results in the response. This
name must be unique among all MetricDataQuery
objects specified for a
single scaling policy. If you are performing math expressions on this
set of data, this name represents that data and can serve as a variable
in the mathematical expression. The valid characters are letters,
numbers, and underscores. The first character must be a lowercase
letter.