Skip to content

PipeTargetTimestreamParameters

Source code in docs_src/capo_pipes/types/pipe_target_timestream_parameters.py
class PipeTargetTimestreamParameters(TypedDict, closed=True):
    time_value: "capo_pipes.types.time_value.TimeValue"
    """<p>Dynamic path to the source data field that represents the time value for your data.</p>"""
    epoch_time_unit: NotRequired["capo_pipes.types.epoch_time_unit.EpochTimeUnit"]
    """<p>The granularity of the time units used. Default is <code>MILLISECONDS</code>.</p> <p>Required if <code>TimeFieldType</code> is specified as <code>EPOCH</code>.</p>"""
    time_field_type: NotRequired["capo_pipes.types.time_field_type.TimeFieldType"]
    """<p>The type of time value used.</p> <p>The default is <code>EPOCH</code>.</p>"""
    timestamp_format: NotRequired["capo_pipes.types.timestamp_format.TimestampFormat"]
    """<p>How to format the timestamps. For example, <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code>.</p> <p>Required if <code>TimeFieldType</code> is specified as <code>TIMESTAMP_FORMAT</code>.</p>"""
    version_value: "capo_pipes.types.version_value.VersionValue"
    """<p>64 bit version value or source data field that represents the version value for your data.</p> <p>Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated. </p> <p>Default value is 1. </p> <p>Timestream for LiveAnalytics does not support updating partial measure values in a record.</p> <p>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>"""
    dimension_mappings: "capo_pipes.types.dimension_mappings.DimensionMappings"
    """<p>Map source data to dimensions in the target Timestream for LiveAnalytics table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html">Amazon Timestream for LiveAnalytics concepts</a> </p>"""
    single_measure_mappings: NotRequired[
        "capo_pipes.types.single_measure_mappings.SingleMeasureMappings"
    ]
    """<p>Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.</p>"""
    multi_measure_mappings: NotRequired[
        "capo_pipes.types.multi_measure_mappings.MultiMeasureMappings"
    ]
    """<p>Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.</p>"""

dimension_mappings instance-attribute

dimension_mappings: DimensionMappings

Map source data to dimensions in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

epoch_time_unit instance-attribute

epoch_time_unit: NotRequired[EpochTimeUnit]

The granularity of the time units used. Default is MILLISECONDS.

Required if TimeFieldType is specified as EPOCH.

multi_measure_mappings instance-attribute

multi_measure_mappings: NotRequired[MultiMeasureMappings]

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

single_measure_mappings instance-attribute

single_measure_mappings: NotRequired[SingleMeasureMappings]

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

time_field_type instance-attribute

time_field_type: NotRequired[TimeFieldType]

The type of time value used.

The default is EPOCH.

time_value instance-attribute

time_value: TimeValue

Dynamic path to the source data field that represents the time value for your data.

timestamp_format instance-attribute

timestamp_format: NotRequired[TimestampFormat]

How to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z'.

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

version_value instance-attribute

version_value: VersionValue

64 bit version value or source data field that represents the version value for your data.

Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

Default value is 1.

Timestream for LiveAnalytics does not support updating partial measure values in a record.

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.