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

Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery

Description

Documentation

data TargetTrackingMetricDataQuery 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.

See: newTargetTrackingMetricDataQuery smart constructor.

Constructors

TargetTrackingMetricDataQuery'

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 TargetTrackingMetricDataQuery 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 TargetTrackingMetricStat
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery 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 TargetTrackingMetricDataQuery 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 TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods toQuery :: TargetTrackingMetricDataQuery -> QueryString #
FromXML TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods parseXML :: [Node] -> Either String TargetTrackingMetricDataQuery #
Generic TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Associated Types type Rep TargetTrackingMetricDataQuery :: Type -> Type # Methods from :: TargetTrackingMetricDataQuery -> Rep TargetTrackingMetricDataQuery x # to :: Rep TargetTrackingMetricDataQuery x -> TargetTrackingMetricDataQuery #
Read TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods readsPrec :: Int -> ReadS TargetTrackingMetricDataQuery # readList :: ReadS [TargetTrackingMetricDataQuery] # readPrec :: ReadPrec TargetTrackingMetricDataQuery # readListPrec :: ReadPrec [TargetTrackingMetricDataQuery] #
Show TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods showsPrec :: Int -> TargetTrackingMetricDataQuery -> ShowS # show :: TargetTrackingMetricDataQuery -> String # showList :: [TargetTrackingMetricDataQuery] -> ShowS #
NFData TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods rnf :: TargetTrackingMetricDataQuery -> () #
Eq TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods (==) :: TargetTrackingMetricDataQuery -> TargetTrackingMetricDataQuery -> Bool # (/=) :: TargetTrackingMetricDataQuery -> TargetTrackingMetricDataQuery -> Bool #
Hashable TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery Methods hashWithSalt :: Int -> TargetTrackingMetricDataQuery -> Int # hash :: TargetTrackingMetricDataQuery -> Int #
type Rep TargetTrackingMetricDataQuery Source #
Instance details Defined in Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery type Rep TargetTrackingMetricDataQuery = D1 ('MetaData "TargetTrackingMetricDataQuery" "Amazonka.AutoScaling.Types.TargetTrackingMetricDataQuery" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "TargetTrackingMetricDataQuery'" '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 TargetTrackingMetricStat)) :: (S1 ('MetaSel ('Just "returnData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTargetTrackingMetricDataQuery Source #

Arguments

:: Text	`$sel:id:TargetTrackingMetricDataQuery'`
-> TargetTrackingMetricDataQuery

Create a value of TargetTrackingMetricDataQuery 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:TargetTrackingMetricDataQuery', targetTrackingMetricDataQuery_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 TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

$sel:label:TargetTrackingMetricDataQuery', targetTrackingMetricDataQuery_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:TargetTrackingMetricDataQuery', targetTrackingMetricDataQuery_metricStat - Information about the metric data to return.

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

$sel:returnData:TargetTrackingMetricDataQuery', targetTrackingMetricDataQuery_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:TargetTrackingMetricDataQuery', targetTrackingMetricDataQuery_id - A short name that identifies the object's results in the response. This name must be unique among all TargetTrackingMetricDataQuery 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.

targetTrackingMetricDataQuery_expression :: Lens' TargetTrackingMetricDataQuery (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 TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

targetTrackingMetricDataQuery_label :: Lens' TargetTrackingMetricDataQuery (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.

targetTrackingMetricDataQuery_metricStat :: Lens' TargetTrackingMetricDataQuery (Maybe TargetTrackingMetricStat) Source #

Information about the metric data to return.

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

targetTrackingMetricDataQuery_returnData :: Lens' TargetTrackingMetricDataQuery (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).

targetTrackingMetricDataQuery_id :: Lens' TargetTrackingMetricDataQuery Text Source #

A short name that identifies the object's results in the response. This name must be unique among all TargetTrackingMetricDataQuery 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.