| 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 |
Amazonka.TimeStreamWrite
Description
Derived from API version 2018-11-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Timestream Write
Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.
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
- data CreateDatabase = CreateDatabase' (Maybe Text) (Maybe [Tag]) Text
- newCreateDatabase :: Text -> CreateDatabase
- data CreateDatabaseResponse = CreateDatabaseResponse' (Maybe Database) Int
- newCreateDatabaseResponse :: Int -> CreateDatabaseResponse
- data CreateTable = CreateTable' (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) (Maybe [Tag]) Text Text
- newCreateTable :: Text -> Text -> CreateTable
- data CreateTableResponse = CreateTableResponse' (Maybe Table) Int
- newCreateTableResponse :: Int -> CreateTableResponse
- data DeleteDatabase = DeleteDatabase' Text
- newDeleteDatabase :: Text -> DeleteDatabase
- data DeleteDatabaseResponse = DeleteDatabaseResponse' {
- newDeleteDatabaseResponse :: DeleteDatabaseResponse
- data DeleteTable = DeleteTable' Text Text
- newDeleteTable :: Text -> Text -> DeleteTable
- data DeleteTableResponse = DeleteTableResponse' {
- newDeleteTableResponse :: DeleteTableResponse
- data DescribeDatabase = DescribeDatabase' Text
- newDescribeDatabase :: Text -> DescribeDatabase
- data DescribeDatabaseResponse = DescribeDatabaseResponse' (Maybe Database) Int
- newDescribeDatabaseResponse :: Int -> DescribeDatabaseResponse
- data DescribeEndpoints = DescribeEndpoints' {
- newDescribeEndpoints :: DescribeEndpoints
- data DescribeEndpointsResponse = DescribeEndpointsResponse' Int [Endpoint]
- newDescribeEndpointsResponse :: Int -> DescribeEndpointsResponse
- data DescribeTable = DescribeTable' Text Text
- newDescribeTable :: Text -> Text -> DescribeTable
- data DescribeTableResponse = DescribeTableResponse' (Maybe Table) Int
- newDescribeTableResponse :: Int -> DescribeTableResponse
- data ListDatabases = ListDatabases' (Maybe Natural) (Maybe Text)
- newListDatabases :: ListDatabases
- data ListDatabasesResponse = ListDatabasesResponse' (Maybe [Database]) (Maybe Text) Int
- newListDatabasesResponse :: Int -> ListDatabasesResponse
- data ListTables = ListTables' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListTables :: ListTables
- data ListTablesResponse = ListTablesResponse' (Maybe Text) (Maybe [Table]) Int
- newListTablesResponse :: Int -> ListTablesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDatabase = UpdateDatabase' Text Text
- newUpdateDatabase :: Text -> Text -> UpdateDatabase
- data UpdateDatabaseResponse = UpdateDatabaseResponse' (Maybe Database) Int
- newUpdateDatabaseResponse :: Int -> UpdateDatabaseResponse
- data UpdateTable = UpdateTable' (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) Text Text
- newUpdateTable :: Text -> Text -> UpdateTable
- data UpdateTableResponse = UpdateTableResponse' (Maybe Table) Int
- newUpdateTableResponse :: Int -> UpdateTableResponse
- data WriteRecords = WriteRecords' (Maybe Record) Text Text (NonEmpty Record)
- newWriteRecords :: Text -> Text -> NonEmpty Record -> WriteRecords
- data WriteRecordsResponse = WriteRecordsResponse' (Maybe RecordsIngested) Int
- newWriteRecordsResponse :: Int -> WriteRecordsResponse
- 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' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Integer)
- newDatabase :: Database
- data Dimension = Dimension' (Maybe DimensionValueType) Text Text
- newDimension :: Text -> Text -> Dimension
- data Endpoint = Endpoint' Text Integer
- newEndpoint :: Text -> Integer -> Endpoint
- data MagneticStoreRejectedDataLocation = MagneticStoreRejectedDataLocation' (Maybe S3Configuration)
- newMagneticStoreRejectedDataLocation :: MagneticStoreRejectedDataLocation
- data MagneticStoreWriteProperties = MagneticStoreWriteProperties' (Maybe MagneticStoreRejectedDataLocation) Bool
- newMagneticStoreWriteProperties :: Bool -> MagneticStoreWriteProperties
- data MeasureValue = MeasureValue' Text Text MeasureValueType
- newMeasureValue :: Text -> Text -> MeasureValueType -> MeasureValue
- data Record = Record' (Maybe [Dimension]) (Maybe Text) (Maybe Text) (Maybe MeasureValueType) (Maybe [MeasureValue]) (Maybe Text) (Maybe TimeUnit) (Maybe Integer)
- newRecord :: Record
- data RecordsIngested = RecordsIngested' (Maybe Int) (Maybe Int) (Maybe Int)
- newRecordsIngested :: RecordsIngested
- data RetentionProperties = RetentionProperties' Natural Natural
- newRetentionProperties :: Natural -> Natural -> RetentionProperties
- data S3Configuration = S3Configuration' (Maybe Text) (Maybe S3EncryptionOption) (Maybe Text) (Maybe Text)
- newS3Configuration :: S3Configuration
- data Table = Table' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) (Maybe Text) (Maybe TableStatus)
- newTable :: Table
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2018-11-01 of the Amazon Timestream Write SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by TimeStreamWrite.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Timestream was unable to process this request because it contains resource that already exists.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException
_InvalidEndpointException :: AsError a => Fold a ServiceError Source #
The requested endpoint was invalid.
RejectedRecordsException
_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
ExistingVersionfield in theRejectedRecordsresponse 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
_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
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Instance quota of resource exceeded for this account.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Invalid or malformed request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateDatabase
data CreateDatabase Source #
See: newCreateDatabase smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateDatabase |
Create a value of CreateDatabase 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:
CreateDatabase, createDatabase_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. Refer to
Amazon Web Services managed KMS keys
for more info.
$sel:tags:CreateDatabase', createDatabase_tags - A list of key-value pairs to label the table.
CreateDatabase, createDatabase_databaseName - The name of the Timestream database.
data CreateDatabaseResponse Source #
See: newCreateDatabaseResponse smart constructor.
Constructors
| CreateDatabaseResponse' (Maybe Database) Int |
Instances
newCreateDatabaseResponse Source #
Create a value of CreateDatabaseResponse 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:database:CreateDatabaseResponse', createDatabaseResponse_database - The newly created Timestream database.
$sel:httpStatus:CreateDatabaseResponse', createDatabaseResponse_httpStatus - The response's http status code.
CreateTable
data CreateTable Source #
See: newCreateTable smart constructor.
Constructors
| CreateTable' (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) (Maybe [Tag]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateTable |
Create a value of CreateTable 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:
CreateTable, createTable_magneticStoreWriteProperties - Contains properties to set on the table when enabling magnetic store
writes.
CreateTable, createTable_retentionProperties - The duration for which your time series data must be stored in the
memory store and the magnetic store.
$sel:tags:CreateTable', createTable_tags - A list of key-value pairs to label the table.
CreateTable, createTable_databaseName - The name of the Timestream database.
CreateTable, createTable_tableName - The name of the Timestream table.
data CreateTableResponse Source #
See: newCreateTableResponse smart constructor.
Constructors
| CreateTableResponse' (Maybe Table) Int |
Instances
newCreateTableResponse Source #
Arguments
| :: Int | |
| -> CreateTableResponse |
Create a value of CreateTableResponse 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:table:CreateTableResponse', createTableResponse_table - The newly created Timestream table.
$sel:httpStatus:CreateTableResponse', createTableResponse_httpStatus - The response's http status code.
DeleteDatabase
data DeleteDatabase Source #
See: newDeleteDatabase smart constructor.
Constructors
| DeleteDatabase' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDatabase |
Create a value of DeleteDatabase 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:
DeleteDatabase, deleteDatabase_databaseName - The name of the Timestream database to be deleted.
data DeleteDatabaseResponse Source #
See: newDeleteDatabaseResponse smart constructor.
Constructors
| DeleteDatabaseResponse' | |
Instances
newDeleteDatabaseResponse :: DeleteDatabaseResponse Source #
Create a value of DeleteDatabaseResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteTable
data DeleteTable Source #
See: newDeleteTable smart constructor.
Constructors
| DeleteTable' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteTable |
Create a value of DeleteTable 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:
DeleteTable, deleteTable_databaseName - The name of the database where the Timestream database is to be deleted.
DeleteTable, deleteTable_tableName - The name of the Timestream table to be deleted.
data DeleteTableResponse Source #
See: newDeleteTableResponse smart constructor.
Constructors
| DeleteTableResponse' | |
Instances
newDeleteTableResponse :: DeleteTableResponse Source #
Create a value of DeleteTableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDatabase
data DescribeDatabase Source #
See: newDescribeDatabase smart constructor.
Constructors
| DescribeDatabase' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDatabase |
Create a value of DescribeDatabase 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:
DescribeDatabase, describeDatabase_databaseName - The name of the Timestream database.
data DescribeDatabaseResponse Source #
See: newDescribeDatabaseResponse smart constructor.
Constructors
| DescribeDatabaseResponse' (Maybe Database) Int |
Instances
newDescribeDatabaseResponse Source #
Create a value of DescribeDatabaseResponse 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:database:DescribeDatabaseResponse', describeDatabaseResponse_database - The name of the Timestream table.
$sel:httpStatus:DescribeDatabaseResponse', describeDatabaseResponse_httpStatus - The response's http status code.
DescribeEndpoints
data DescribeEndpoints Source #
See: newDescribeEndpoints smart constructor.
Constructors
| DescribeEndpoints' | |
Instances
newDescribeEndpoints :: DescribeEndpoints Source #
Create a value of DescribeEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeEndpointsResponse Source #
See: newDescribeEndpointsResponse smart constructor.
Constructors
| DescribeEndpointsResponse' Int [Endpoint] |
Instances
newDescribeEndpointsResponse Source #
Create a value of DescribeEndpointsResponse 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:httpStatus:DescribeEndpointsResponse', describeEndpointsResponse_httpStatus - The response's http status code.
$sel:endpoints:DescribeEndpointsResponse', describeEndpointsResponse_endpoints - An Endpoints object is returned when a DescribeEndpoints request is
made.
DescribeTable
data DescribeTable Source #
See: newDescribeTable smart constructor.
Constructors
| DescribeTable' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeTable |
Create a value of DescribeTable 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:
DescribeTable, describeTable_databaseName - The name of the Timestream database.
DescribeTable, describeTable_tableName - The name of the Timestream table.
data DescribeTableResponse Source #
See: newDescribeTableResponse smart constructor.
Constructors
| DescribeTableResponse' (Maybe Table) Int |
Instances
newDescribeTableResponse Source #
Create a value of DescribeTableResponse 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:table:DescribeTableResponse', describeTableResponse_table - The Timestream table.
$sel:httpStatus:DescribeTableResponse', describeTableResponse_httpStatus - The response's http status code.
ListDatabases
data ListDatabases Source #
See: newListDatabases smart constructor.
Constructors
| ListDatabases' (Maybe Natural) (Maybe Text) |
Instances
newListDatabases :: ListDatabases Source #
Create a value of ListDatabases 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:maxResults:ListDatabases', listDatabases_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.
ListDatabases, listDatabases_nextToken - The pagination token. To resume pagination, provide the NextToken value
as argument of a subsequent API invocation.
data ListDatabasesResponse Source #
See: newListDatabasesResponse smart constructor.
Instances
newListDatabasesResponse Source #
Create a value of ListDatabasesResponse 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:databases:ListDatabasesResponse', listDatabasesResponse_databases - A list of database names.
ListDatabases, listDatabasesResponse_nextToken - The pagination token. This parameter is returned when the response is
truncated.
$sel:httpStatus:ListDatabasesResponse', listDatabasesResponse_httpStatus - The response's http status code.
ListTables
data ListTables Source #
See: newListTables smart constructor.
Instances
newListTables :: ListTables Source #
Create a value of ListTables 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:
ListTables, listTables_databaseName - The name of the Timestream database.
$sel:maxResults:ListTables', listTables_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.
ListTables, listTables_nextToken - The pagination token. To resume pagination, provide the NextToken value
as argument of a subsequent API invocation.
data ListTablesResponse Source #
See: newListTablesResponse smart constructor.
Instances
newListTablesResponse Source #
Arguments
| :: Int | |
| -> ListTablesResponse |
Create a value of ListTablesResponse 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:
ListTables, listTablesResponse_nextToken - A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:tables:ListTablesResponse', listTablesResponse_tables - A list of tables.
$sel:httpStatus:ListTablesResponse', listTablesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Timestream resource with tags to be listed. This value is an Amazon
Resource Name (ARN).
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags currently associated with the Timestream resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceARN:TagResource', tagResource_resourceARN - Identifies the Timestream resource to which tags should be added. This
value is an Amazon Resource Name (ARN).
$sel:tags:TagResource', tagResource_tags - The tags to be assigned to the Timestream resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceARN:UntagResource', untagResource_resourceARN - The Timestream resource that the tags will be removed from. This value
is an Amazon Resource Name (ARN).
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tags keys. Existing tags of the resource whose keys are
members of this list will be removed from the Timestream resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDatabase
data UpdateDatabase Source #
See: newUpdateDatabase smart constructor.
Constructors
| UpdateDatabase' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateDatabase |
Create a value of UpdateDatabase 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:
UpdateDatabase, updateDatabase_databaseName - The name of the database.
UpdateDatabase, updateDatabase_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
data UpdateDatabaseResponse Source #
See: newUpdateDatabaseResponse smart constructor.
Constructors
| UpdateDatabaseResponse' (Maybe Database) Int |
Instances
newUpdateDatabaseResponse Source #
Create a value of UpdateDatabaseResponse 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:database:UpdateDatabaseResponse', updateDatabaseResponse_database - Undocumented member.
$sel:httpStatus:UpdateDatabaseResponse', updateDatabaseResponse_httpStatus - The response's http status code.
UpdateTable
data UpdateTable Source #
See: newUpdateTable smart constructor.
Constructors
| UpdateTable' (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateTable |
Create a value of UpdateTable 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:
UpdateTable, updateTable_magneticStoreWriteProperties - Contains properties to set on the table when enabling magnetic store
writes.
UpdateTable, updateTable_retentionProperties - The retention duration of the memory store and the magnetic store.
UpdateTable, updateTable_databaseName - The name of the Timestream database.
UpdateTable, updateTable_tableName - The name of the Timestream table.
data UpdateTableResponse Source #
See: newUpdateTableResponse smart constructor.
Constructors
| UpdateTableResponse' (Maybe Table) Int |
Instances
newUpdateTableResponse Source #
Arguments
| :: Int | |
| -> UpdateTableResponse |
Create a value of UpdateTableResponse 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:table:UpdateTableResponse', updateTableResponse_table - The updated Timestream table.
$sel:httpStatus:UpdateTableResponse', updateTableResponse_httpStatus - The response's http status code.
WriteRecords
data WriteRecords Source #
See: newWriteRecords smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty Record | |
| -> WriteRecords |
Create a value of WriteRecords 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:commonAttributes:WriteRecords', writeRecords_commonAttributes - 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, writeRecords_databaseName - The name of the Timestream database.
WriteRecords, writeRecords_tableName - The name of the Timestream table.
$sel:records:WriteRecords', writeRecords_records - An array of records containing the unique measure, dimension, time, and
version attributes for each time series data point.
data WriteRecordsResponse Source #
See: newWriteRecordsResponse smart constructor.
Constructors
| WriteRecordsResponse' (Maybe RecordsIngested) Int |
Instances
newWriteRecordsResponse Source #
Arguments
| :: Int | |
| -> WriteRecordsResponse |
Create a value of WriteRecordsResponse 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:recordsIngested:WriteRecordsResponse', writeRecordsResponse_recordsIngested - Information on the records ingested by this request.
$sel:httpStatus:WriteRecordsResponse', writeRecordsResponse_httpStatus - The response's http status code.
Types
DimensionValueType
newtype DimensionValueType Source #
Constructors
| DimensionValueType' | |
Fields | |
Bundled Patterns
| pattern DimensionValueType_VARCHAR :: DimensionValueType |
Instances
MeasureValueType
newtype MeasureValueType Source #
Constructors
| MeasureValueType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| S3EncryptionOption' | |
Fields | |
Bundled Patterns
| pattern S3EncryptionOption_SSE_KMS :: S3EncryptionOption | |
| pattern S3EncryptionOption_SSE_S3 :: S3EncryptionOption |
Instances
TableStatus
newtype TableStatus Source #
Constructors
| TableStatus' | |
Fields | |
Bundled Patterns
| pattern TableStatus_ACTIVE :: TableStatus | |
| pattern TableStatus_DELETING :: TableStatus |
Instances
TimeUnit
Constructors
| TimeUnit' | |
Fields
| |
Bundled Patterns
| 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.
Constructors
| Database' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Integer) |
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.
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.
Constructors
| Dimension' (Maybe DimensionValueType) Text Text |
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.
Endpoint
Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
See: newEndpoint smart constructor.
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.
MagneticStoreRejectedDataLocation
data MagneticStoreRejectedDataLocation Source #
The location to write error reports for records rejected, asynchronously, during magnetic store writes.
See: newMagneticStoreRejectedDataLocation smart constructor.
Constructors
| MagneticStoreRejectedDataLocation' (Maybe S3Configuration) |
Instances
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.
MagneticStoreWriteProperties
data MagneticStoreWriteProperties Source #
The set of properties on a table for configuring magnetic store writes.
See: newMagneticStoreWriteProperties smart constructor.
Instances
newMagneticStoreWriteProperties Source #
Arguments
| :: Bool |
|
| -> MagneticStoreWriteProperties |
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.
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.
Constructors
| MeasureValue' Text Text MeasureValueType |
Instances
Arguments
| :: 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.
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.
Constructors
| Record' (Maybe [Dimension]) (Maybe Text) (Maybe Text) (Maybe MeasureValueType) (Maybe [MeasureValue]) (Maybe Text) (Maybe TimeUnit) (Maybe Integer) |
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.
RecordsIngested
data RecordsIngested Source #
Information on the records ingested by this request.
See: newRecordsIngested smart constructor.
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.
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.
Constructors
| RetentionProperties' Natural Natural |
Instances
newRetentionProperties Source #
Arguments
| :: 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.
S3Configuration
data S3Configuration Source #
Configuration specifing an S3 location.
See: newS3Configuration smart constructor.
Constructors
| S3Configuration' (Maybe Text) (Maybe S3EncryptionOption) (Maybe Text) (Maybe Text) |
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.
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.
Constructors
| Table' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe MagneticStoreWriteProperties) (Maybe RetentionProperties) (Maybe Text) (Maybe TableStatus) |
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.
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.