amazonka-timestream-write-2.0: Amazon Timestream Write 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.TimeStreamWrite.Types.Record

Description

 
Synopsis

Documentation

data Record Source #

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

Instances details
ToJSON Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

Generic Record Source # 
Instance details

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 Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

Show Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

NFData Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

rnf :: Record -> () #

Eq Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

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

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

Hashable Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

Methods

hashWithSalt :: Int -> Record -> Int #

hash :: Record -> Int #

type Rep Record Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.Types.Record

newRecord :: Record Source #

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]) Source #

Contains the list of dimensions for time series data points.

record_measureName :: Lens' Record (Maybe Text) Source #

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) Source #

Contains the measure value for the time series data point.

record_measureValueType :: Lens' Record (Maybe MeasureValueType) Source #

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

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

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) Source #

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) Source #

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) Source #

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.