String taskId
The ID of the batch load task.
String taskStatus
Status of the batch load task.
String databaseName
Database name for the database into which a batch load task loads data.
String tableName
Table name for the table into which a batch load task loads data.
Date creationTime
The time when the Timestream batch load task was created.
Date lastUpdatedTime
The time when the Timestream batch load task was last updated.
Date resumableUntil
String taskId
The ID of the batch load task.
String errorMessage
DataSourceConfiguration dataSourceConfiguration
Configuration details about the data source for a batch load task.
BatchLoadProgressReport progressReport
ReportConfiguration reportConfiguration
Report configuration for a batch load task. This contains details about where error reports are stored.
DataModelConfiguration dataModelConfiguration
Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.
String targetDatabaseName
String targetTableName
String taskStatus
Status of the batch load task.
Long recordVersion
Date creationTime
The time when the Timestream batch load task was created.
Date lastUpdatedTime
The time when the Timestream batch load task was last updated.
Date resumableUntil
String clientToken
DataModelConfiguration dataModelConfiguration
DataSourceConfiguration dataSourceConfiguration
Defines configuration details about the data source for a batch load task.
ReportConfiguration reportConfiguration
String targetDatabaseName
Target Timestream database for a batch load task.
String targetTableName
Target Timestream table for a batch load task.
Long recordVersion
String taskId
The ID of the batch load task.
String databaseName
The name of the Timestream database.
String kmsKeyId
The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys.
List<E> tags
A list of key-value pairs to label the table.
Database database
The newly created Timestream database.
String databaseName
The name of the Timestream database.
String tableName
The name of the Timestream table.
RetentionProperties retentionProperties
The duration for which your time-series data must be stored in the memory store and the magnetic store.
List<E> tags
A list of key-value pairs to label the table.
MagneticStoreWriteProperties magneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
Table table
The newly created Timestream table.
String columnSeparator
Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or blank space (' ').
String escapeChar
Escape character can be one of
String quoteChar
Can be single quote (') or double quote (").
String nullValue
Can be blank space (' ').
Boolean trimWhiteSpace
Specifies to trim leading and trailing white space.
String arn
The Amazon Resource Name that uniquely identifies this database.
String databaseName
The name of the Timestream database.
Long tableCount
The total number of tables found within a Timestream database.
String kmsKeyId
The identifier of the KMS key used to encrypt the data stored in the database.
Date creationTime
The time when the database was created, calculated from the Unix epoch time.
Date lastUpdatedTime
The last time that this database was updated.
String timeColumn
Source column to be mapped to time.
String 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
.
List<E> dimensionMappings
Source to target mappings for dimensions.
MultiMeasureMappings multiMeasureMappings
Source to target mappings for multi-measure records.
List<E> mixedMeasureMappings
Source to target mappings for measures.
String measureNameColumn
DataModel dataModel
DataModelS3Configuration dataModelS3Configuration
DataSourceS3Configuration dataSourceS3Configuration
Configuration of an S3 location for a file which contains data to load.
CsvConfiguration csvConfiguration
String dataFormat
This is currently CSV.
String databaseName
The name of the Timestream database to be deleted.
String taskId
The ID of the batch load task.
BatchLoadTaskDescription batchLoadTaskDescription
Description of the batch load task.
String databaseName
The name of the Timestream database.
Database database
The name of the Timestream table.
Table table
The Timestream table.
String name
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.
For constraints on dimension names, see Naming Constraints.
String value
The value of the dimension.
String dimensionValueType
The data type of the dimension for the time-series data point.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Integer maxResults
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
String taskStatus
Status of the batch load task.
String nextToken
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Integer maxResults
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
String databaseName
The name of the Timestream database.
String nextToken
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Integer maxResults
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
String resourceARN
The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
S3Configuration s3Configuration
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
Boolean enableMagneticStoreWrites
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation magneticStoreRejectedDataLocation
The location to write error reports for records rejected asynchronously during magnetic store writes.
String name
The name of the MeasureValue.
For constraints on MeasureValue names, see Naming Constraints in the Amazon Timestream Developer Guide.
String value
The value for the MeasureValue.
String type
Contains the data type of the MeasureValue for the time-series data point.
List<E> dimensions
Contains the list of dimensions for time-series data points.
String measureName
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.
String measureValue
Contains the measure value for the time-series data point.
String measureValueType
Contains the data type of the measure value for the time-series data point. Default type is DOUBLE
.
String time
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.
String 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
.
Long version
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.
List<E> 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.
Integer recordIndex
The index of the record in the input request for WriteRecords. Indexes begin with 0.
String reason
The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:
Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but:
Measure values are different
Version is not present in the request, or the value of version in the new record is equal to or lower than the existing value
If Timestream rejects data for this case, the ExistingVersion
field in the
RejectedRecords
response will indicate the current record’s version. To force an update, you can
resend the request with a version for the record set to a value greater than the ExistingVersion
.
Records with timestamps that lie outside the retention duration of the memory store.
When the retention window is updated, you will receive a RejectedRecords
exception if you
immediately try to ingest data within the new window. To avoid a RejectedRecords
exception, wait
until the duration of the new window to ingest new data. For further information, see Best
Practices for Configuring Timestream and the explanation of how storage
works in Timestream.
Records with dimensions or measures that exceed the Timestream defined limits.
For more information, see Access Management in the Timestream Developer Guide.
Long existingVersion
The existing version of the record. This value is populated in scenarios where an identical record exists with a higher version than the version in the write request.
ReportS3Configuration reportS3Configuration
Configuration of an S3 location to write error reports and events for a batch load.
String taskId
The ID of the batch load task to resume.
String bucketName
The bucket name of the customer S3 bucket.
String objectKeyPrefix
The object key preview for the customer S3 location.
String encryptionOption
The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.
String kmsKeyId
The KMS key ID for the customer S3 location when encrypting with an Amazon Web Services managed key.
String arn
The Amazon Resource Name that uniquely identifies this table.
String tableName
The name of the Timestream table.
String databaseName
The name of the Timestream database that contains this table.
String tableStatus
The current state of the table:
DELETING
- The table is being deleted.
ACTIVE
- The table is ready for use.
RetentionProperties retentionProperties
The retention duration for the memory store and magnetic store.
Date creationTime
The time when the Timestream table was created.
Date lastUpdatedTime
The time when the Timestream table was last updated.
MagneticStoreWriteProperties magneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
String databaseName
The name of the database.
String kmsKeyId
The identifier of the new KMS key (KmsKeyId
) to be used to encrypt the data stored in the database.
If the KmsKeyId
currently registered with the database is the same as the KmsKeyId
in
the request, there will not be any update.
You can specify the KmsKeyId
using any of the following:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias
Database database
String databaseName
The name of the Timestream database.
String tableName
The name of the Timestream table.
RetentionProperties retentionProperties
The retention duration of the memory store and the magnetic store.
MagneticStoreWriteProperties magneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
Table table
The updated Timestream table.
String databaseName
The name of the Timestream database.
String tableName
The name of the Timestream table.
Record commonAttributes
A record that contains 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.
List<E> records
An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.
RecordsIngested recordsIngested
Information on the records ingested by this request.
Copyright © 2023. All rights reserved.