amazonka-timestream-write-2.0: Amazon Timestream Write SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.TimeStreamWrite.Lens

Description

 
Synopsis

Operations

CreateDatabase

createDatabase_kmsKeyId :: Lens' CreateDatabase (Maybe Text) Source #

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. Refer to Amazon Web Services managed KMS keys for more info.

createDatabase_tags :: Lens' CreateDatabase (Maybe [Tag]) Source #

A list of key-value pairs to label the table.

createDatabase_databaseName :: Lens' CreateDatabase Text Source #

The name of the Timestream database.

CreateTable

createTable_magneticStoreWriteProperties :: Lens' CreateTable (Maybe MagneticStoreWriteProperties) Source #

Contains properties to set on the table when enabling magnetic store writes.

createTable_retentionProperties :: Lens' CreateTable (Maybe RetentionProperties) Source #

The duration for which your time series data must be stored in the memory store and the magnetic store.

createTable_tags :: Lens' CreateTable (Maybe [Tag]) Source #

A list of key-value pairs to label the table.

createTable_databaseName :: Lens' CreateTable Text Source #

The name of the Timestream database.

createTable_tableName :: Lens' CreateTable Text Source #

The name of the Timestream table.

createTableResponse_table :: Lens' CreateTableResponse (Maybe Table) Source #

The newly created Timestream table.

DeleteDatabase

deleteDatabase_databaseName :: Lens' DeleteDatabase Text Source #

The name of the Timestream database to be deleted.

DeleteTable

deleteTable_databaseName :: Lens' DeleteTable Text Source #

The name of the database where the Timestream database is to be deleted.

deleteTable_tableName :: Lens' DeleteTable Text Source #

The name of the Timestream table to be deleted.

DescribeDatabase

describeDatabase_databaseName :: Lens' DescribeDatabase Text Source #

The name of the Timestream database.

DescribeEndpoints

describeEndpointsResponse_endpoints :: Lens' DescribeEndpointsResponse [Endpoint] Source #

An Endpoints object is returned when a DescribeEndpoints request is made.

DescribeTable

describeTable_databaseName :: Lens' DescribeTable Text Source #

The name of the Timestream database.

describeTable_tableName :: Lens' DescribeTable Text Source #

The name of the Timestream table.

ListDatabases

listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural) Source #

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.

listDatabases_nextToken :: Lens' ListDatabases (Maybe Text) Source #

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text) Source #

The pagination token. This parameter is returned when the response is truncated.

ListTables

listTables_databaseName :: Lens' ListTables (Maybe Text) Source #

The name of the Timestream database.

listTables_maxResults :: Lens' ListTables (Maybe Natural) Source #

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.

listTables_nextToken :: Lens' ListTables (Maybe Text) Source #

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The tags currently associated with the Timestream resource.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags to be assigned to the Timestream resource.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.

UpdateDatabase

updateDatabase_kmsKeyId :: Lens' UpdateDatabase Text Source #

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

UpdateTable

updateTable_magneticStoreWriteProperties :: Lens' UpdateTable (Maybe MagneticStoreWriteProperties) Source #

Contains properties to set on the table when enabling magnetic store writes.

updateTable_retentionProperties :: Lens' UpdateTable (Maybe RetentionProperties) Source #

The retention duration of the memory store and the magnetic store.

updateTable_databaseName :: Lens' UpdateTable Text Source #

The name of the Timestream database.

updateTable_tableName :: Lens' UpdateTable Text Source #

The name of the Timestream table.

WriteRecords

writeRecords_commonAttributes :: Lens' WriteRecords (Maybe Record) Source #

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.

writeRecords_databaseName :: Lens' WriteRecords Text Source #

The name of the Timestream database.

writeRecords_tableName :: Lens' WriteRecords Text Source #

The name of the Timestream table.

writeRecords_records :: Lens' WriteRecords (NonEmpty Record) Source #

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

writeRecordsResponse_recordsIngested :: Lens' WriteRecordsResponse (Maybe RecordsIngested) Source #

Information on the records ingested by this request.

Types

Database

database_arn :: Lens' Database (Maybe Text) Source #

The Amazon Resource Name that uniquely identifies this database.

database_creationTime :: Lens' Database (Maybe UTCTime) Source #

The time when the database was created, calculated from the Unix epoch time.

database_databaseName :: Lens' Database (Maybe Text) Source #

The name of the Timestream database.

database_kmsKeyId :: Lens' Database (Maybe Text) Source #

The identifier of the KMS key used to encrypt the data stored in the database.

database_lastUpdatedTime :: Lens' Database (Maybe UTCTime) Source #

The last time that this database was updated.

database_tableCount :: Lens' Database (Maybe Integer) Source #

The total number of tables found within a Timestream database.

Dimension

dimension_dimensionValueType :: Lens' Dimension (Maybe DimensionValueType) Source #

The data type of the dimension for the time series data point.

dimension_name :: Lens' Dimension Text Source #

Dimension represents the meta data 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.

dimension_value :: Lens' Dimension Text Source #

The value of the dimension.

Endpoint

endpoint_address :: Lens' Endpoint Text Source #

An endpoint address.

endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer Source #

The TTL for the endpoint, in minutes.

MagneticStoreRejectedDataLocation

magneticStoreRejectedDataLocation_s3Configuration :: Lens' MagneticStoreRejectedDataLocation (Maybe S3Configuration) Source #

Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.

MagneticStoreWriteProperties

magneticStoreWriteProperties_magneticStoreRejectedDataLocation :: Lens' MagneticStoreWriteProperties (Maybe MagneticStoreRejectedDataLocation) Source #

The location to write error reports for records rejected asynchronously during magnetic store writes.

MeasureValue

measureValue_name :: Lens' MeasureValue Text Source #

Name of the MeasureValue.

For constraints on MeasureValue names, refer to Naming Constraints in the Timestream developer guide.

measureValue_value :: Lens' MeasureValue Text Source #

Value for the MeasureValue.

measureValue_type :: Lens' MeasureValue MeasureValueType Source #

Contains the data type of the MeasureValue for the time series data point.

Record

record_dimensions :: Lens' Record (Maybe [Dimension]) Source #

Contains the list of dimensions for time series data points.

record_measureName :: Lens' Record (Maybe Text) Source #

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.

record_measureValue :: Lens' Record (Maybe Text) Source #

Contains the measure value for the time series data point.

record_measureValueType :: Lens' Record (Maybe MeasureValueType) Source #

Contains the data type of the measure value for the time series data point. Default type is DOUBLE.

record_measureValues :: Lens' Record (Maybe [MeasureValue]) Source #

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.

record_time :: Lens' Record (Maybe Text) Source #

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.

record_timeUnit :: Lens' Record (Maybe TimeUnit) Source #

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS.

record_version :: Lens' Record (Maybe Integer) Source #

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.

RecordsIngested

recordsIngested_magneticStore :: Lens' RecordsIngested (Maybe Int) Source #

Count of records ingested into the magnetic store.

recordsIngested_memoryStore :: Lens' RecordsIngested (Maybe Int) Source #

Count of records ingested into the memory store.

recordsIngested_total :: Lens' RecordsIngested (Maybe Int) Source #

Total count of successfully ingested records.

RetentionProperties

retentionProperties_memoryStoreRetentionPeriodInHours :: Lens' RetentionProperties Natural Source #

The duration for which data must be stored in the memory store.

retentionProperties_magneticStoreRetentionPeriodInDays :: Lens' RetentionProperties Natural Source #

The duration for which data must be stored in the magnetic store.

S3Configuration

s3Configuration_bucketName :: Lens' S3Configuration (Maybe Text) Source #

Bucket name of the customer S3 bucket.

s3Configuration_encryptionOption :: Lens' S3Configuration (Maybe S3EncryptionOption) Source #

Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.

s3Configuration_kmsKeyId :: Lens' S3Configuration (Maybe Text) Source #

KMS key id for the customer s3 location when encrypting with a KMS managed key.

s3Configuration_objectKeyPrefix :: Lens' S3Configuration (Maybe Text) Source #

Object key preview for the customer S3 location.

Table

table_arn :: Lens' Table (Maybe Text) Source #

The Amazon Resource Name that uniquely identifies this table.

table_creationTime :: Lens' Table (Maybe UTCTime) Source #

The time when the Timestream table was created.

table_databaseName :: Lens' Table (Maybe Text) Source #

The name of the Timestream database that contains this table.

table_lastUpdatedTime :: Lens' Table (Maybe UTCTime) Source #

The time when the Timestream table was last updated.

table_magneticStoreWriteProperties :: Lens' Table (Maybe MagneticStoreWriteProperties) Source #

Contains properties to set on the table when enabling magnetic store writes.

table_retentionProperties :: Lens' Table (Maybe RetentionProperties) Source #

The retention duration for the memory store and magnetic store.

table_tableName :: Lens' Table (Maybe Text) Source #

The name of the Timestream table.

table_tableStatus :: Lens' Table (Maybe TableStatus) Source #

The current state of the table:

  • DELETING - The table is being deleted.
  • ACTIVE - The table is ready for use.

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag. Tag keys are case sensitive.

tag_value :: Lens' Tag Text Source #

The value of the tag. Tag values are case-sensitive and can be null.