Class: Aws::Pipes::Types::PipeTargetTimestreamParameters

Inherits:

Struct

• Object
• Struct
• Aws::Pipes::Types::PipeTargetTimestreamParameters

Includes:

Structure

Defined in:

lib/aws-sdk-pipes/types.rb

Overview

The parameters for using a Timestream for LiveAnalytics table as a target.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dimension_mappings ⇒ Array<Types::DimensionMapping>

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

• #epoch_time_unit ⇒ String

  The granularity of the time units used.

• #multi_measure_mappings ⇒ Array<Types::MultiMeasureMapping>

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

• #single_measure_mappings ⇒ Array<Types::SingleMeasureMapping>

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

• #time_field_type ⇒ String

  The type of time value used.

• #time_value ⇒ String

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

• #timestamp_format ⇒ String

  How to format the timestamps.

• #version_value ⇒ String

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

Instance Attribute Details

#dimension_mappings ⇒ Array<Types::DimensionMapping>

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

For more information, see [Amazon Timestream for LiveAnalytics concepts]

[1]: docs.aws.amazon.com/timestream/latest/developerguide/concepts.html

Returns:

• (Array<Types::DimensionMapping>)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#epoch_time_unit ⇒ String

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

Required if ‘TimeFieldType` is specified as `EPOCH`.

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#multi_measure_mappings ⇒ Array<Types::MultiMeasureMapping>

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

Returns:

• (Array<Types::MultiMeasureMapping>)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#single_measure_mappings ⇒ Array<Types::SingleMeasureMapping>

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

Returns:

• (Array<Types::SingleMeasureMapping>)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#time_field_type ⇒ String

The type of time value used.

The default is ‘EPOCH`.

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#time_value ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp_format ⇒ String

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

Required if ‘TimeFieldType` is specified as `TIMESTAMP_FORMAT`.

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#version_value ⇒ String

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`.

<note markdown=“1”> ‘Version` must be `1` or greater, or you will receive a `ValidationException` error.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2723

class PipeTargetTimestreamParameters < Struct.new(
  :time_value,
  :epoch_time_unit,
  :time_field_type,
  :timestamp_format,
  :version_value,
  :dimension_mappings,
  :single_measure_mappings,
  :multi_measure_mappings)
  SENSITIVE = []
  include Aws::Structure
end