Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Batch
Load Progress Report Details about the progress of a batch load task.
- Batch
Load Task Details about a batch load task.
- Batch
Load Task Description Details about a batch load task.
- CsvConfiguration
A delimited data format where the column separator can be a comma and the record separator is a newline character.
- Data
Model Data model for a batch load task.
- Data
Model Configuration - Data
Model S3Configuration - Data
Source Configuration Defines configuration details about the data source.
- Data
Source S3Configuration - Database
A top-level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.
- Dimension
Represents the metadata attributes of the time series. For example, the name and Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
- Dimension
Mapping - Endpoint
Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.
- Magnetic
Store Rejected Data Location The location to write error reports for records rejected, asynchronously, during magnetic store writes.
- Magnetic
Store Write Properties The set of properties on a table for configuring magnetic store writes.
- Measure
Value 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 has both name and value.
MeasureValue is only allowed for type
MULTI
. UsingMULTI
type, you can pass multiple data attributes associated with the same time series in a single record- Mixed
Measure Mapping - Multi
Measure Attribute Mapping - Multi
Measure Mappings - Partition
Key An attribute used in partitioning data in a table. A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the 'measure_name' column).
- Record
Represents a time-series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the metadata 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). Additionally, a record contains the measure value and the value type, which is the data type of the measure value. Also, the record contains the timestamp of when the measure was collected and the timestamp unit, which represents the granularity of the timestamp.
Records have a
Version
field, which is a 64-bitlong
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 theVersion
attribute of the record in the write request is higher than that of the existing record. Timestream defaults to aVersion
of1
for records without theVersion
field.- Records
Ingested Information on the records ingested by this request.
- Rejected
Record Represents records that were not successfully inserted into Timestream due to data validation issues that must be resolved before reinserting time-series data into the system.
- Report
Configuration Report configuration for a batch load task. This contains details about where error reports are stored.
- Report
S3Configuration - Retention
Properties Retention properties contain the duration for which your time-series data must be stored in the magnetic store and the memory store.
- S3Configuration
The configuration that specifies an S3 location.
- Schema
A Schema specifies the expected data model of the table.
- Table
Represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.
- Tag
A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. With tags, you can categorize databases and/or tables, for example, by purpose, owner, or environment.
Enums§
- Batch
Load Data Format - When writing a match expression against
BatchLoadDataFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Batch
Load Status - When writing a match expression against
BatchLoadStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Dimension
Value Type - When writing a match expression against
DimensionValueType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Measure
Value Type - When writing a match expression against
MeasureValueType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Partition
KeyEnforcement Level - When writing a match expression against
PartitionKeyEnforcementLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Partition
KeyType - When writing a match expression against
PartitionKeyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - S3Encryption
Option - When writing a match expression against
S3EncryptionOption
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scalar
Measure Value Type - When writing a match expression against
ScalarMeasureValueType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Table
Status - When writing a match expression against
TableStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Time
Unit - When writing a match expression against
TimeUnit
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.