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.CloudWatch.Types.MetricDataResult

Description

Synopsis

Documentation

data MetricDataResult Source #

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

See: newMetricDataResult smart constructor.

Constructors

MetricDataResult'

Fields

id :: Maybe Text
The short name you specified to represent this metric.
label :: Maybe Text
The human-readable label associated with the data.
messages :: Maybe [MessageData]
A list of messages with additional information about the data returned.
statusCode :: Maybe StatusCode
The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.
timestamps :: Maybe [ISO8601]
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].
values :: Maybe [Double]
The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Instances

Instances details

FromXML MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods parseXML :: [Node] -> Either String MetricDataResult #
Generic MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Associated Types type Rep MetricDataResult :: Type -> Type # Methods from :: MetricDataResult -> Rep MetricDataResult x # to :: Rep MetricDataResult x -> MetricDataResult #
Read MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods readsPrec :: Int -> ReadS MetricDataResult # readList :: ReadS [MetricDataResult] # readPrec :: ReadPrec MetricDataResult # readListPrec :: ReadPrec [MetricDataResult] #
Show MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods showsPrec :: Int -> MetricDataResult -> ShowS # show :: MetricDataResult -> String # showList :: [MetricDataResult] -> ShowS #
NFData MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods rnf :: MetricDataResult -> () #
Eq MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods (==) :: MetricDataResult -> MetricDataResult -> Bool # (/=) :: MetricDataResult -> MetricDataResult -> Bool #
Hashable MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult Methods hashWithSalt :: Int -> MetricDataResult -> Int # hash :: MetricDataResult -> Int #
type Rep MetricDataResult Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricDataResult type Rep MetricDataResult = D1 ('MetaData "MetricDataResult" "Amazonka.CloudWatch.Types.MetricDataResult" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "MetricDataResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MessageData])))) :: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusCode)) :: (S1 ('MetaSel ('Just "timestamps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ISO8601])) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double]))))))

newMetricDataResult :: MetricDataResult Source #

Create a value of MetricDataResult 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:id:MetricDataResult', metricDataResult_id - The short name you specified to represent this metric.

$sel:label:MetricDataResult', metricDataResult_label - The human-readable label associated with the data.

$sel:messages:MetricDataResult', metricDataResult_messages - A list of messages with additional information about the data returned.

$sel:statusCode:MetricDataResult', metricDataResult_statusCode - The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

$sel:timestamps:MetricDataResult', metricDataResult_timestamps - The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

$sel:values:MetricDataResult', metricDataResult_values - The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

metricDataResult_id :: Lens' MetricDataResult (Maybe Text) Source #

The short name you specified to represent this metric.

metricDataResult_label :: Lens' MetricDataResult (Maybe Text) Source #

The human-readable label associated with the data.

metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData]) Source #

A list of messages with additional information about the data returned.

metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode) Source #

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime]) Source #

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

metricDataResult_values :: Lens' MetricDataResult (Maybe [Double]) Source #

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].