Skip to content

Record

Source code in docs_src/capo_timestream_write/types/record.py
class Record(TypedDict, closed=True):
    dimensions: NotRequired["capo_timestream_write.types.dimensions.Dimensions"]
    """<p>Contains the list of dimensions for time-series data points.</p>"""
    measure_name: NotRequired["capo_timestream_write.types.schema_name.SchemaName"]
    """<p>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. </p>"""
    measure_value: NotRequired[
        "capo_timestream_write.types.string_value2048.StringValue2048"
    ]
    """<p> Contains the measure value for the time-series data point. </p>"""
    measure_value_type: NotRequired[
        "capo_timestream_write.types.measure_value_type.MeasureValueType"
    ]
    """<p> Contains the data type of the measure value for the time-series data point. Default type is <code>DOUBLE</code>. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types">Data types</a>.</p>"""
    time: NotRequired["capo_timestream_write.types.string_value256.StringValue256"]
    """<p> 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 <code>12345</code> and the unit is <code>ms</code>, then <code>12345 ms</code> have elapsed since the epoch. </p>"""
    time_unit: NotRequired["capo_timestream_write.types.time_unit.TimeUnit"]
    """<p> The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is <code>MILLISECONDS</code>. </p>"""
    version: NotRequired["capo_timestream_write.types.record_version.RecordVersion"]
    """<p>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, <code>Version</code> will still be updated. Default value is <code>1</code>.</p> <note> <p> <code>Version</code> must be <code>1</code> or greater, or you will receive a <code>ValidationException</code> error.</p> </note>"""
    measure_values: NotRequired[
        "capo_timestream_write.types.measure_values.MeasureValues"
    ]
    """<p> Contains the list of MeasureValue for time-series data points. </p> <p> This is only allowed for type <code>MULTI</code>. For scalar values, use <code>MeasureValue</code> attribute of the record directly. </p>"""

dimensions instance-attribute

dimensions: NotRequired[Dimensions]

Contains the list of dimensions for time-series data points.

measure_name instance-attribute

measure_name: NotRequired[SchemaName]

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.

measure_value instance-attribute

measure_value: NotRequired[StringValue2048]

Contains the measure value for the time-series data point.

measure_value_type instance-attribute

measure_value_type: NotRequired[MeasureValueType]

Contains the data type of the measure value for the time-series data point. Default type is DOUBLE. For more information, see Data types.

measure_values instance-attribute

measure_values: NotRequired[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.

time instance-attribute

time: NotRequired[StringValue256]

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.

time_unit instance-attribute

time_unit: NotRequired[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 instance-attribute

version: NotRequired[RecordVersion]

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.