amazonka-autoscaling-2.0: Amazon Auto Scaling SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AutoScaling.Types.MetricDataQuery

Description

 
Synopsis

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.

Constructors

MetricDataQuery' 

Fields

  • expression :: Maybe Text

    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.

  • label :: Maybe Text

    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.

  • metricStat :: Maybe MetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

  • returnData :: Maybe Bool

    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).

  • id :: Text

    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.

Instances

Instances details
ToQuery MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

FromXML MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

Generic MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

Associated Types

type Rep MetricDataQuery :: Type -> Type #

Read MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

Show MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

NFData MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

Methods

rnf :: MetricDataQuery -> () #

Eq MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

Hashable MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

type Rep MetricDataQuery Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.MetricDataQuery

type Rep MetricDataQuery = D1 ('MetaData "MetricDataQuery" "Amazonka.AutoScaling.Types.MetricDataQuery" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "MetricDataQuery'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "metricStat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricStat)) :*: (S1 ('MetaSel ('Just "returnData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMetricDataQuery Source #

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.