Class: Aws::TimestreamWrite::Types::WriteRecordsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-timestreamwrite/types.rb

Overview

Note:

When making an API call, you may pass WriteRecordsRequest data as a hash:

{
  database_name: "ResourceName", # required
  table_name: "ResourceName", # required
  common_attributes: {
    dimensions: [
      {
        name: "SchemaName", # required
        value: "SchemaValue", # required
        dimension_value_type: "VARCHAR", # accepts VARCHAR
      },
    ],
    measure_name: "SchemaName",
    measure_value: "StringValue2048",
    measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
    time: "StringValue256",
    time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
    version: 1,
    measure_values: [
      {
        name: "SchemaName", # required
        value: "StringValue2048", # required
        type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
      },
    ],
  },
  records: [ # required
    {
      dimensions: [
        {
          name: "SchemaName", # required
          value: "SchemaValue", # required
          dimension_value_type: "VARCHAR", # accepts VARCHAR
        },
      ],
      measure_name: "SchemaName",
      measure_value: "StringValue2048",
      measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
      time: "StringValue256",
      time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
      version: 1,
      measure_values: [
        {
          name: "SchemaName", # required
          value: "StringValue2048", # required
          type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#common_attributesTypes::Record

A record containing the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a ‘ValidationException` will be thrown. In other words, a record must contain dimensions with unique names.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1396

class WriteRecordsRequest < Struct.new(
  :database_name,
  :table_name,
  :common_attributes,
  :records)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The name of the Timestream database.

Returns:

  • (String)


1396
1397
1398
1399
1400
1401
1402
1403
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1396

class WriteRecordsRequest < Struct.new(
  :database_name,
  :table_name,
  :common_attributes,
  :records)
  SENSITIVE = []
  include Aws::Structure
end

#recordsArray<Types::Record>

An array of records containing the unique measure, dimension, time, and version attributes for each time series data point.

Returns:



1396
1397
1398
1399
1400
1401
1402
1403
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1396

class WriteRecordsRequest < Struct.new(
  :database_name,
  :table_name,
  :common_attributes,
  :records)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

The name of the Timestream table.

Returns:

  • (String)


1396
1397
1398
1399
1400
1401
1402
1403
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1396

class WriteRecordsRequest < Struct.new(
  :database_name,
  :table_name,
  :common_attributes,
  :records)
  SENSITIVE = []
  include Aws::Structure
end