Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidEndpointException :: AsError a => Fold a ServiceError
- _RejectedRecordsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype DimensionValueType where
- newtype MeasureValueType where
- MeasureValueType' { }
- pattern MeasureValueType_BIGINT :: MeasureValueType
- pattern MeasureValueType_BOOLEAN :: MeasureValueType
- pattern MeasureValueType_DOUBLE :: MeasureValueType
- pattern MeasureValueType_MULTI :: MeasureValueType
- pattern MeasureValueType_TIMESTAMP :: MeasureValueType
- pattern MeasureValueType_VARCHAR :: MeasureValueType
- newtype S3EncryptionOption where
- S3EncryptionOption' { }
- pattern S3EncryptionOption_SSE_KMS :: S3EncryptionOption
- pattern S3EncryptionOption_SSE_S3 :: S3EncryptionOption
- newtype TableStatus where
- TableStatus' { }
- pattern TableStatus_ACTIVE :: TableStatus
- pattern TableStatus_DELETING :: TableStatus
- newtype TimeUnit where
- TimeUnit' {
- fromTimeUnit :: Text
- pattern TimeUnit_MICROSECONDS :: TimeUnit
- pattern TimeUnit_MILLISECONDS :: TimeUnit
- pattern TimeUnit_NANOSECONDS :: TimeUnit
- pattern TimeUnit_SECONDS :: TimeUnit
- TimeUnit' {
- data Database = Database' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- databaseName :: Maybe Text
- kmsKeyId :: Maybe Text
- lastUpdatedTime :: Maybe POSIX
- tableCount :: Maybe Integer
- newDatabase :: Database
- database_arn :: Lens' Database (Maybe Text)
- database_creationTime :: Lens' Database (Maybe UTCTime)
- database_databaseName :: Lens' Database (Maybe Text)
- database_kmsKeyId :: Lens' Database (Maybe Text)
- database_lastUpdatedTime :: Lens' Database (Maybe UTCTime)
- database_tableCount :: Lens' Database (Maybe Integer)
- data Dimension = Dimension' {}
- newDimension :: Text -> Text -> Dimension
- dimension_dimensionValueType :: Lens' Dimension (Maybe DimensionValueType)
- dimension_name :: Lens' Dimension Text
- dimension_value :: Lens' Dimension Text
- data Endpoint = Endpoint' {}
- newEndpoint :: Text -> Integer -> Endpoint
- endpoint_address :: Lens' Endpoint Text
- endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer
- data MagneticStoreRejectedDataLocation = MagneticStoreRejectedDataLocation' {}
- newMagneticStoreRejectedDataLocation :: MagneticStoreRejectedDataLocation
- magneticStoreRejectedDataLocation_s3Configuration :: Lens' MagneticStoreRejectedDataLocation (Maybe S3Configuration)
- data MagneticStoreWriteProperties = MagneticStoreWriteProperties' {}
- newMagneticStoreWriteProperties :: Bool -> MagneticStoreWriteProperties
- magneticStoreWriteProperties_magneticStoreRejectedDataLocation :: Lens' MagneticStoreWriteProperties (Maybe MagneticStoreRejectedDataLocation)
- magneticStoreWriteProperties_enableMagneticStoreWrites :: Lens' MagneticStoreWriteProperties Bool
- data MeasureValue = MeasureValue' {}
- newMeasureValue :: Text -> Text -> MeasureValueType -> MeasureValue
- measureValue_name :: Lens' MeasureValue Text
- measureValue_value :: Lens' MeasureValue Text
- measureValue_type :: Lens' MeasureValue MeasureValueType
- data Record = Record' {}
- newRecord :: Record
- record_dimensions :: Lens' Record (Maybe [Dimension])
- record_measureName :: Lens' Record (Maybe Text)
- record_measureValue :: Lens' Record (Maybe Text)
- record_measureValueType :: Lens' Record (Maybe MeasureValueType)
- record_measureValues :: Lens' Record (Maybe [MeasureValue])
- record_time :: Lens' Record (Maybe Text)
- record_timeUnit :: Lens' Record (Maybe TimeUnit)
- record_version :: Lens' Record (Maybe Integer)
- data RecordsIngested = RecordsIngested' {
- magneticStore :: Maybe Int
- memoryStore :: Maybe Int
- total :: Maybe Int
- newRecordsIngested :: RecordsIngested
- recordsIngested_magneticStore :: Lens' RecordsIngested (Maybe Int)
- recordsIngested_memoryStore :: Lens' RecordsIngested (Maybe Int)
- recordsIngested_total :: Lens' RecordsIngested (Maybe Int)
- data RetentionProperties = RetentionProperties' {}
- newRetentionProperties :: Natural -> Natural -> RetentionProperties
- retentionProperties_memoryStoreRetentionPeriodInHours :: Lens' RetentionProperties Natural
- retentionProperties_magneticStoreRetentionPeriodInDays :: Lens' RetentionProperties Natural
- data S3Configuration = S3Configuration' {}
- newS3Configuration :: S3Configuration
- s3Configuration_bucketName :: Lens' S3Configuration (Maybe Text)
- s3Configuration_encryptionOption :: Lens' S3Configuration (Maybe S3EncryptionOption)
- s3Configuration_kmsKeyId :: Lens' S3Configuration (Maybe Text)
- s3Configuration_objectKeyPrefix :: Lens' S3Configuration (Maybe Text)
- data Table = Table' {}
- newTable :: Table
- table_arn :: Lens' Table (Maybe Text)
- table_creationTime :: Lens' Table (Maybe UTCTime)
- table_databaseName :: Lens' Table (Maybe Text)
- table_lastUpdatedTime :: Lens' Table (Maybe UTCTime)
- table_magneticStoreWriteProperties :: Lens' Table (Maybe MagneticStoreWriteProperties)
- table_retentionProperties :: Lens' Table (Maybe RetentionProperties)
- table_tableName :: Lens' Table (Maybe Text)
- table_tableStatus :: Lens' Table (Maybe TableStatus)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2018-11-01
of the Amazon Timestream Write SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
Timestream was unable to process this request because it contains resource that already exists.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Timestream was unable to fully process this request because of an internal server error.
_InvalidEndpointException :: AsError a => Fold a ServiceError Source #
The requested endpoint was invalid.
_RejectedRecordsException :: AsError a => Fold a ServiceError Source #
WriteRecords would throw this exception in the following cases:
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
In this case, if Timestream rejects data, the
ExistingVersion
field in theRejectedRecords
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 theExistingVersion
.- Records with timestamps that lie outside the retention duration of the memory store
- Records with dimensions or measures that exceed the Timestream defined limits.
For more information, see Quotas in the Timestream Developer Guide.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Instance quota of resource exceeded for this account.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Too many requests were made by a user exceeding service quotas. The request was throttled.
_ValidationException :: AsError a => Fold a ServiceError Source #
Invalid or malformed request.
DimensionValueType
newtype DimensionValueType Source #
pattern DimensionValueType_VARCHAR :: DimensionValueType |
Instances
MeasureValueType
newtype MeasureValueType Source #
pattern MeasureValueType_BIGINT :: MeasureValueType | |
pattern MeasureValueType_BOOLEAN :: MeasureValueType | |
pattern MeasureValueType_DOUBLE :: MeasureValueType | |
pattern MeasureValueType_MULTI :: MeasureValueType | |
pattern MeasureValueType_TIMESTAMP :: MeasureValueType | |
pattern MeasureValueType_VARCHAR :: MeasureValueType |
Instances
S3EncryptionOption
newtype S3EncryptionOption Source #
pattern S3EncryptionOption_SSE_KMS :: S3EncryptionOption | |
pattern S3EncryptionOption_SSE_S3 :: S3EncryptionOption |
Instances
TableStatus
newtype TableStatus Source #
pattern TableStatus_ACTIVE :: TableStatus | |
pattern TableStatus_DELETING :: TableStatus |
Instances
TimeUnit
pattern TimeUnit_MICROSECONDS :: TimeUnit | |
pattern TimeUnit_MILLISECONDS :: TimeUnit | |
pattern TimeUnit_NANOSECONDS :: TimeUnit | |
pattern TimeUnit_SECONDS :: TimeUnit |
Instances
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.
See: newDatabase
smart constructor.
Database' | |
|
Instances
newDatabase :: Database Source #
Create a value of Database
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Database'
, database_arn
- The Amazon Resource Name that uniquely identifies this database.
$sel:creationTime:Database'
, database_creationTime
- The time when the database was created, calculated from the Unix epoch
time.
$sel:databaseName:Database'
, database_databaseName
- The name of the Timestream database.
$sel:kmsKeyId:Database'
, database_kmsKeyId
- The identifier of the KMS key used to encrypt the data stored in the
database.
$sel:lastUpdatedTime:Database'
, database_lastUpdatedTime
- The last time that this database was updated.
$sel:tableCount:Database'
, database_tableCount
- The total number of tables found within a Timestream 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_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 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.
See: newDimension
smart constructor.
Dimension' | |
|
Instances
ToJSON Dimension Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Dimension | |
Generic Dimension Source # | |
Read Dimension Source # | |
Show Dimension Source # | |
NFData Dimension Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Dimension | |
Eq Dimension Source # | |
Hashable Dimension Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Dimension | |
type Rep Dimension Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Dimension type Rep Dimension = D1 ('MetaData "Dimension" "Amazonka.TimeStreamWrite.Types.Dimension" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "Dimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionValueType)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
Create a value of Dimension
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionValueType:Dimension'
, dimension_dimensionValueType
- The data type of the dimension for the time series data point.
$sel:name:Dimension'
, dimension_name
- 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.
$sel:value:Dimension'
, dimension_value
- The value of the 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.
Endpoint
Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
See: newEndpoint
smart constructor.
Endpoint' | |
|
Instances
FromJSON Endpoint Source # | |
Generic Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Endpoint | |
Eq Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Endpoint | |
type Rep Endpoint Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.TimeStreamWrite.Types.Endpoint" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cachePeriodInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) |
Create a value of Endpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:Endpoint'
, endpoint_address
- An endpoint address.
$sel:cachePeriodInMinutes:Endpoint'
, endpoint_cachePeriodInMinutes
- The TTL for the endpoint, in minutes.
endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer Source #
The TTL for the endpoint, in minutes.
MagneticStoreRejectedDataLocation
data MagneticStoreRejectedDataLocation Source #
The location to write error reports for records rejected, asynchronously, during magnetic store writes.
See: newMagneticStoreRejectedDataLocation
smart constructor.
MagneticStoreRejectedDataLocation' | |
|
Instances
FromJSON MagneticStoreRejectedDataLocation Source # | |
ToJSON MagneticStoreRejectedDataLocation Source # | |
Generic MagneticStoreRejectedDataLocation Source # | |
Read MagneticStoreRejectedDataLocation Source # | |
Show MagneticStoreRejectedDataLocation Source # | |
NFData MagneticStoreRejectedDataLocation Source # | |
Eq MagneticStoreRejectedDataLocation Source # | |
Hashable MagneticStoreRejectedDataLocation Source # | |
type Rep MagneticStoreRejectedDataLocation Source # | |
Defined in Amazonka.TimeStreamWrite.Types.MagneticStoreRejectedDataLocation type Rep MagneticStoreRejectedDataLocation = D1 ('MetaData "MagneticStoreRejectedDataLocation" "Amazonka.TimeStreamWrite.Types.MagneticStoreRejectedDataLocation" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "MagneticStoreRejectedDataLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Configuration)))) |
newMagneticStoreRejectedDataLocation :: MagneticStoreRejectedDataLocation Source #
Create a value of MagneticStoreRejectedDataLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Configuration:MagneticStoreRejectedDataLocation'
, magneticStoreRejectedDataLocation_s3Configuration
- Configuration of an S3 location to write error reports for records
rejected, asynchronously, during magnetic store writes.
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
data MagneticStoreWriteProperties Source #
The set of properties on a table for configuring magnetic store writes.
See: newMagneticStoreWriteProperties
smart constructor.
MagneticStoreWriteProperties' | |
|
Instances
newMagneticStoreWriteProperties Source #
Create a value of MagneticStoreWriteProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:magneticStoreRejectedDataLocation:MagneticStoreWriteProperties'
, magneticStoreWriteProperties_magneticStoreRejectedDataLocation
- The location to write error reports for records rejected asynchronously
during magnetic store writes.
$sel:enableMagneticStoreWrites:MagneticStoreWriteProperties'
, magneticStoreWriteProperties_enableMagneticStoreWrites
- A flag to enable magnetic store writes.
magneticStoreWriteProperties_magneticStoreRejectedDataLocation :: Lens' MagneticStoreWriteProperties (Maybe MagneticStoreRejectedDataLocation) Source #
The location to write error reports for records rejected asynchronously during magnetic store writes.
magneticStoreWriteProperties_enableMagneticStoreWrites :: Lens' MagneticStoreWriteProperties Bool Source #
A flag to enable magnetic store writes.
MeasureValue
data MeasureValue Source #
MeasureValue 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
. Using MULTI
type, you
can pass multiple data attributes associated with the same time series
in a single record
See: newMeasureValue
smart constructor.
MeasureValue' | |
|
Instances
:: Text | |
-> Text | |
-> MeasureValueType | |
-> MeasureValue |
Create a value of MeasureValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:MeasureValue'
, measureValue_name
- Name of the MeasureValue.
For constraints on MeasureValue names, refer to Naming Constraints in the Timestream developer guide.
$sel:value:MeasureValue'
, measureValue_value
- Value for the MeasureValue.
$sel:type':MeasureValue'
, measureValue_type
- Contains the data type of the MeasureValue for the time series data
point.
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 represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data 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. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp.
Records have a Version
field, which is a 64-bit long
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 the Version
attribute of the record in the write
request is higher than that of the existing record. Timestream defaults
to a Version
of 1
for records without the Version
field.
See: newRecord
smart constructor.
Record' | |
|
Instances
Create a value of Record
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:Record'
, record_dimensions
- Contains the list of dimensions for time series data points.
$sel:measureName:Record'
, record_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.
$sel:measureValue:Record'
, record_measureValue
- Contains the measure value for the time series data point.
$sel:measureValueType:Record'
, record_measureValueType
- Contains the data type of the measure value for the time series data
point. Default type is DOUBLE
.
$sel:measureValues:Record'
, record_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.
$sel:time:Record'
, record_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.
$sel:timeUnit:Record'
, record_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
.
$sel:version:Record'
, record_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.
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
data RecordsIngested Source #
Information on the records ingested by this request.
See: newRecordsIngested
smart constructor.
RecordsIngested' | |
|
Instances
newRecordsIngested :: RecordsIngested Source #
Create a value of RecordsIngested
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:magneticStore:RecordsIngested'
, recordsIngested_magneticStore
- Count of records ingested into the magnetic store.
$sel:memoryStore:RecordsIngested'
, recordsIngested_memoryStore
- Count of records ingested into the memory store.
$sel:total:RecordsIngested'
, recordsIngested_total
- Total count of successfully ingested records.
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
data RetentionProperties Source #
Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.
See: newRetentionProperties
smart constructor.
RetentionProperties' | |
|
Instances
newRetentionProperties Source #
:: Natural | |
-> Natural |
|
-> RetentionProperties |
Create a value of RetentionProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:memoryStoreRetentionPeriodInHours:RetentionProperties'
, retentionProperties_memoryStoreRetentionPeriodInHours
- The duration for which data must be stored in the memory store.
$sel:magneticStoreRetentionPeriodInDays:RetentionProperties'
, retentionProperties_magneticStoreRetentionPeriodInDays
- The duration for which data must be stored in the magnetic store.
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
data S3Configuration Source #
Configuration specifing an S3 location.
See: newS3Configuration
smart constructor.
S3Configuration' | |
|
Instances
newS3Configuration :: S3Configuration Source #
Create a value of S3Configuration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketName:S3Configuration'
, s3Configuration_bucketName
- >Bucket name of the customer S3 bucket.
$sel:encryptionOption:S3Configuration'
, s3Configuration_encryptionOption
- Encryption option for the customer s3 location. Options are S3 server
side encryption with an S3-managed key or KMS managed key.
$sel:kmsKeyId:S3Configuration'
, s3Configuration_kmsKeyId
- KMS key id for the customer s3 location when encrypting with a KMS
managed key.
$sel:objectKeyPrefix:S3Configuration'
, s3Configuration_objectKeyPrefix
- Object key preview for the customer S3 location.
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 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.
See: newTable
smart constructor.
Table' | |
|
Instances
Create a value of Table
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Table'
, table_arn
- The Amazon Resource Name that uniquely identifies this table.
$sel:creationTime:Table'
, table_creationTime
- The time when the Timestream table was created.
$sel:databaseName:Table'
, table_databaseName
- The name of the Timestream database that contains this table.
$sel:lastUpdatedTime:Table'
, table_lastUpdatedTime
- The time when the Timestream table was last updated.
$sel:magneticStoreWriteProperties:Table'
, table_magneticStoreWriteProperties
- Contains properties to set on the table when enabling magnetic store
writes.
$sel:retentionProperties:Table'
, table_retentionProperties
- The retention duration for the memory store and magnetic store.
$sel:tableName:Table'
, table_tableName
- The name of the Timestream table.
$sel:tableStatus:Table'
, table_tableStatus
- The current state of the table:
DELETING
- The table is being deleted.ACTIVE
- The table is ready for use.
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_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
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. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.TimeStreamWrite.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.TimeStreamWrite.Types.Tag" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key of the tag. Tag keys are case sensitive.
$sel:value:Tag'
, tag_value
- The value of the tag. Tag values are case-sensitive and can be null.