Amazonka.TimeStreamWrite.Types.Record

Documentation

data Record

Record represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data attributes of a time series data point such as the instance name or availability zone of an EC2 instance. A record also contains the measure name which is the name of the measure being collected for example the CPU utilization of an EC2 instance. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp.

Records have a Version field, which is a 64-bit long that you can use for updating data points. Writes of a duplicate record with the same dimension, timestamp, and measure name but different measure value will only succeed if the Version attribute of the record in the write request is higher than that of the existing record. Timestream defaults to a Version of 1 for records without the Version field.

See: newRecord smart constructor.

Constructors

Record'

Fields

• dimensions :: Maybe [Dimension]

  Contains the list of dimensions for time series data points.

• measureName :: Maybe Text

  Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

• measureValue :: Maybe Text

  Contains the measure value for the time series data point.

• measureValueType :: Maybe MeasureValueType

  Contains the data type of the measure value for the time series data point. Default type is DOUBLE.

• measureValues :: Maybe [MeasureValue]

  Contains the list of MeasureValue for time series data points.

  This is only allowed for type MULTI. For scalar values, use MeasureValue attribute of the Record directly.

• time :: Maybe Text

  Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch.

• timeUnit :: Maybe TimeUnit

  The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS.

• version :: Maybe Integer

  64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is 1.

  Version must be 1 or greater, or you will receive a ValidationException error.

Instances

ToJSON Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

toJSON :: Record -> Value

toEncoding :: Record -> Encoding

toJSONList :: [Record] -> Value

toEncodingList :: [Record] -> Encoding

Generic Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Associated Types

type Rep Record :: Type -> Type

Methods

from :: Record -> Rep Record x

to :: Rep Record x -> Record

Read Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

readsPrec :: Int -> ReadS Record

readList :: ReadS [Record]

readPrec :: ReadPrec Record

readListPrec :: ReadPrec [Record]

Show Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

NFData Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

rnf :: Record -> ()

Eq Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

(==) :: Record -> Record -> Bool

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

Hashable Record

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

hashWithSalt :: Int -> Record -> Int

hash :: Record -> Int

type Rep Record

Defined in Amazonka.TimeStreamWrite.Types.Record

type Rep Record = D1 ('MetaData "Record" "Amazonka.TimeStreamWrite.Types.Record" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "Record'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dimension])) :*: S1 ('MetaSel ('Just "measureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "measureValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "measureValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MeasureValueType)))) :*: ((S1 ('MetaSel ('Just "measureValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MeasureValue])) :*: S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "timeUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeUnit)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newRecord :: Record

Create a value of Record 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:dimensions:Record', record_dimensions - Contains the list of dimensions for time series data points.

$sel:measureName:Record', record_measureName - Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

$sel:measureValue:Record', record_measureValue - Contains the measure value for the time series data point.

$sel:measureValueType:Record', record_measureValueType - Contains the data type of the measure value for the time series data point. Default type is DOUBLE.

$sel:measureValues:Record', record_measureValues - Contains the list of MeasureValue for time series data points.

This is only allowed for type MULTI. For scalar values, use MeasureValue attribute of the Record directly.

$sel:time:Record', record_time - Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch.

$sel:timeUnit:Record', record_timeUnit - The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS.

$sel:version:Record', record_version - 64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is 1.

Version must be 1 or greater, or you will receive a ValidationException error.

record_dimensions :: Lens' Record (Maybe [Dimension])

Contains the list of dimensions for time series data points.

record_measureName :: Lens' Record (Maybe Text)

Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

record_measureValue :: Lens' Record (Maybe Text)

Contains the measure value for the time series data point.

record_measureValueType :: Lens' Record (Maybe MeasureValueType)

Contains the data type of the measure value for the time series data point. Default type is DOUBLE.

record_measureValues :: Lens' Record (Maybe [MeasureValue])

Contains the list of MeasureValue for time series data points.

This is only allowed for type MULTI. For scalar values, use MeasureValue attribute of the Record directly.

record_time :: Lens' Record (Maybe Text)

Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch.

record_timeUnit :: Lens' Record (Maybe TimeUnit)

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS.

record_version :: Lens' Record (Maybe Integer)

64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is 1.

Version must be 1 or greater, or you will receive a ValidationException error.