Table of Contents
TimestreamWrite.Client¶A low-level client representing 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.
import boto3
client = boto3.client('timestream-write')
These are the available methods:
can_paginate()close()create_database()create_table()delete_database()delete_table()describe_database()describe_endpoints()describe_table()get_paginator()get_waiter()list_databases()list_tables()list_tags_for_resource()tag_resource()untag_resource()update_database()update_table()write_records()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_database(**kwargs)¶Creates a new Timestream 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. Service quotas apply . See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.create_database(
DatabaseName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the Timestream database.
A list of key-value pairs to label the table.
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.
The key of the tag. Tag keys are case sensitive.
The value of the tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'Database': {
'Arn': 'string',
'DatabaseName': 'string',
'TableCount': 123,
'KmsKeyId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Database (dict) --
The newly created Timestream database.
Arn (string) --
The Amazon Resource Name that uniquely identifies this database.
DatabaseName (string) --
The name of the Timestream database.
TableCount (integer) --
The total number of tables found within a Timestream database.
KmsKeyId (string) --
The identifier of the KMS key used to encrypt the data stored in the database.
CreationTime (datetime) --
The time when the database was created, calculated from the Unix epoch time.
LastUpdatedTime (datetime) --
The last time that this database was updated.
Exceptions
TimestreamWrite.Client.exceptions.ConflictExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ServiceQuotaExceededExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionTimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptioncreate_table(**kwargs)¶The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply . See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.create_table(
DatabaseName='string',
TableName='string',
RetentionProperties={
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
MagneticStoreWriteProperties={
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
)
[REQUIRED]
The name of the Timestream database.
[REQUIRED]
The name of the Timestream table.
The duration for which your time series data must be stored in the memory store and the magnetic store.
The duration for which data must be stored in the memory store.
The duration for which data must be stored in the magnetic store.
A list of key-value pairs to label the table.
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.
The key of the tag. Tag keys are case sensitive.
The value of the tag. Tag values are case-sensitive and can be null.
Contains properties to set on the table when enabling magnetic store writes.
A flag to enable magnetic store writes.
The location to write error reports for records rejected asynchronously during magnetic store writes.
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
>Bucket name of the customer S3 bucket.
Object key preview for the customer S3 location.
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KMS key id for the customer s3 location when encrypting with a KMS managed key.
dict
Response Syntax
{
'Table': {
'Arn': 'string',
'TableName': 'string',
'DatabaseName': 'string',
'TableStatus': 'ACTIVE'|'DELETING',
'RetentionProperties': {
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'MagneticStoreWriteProperties': {
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
}
}
Response Structure
(dict) --
Table (dict) --
The newly created Timestream table.
Arn (string) --
The Amazon Resource Name that uniquely identifies this table.
TableName (string) --
The name of the Timestream table.
DatabaseName (string) --
The name of the Timestream database that contains this table.
TableStatus (string) --
The current state of the table:
DELETING - The table is being deleted.ACTIVE - The table is ready for use.RetentionProperties (dict) --
The retention duration for the memory store and magnetic store.
MemoryStoreRetentionPeriodInHours (integer) --
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) --
The duration for which data must be stored in the magnetic store.
CreationTime (datetime) --
The time when the Timestream table was created.
LastUpdatedTime (datetime) --
The time when the Timestream table was last updated.
MagneticStoreWriteProperties (dict) --
Contains properties to set on the table when enabling magnetic store writes.
EnableMagneticStoreWrites (boolean) --
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation (dict) --
The location to write error reports for records rejected asynchronously during magnetic store writes.
S3Configuration (dict) --
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
BucketName (string) --
>Bucket name of the customer S3 bucket.
ObjectKeyPrefix (string) --
Object key preview for the customer S3 location.
EncryptionOption (string) --
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KmsKeyId (string) --
KMS key id for the customer s3 location when encrypting with a KMS managed key.
Exceptions
TimestreamWrite.Client.exceptions.ConflictExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ServiceQuotaExceededExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionTimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptiondelete_database(**kwargs)¶Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time series data from its tables cannot be recovered.
Note
All tables in the database must be deleted first, or a ValidationException error will be thrown.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.delete_database(
DatabaseName='string'
)
[REQUIRED]
The name of the Timestream database to be deleted.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptiondelete_table(**kwargs)¶Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time series data stored in the table cannot be recovered.
Note
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.delete_table(
DatabaseName='string',
TableName='string'
)
[REQUIRED]
The name of the database where the Timestream database is to be deleted.
[REQUIRED]
The name of the Timestream table to be deleted.
None
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptiondescribe_database(**kwargs)¶Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply . See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.describe_database(
DatabaseName='string'
)
[REQUIRED]
The name of the Timestream database.
{
'Database': {
'Arn': 'string',
'DatabaseName': 'string',
'TableCount': 123,
'KmsKeyId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
The name of the Timestream table.
The Amazon Resource Name that uniquely identifies this database.
The name of the Timestream database.
The total number of tables found within a Timestream database.
The identifier of the KMS key used to encrypt the data stored in the database.
The time when the database was created, calculated from the Unix epoch time.
The last time that this database was updated.
Exceptions
TimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptiondescribe_endpoints()¶DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless :
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern .
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoints()
{
'Endpoints': [
{
'Address': 'string',
'CachePeriodInMinutes': 123
},
]
}
Response Structure
An Endpoints object is returned when a DescribeEndpoints request is made.
Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
An endpoint address.
The TTL for the endpoint, in minutes.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptiondescribe_table(**kwargs)¶Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply . See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.describe_table(
DatabaseName='string',
TableName='string'
)
[REQUIRED]
The name of the Timestream database.
[REQUIRED]
The name of the Timestream table.
dict
Response Syntax
{
'Table': {
'Arn': 'string',
'TableName': 'string',
'DatabaseName': 'string',
'TableStatus': 'ACTIVE'|'DELETING',
'RetentionProperties': {
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'MagneticStoreWriteProperties': {
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
}
}
Response Structure
(dict) --
Table (dict) --
The Timestream table.
Arn (string) --
The Amazon Resource Name that uniquely identifies this table.
TableName (string) --
The name of the Timestream table.
DatabaseName (string) --
The name of the Timestream database that contains this table.
TableStatus (string) --
The current state of the table:
DELETING - The table is being deleted.ACTIVE - The table is ready for use.RetentionProperties (dict) --
The retention duration for the memory store and magnetic store.
MemoryStoreRetentionPeriodInHours (integer) --
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) --
The duration for which data must be stored in the magnetic store.
CreationTime (datetime) --
The time when the Timestream table was created.
LastUpdatedTime (datetime) --
The time when the Timestream table was last updated.
MagneticStoreWriteProperties (dict) --
Contains properties to set on the table when enabling magnetic store writes.
EnableMagneticStoreWrites (boolean) --
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation (dict) --
The location to write error reports for records rejected asynchronously during magnetic store writes.
S3Configuration (dict) --
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
BucketName (string) --
>Bucket name of the customer S3 bucket.
ObjectKeyPrefix (string) --
Object key preview for the customer S3 location.
EncryptionOption (string) --
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KmsKeyId (string) --
KMS key id for the customer s3 location when encrypting with a KMS managed key.
Exceptions
TimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_databases(**kwargs)¶Returns a list of your Timestream databases. Service quotas apply . See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.list_databases(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Databases': [
{
'Arn': 'string',
'DatabaseName': 'string',
'TableCount': 123,
'KmsKeyId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Databases (list) --
A list of database names.
(dict) --
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.
Arn (string) --
The Amazon Resource Name that uniquely identifies this database.
DatabaseName (string) --
The name of the Timestream database.
TableCount (integer) --
The total number of tables found within a Timestream database.
KmsKeyId (string) --
The identifier of the KMS key used to encrypt the data stored in the database.
CreationTime (datetime) --
The time when the database was created, calculated from the Unix epoch time.
LastUpdatedTime (datetime) --
The last time that this database was updated.
NextToken (string) --
The pagination token. This parameter is returned when the response is truncated.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionlist_tables(**kwargs)¶A list of tables, along with the name, status and retention properties of each table. See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.list_tables(
DatabaseName='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Tables': [
{
'Arn': 'string',
'TableName': 'string',
'DatabaseName': 'string',
'TableStatus': 'ACTIVE'|'DELETING',
'RetentionProperties': {
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'MagneticStoreWriteProperties': {
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tables (list) --
A list of tables.
(dict) --
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.
Arn (string) --
The Amazon Resource Name that uniquely identifies this table.
TableName (string) --
The name of the Timestream table.
DatabaseName (string) --
The name of the Timestream database that contains this table.
TableStatus (string) --
The current state of the table:
DELETING - The table is being deleted.ACTIVE - The table is ready for use.RetentionProperties (dict) --
The retention duration for the memory store and magnetic store.
MemoryStoreRetentionPeriodInHours (integer) --
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) --
The duration for which data must be stored in the magnetic store.
CreationTime (datetime) --
The time when the Timestream table was created.
LastUpdatedTime (datetime) --
The time when the Timestream table was last updated.
MagneticStoreWriteProperties (dict) --
Contains properties to set on the table when enabling magnetic store writes.
EnableMagneticStoreWrites (boolean) --
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation (dict) --
The location to write error reports for records rejected asynchronously during magnetic store writes.
S3Configuration (dict) --
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
BucketName (string) --
>Bucket name of the customer S3 bucket.
ObjectKeyPrefix (string) --
Object key preview for the customer S3 location.
EncryptionOption (string) --
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KmsKeyId (string) --
KMS key id for the customer s3 location when encrypting with a KMS managed key.
NextToken (string) --
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionList all tags on a Timestream resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags currently associated with the Timestream resource.
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.
The key of the tag. Tag keys are case sensitive.
The value of the tag. Tag values are case-sensitive and can be null.
Exceptions
TimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptiontag_resource(**kwargs)¶Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).
[REQUIRED]
The tags to be assigned to the Timestream resource.
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.
The key of the tag. Tag keys are case sensitive.
The value of the tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{}
Response Structure
Exceptions
TimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ServiceQuotaExceededExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionuntag_resource(**kwargs)¶Removes the association of tags from a Timestream resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
[REQUIRED]
A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.
dict
Response Syntax
{}
Response Structure
Exceptions
TimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ServiceQuotaExceededExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionupdate_database(**kwargs)¶Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId ). If there are any concurrent UpdateDatabase requests, first writer wins.
See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.update_database(
DatabaseName='string',
KmsKeyId='string'
)
[REQUIRED]
The name of the database.
[REQUIRED]
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:
1234abcd-12ab-34cd-56ef-1234567890abarn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890abalias/ExampleAliasarn:aws:kms:us-east-1:111122223333:alias/ExampleAliasdict
Response Syntax
{
'Database': {
'Arn': 'string',
'DatabaseName': 'string',
'TableCount': 123,
'KmsKeyId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Database (dict) --
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.
Arn (string) --
The Amazon Resource Name that uniquely identifies this database.
DatabaseName (string) --
The name of the Timestream database.
TableCount (integer) --
The total number of tables found within a Timestream database.
KmsKeyId (string) --
The identifier of the KMS key used to encrypt the data stored in the database.
CreationTime (datetime) --
The time when the database was created, calculated from the Unix epoch time.
LastUpdatedTime (datetime) --
The last time that this database was updated.
Exceptions
TimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.ServiceQuotaExceededExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionupdate_table(**kwargs)¶Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.
See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.update_table(
DatabaseName='string',
TableName='string',
RetentionProperties={
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
MagneticStoreWriteProperties={
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
)
[REQUIRED]
The name of the Timestream database.
[REQUIRED]
The name of the Timestream table.
The retention duration of the memory store and the magnetic store.
The duration for which data must be stored in the memory store.
The duration for which data must be stored in the magnetic store.
Contains properties to set on the table when enabling magnetic store writes.
A flag to enable magnetic store writes.
The location to write error reports for records rejected asynchronously during magnetic store writes.
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
>Bucket name of the customer S3 bucket.
Object key preview for the customer S3 location.
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KMS key id for the customer s3 location when encrypting with a KMS managed key.
dict
Response Syntax
{
'Table': {
'Arn': 'string',
'TableName': 'string',
'DatabaseName': 'string',
'TableStatus': 'ACTIVE'|'DELETING',
'RetentionProperties': {
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'MagneticStoreWriteProperties': {
'EnableMagneticStoreWrites': True|False,
'MagneticStoreRejectedDataLocation': {
'S3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
}
}
}
}
Response Structure
(dict) --
Table (dict) --
The updated Timestream table.
Arn (string) --
The Amazon Resource Name that uniquely identifies this table.
TableName (string) --
The name of the Timestream table.
DatabaseName (string) --
The name of the Timestream database that contains this table.
TableStatus (string) --
The current state of the table:
DELETING - The table is being deleted.ACTIVE - The table is ready for use.RetentionProperties (dict) --
The retention duration for the memory store and magnetic store.
MemoryStoreRetentionPeriodInHours (integer) --
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) --
The duration for which data must be stored in the magnetic store.
CreationTime (datetime) --
The time when the Timestream table was created.
LastUpdatedTime (datetime) --
The time when the Timestream table was last updated.
MagneticStoreWriteProperties (dict) --
Contains properties to set on the table when enabling magnetic store writes.
EnableMagneticStoreWrites (boolean) --
A flag to enable magnetic store writes.
MagneticStoreRejectedDataLocation (dict) --
The location to write error reports for records rejected asynchronously during magnetic store writes.
S3Configuration (dict) --
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
BucketName (string) --
>Bucket name of the customer S3 bucket.
ObjectKeyPrefix (string) --
Object key preview for the customer S3 location.
EncryptionOption (string) --
Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
KmsKeyId (string) --
KMS key id for the customer s3 location when encrypting with a KMS managed key.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionwrite_records(**kwargs)¶The WriteRecords operation enables you to write your time series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you with a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream support eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply .
See code sample for details.
Upserts
You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when not specified for the record in the request. Timestream will update an existing record’s measure value along with its Version upon receiving a write request with a higher Version number for that record. Upon receiving an update request where the measure value is the same as that of the existing record, Timestream still updates Version , if it is greater than the existing value of Version . You can update a data point as many times as desired, as long as the value of Version continuously increases.
For example, suppose you write a new record without indicating Version in the request. Timestream will store this record, and set Version to 1 . Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version . In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. However, if you were to resend the update request with Version set to 2 , Timestream would then succeed in updating the record’s value, and the Version would be set to 2 . Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3 . In this case, Timestream would only update Version to 3 . Any further updates would need to send a version number greater than 3 , or the update requests would receive a RejectedRecordsException .
See also: AWS API Documentation
Request Syntax
response = client.write_records(
DatabaseName='string',
TableName='string',
CommonAttributes={
'Dimensions': [
{
'Name': 'string',
'Value': 'string',
'DimensionValueType': 'VARCHAR'
},
],
'MeasureName': 'string',
'MeasureValue': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN'|'TIMESTAMP'|'MULTI',
'Time': 'string',
'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS',
'Version': 123,
'MeasureValues': [
{
'Name': 'string',
'Value': 'string',
'Type': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN'|'TIMESTAMP'|'MULTI'
},
]
},
Records=[
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string',
'DimensionValueType': 'VARCHAR'
},
],
'MeasureName': 'string',
'MeasureValue': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN'|'TIMESTAMP'|'MULTI',
'Time': 'string',
'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS',
'Version': 123,
'MeasureValues': [
{
'Name': 'string',
'Value': 'string',
'Type': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN'|'TIMESTAMP'|'MULTI'
},
]
},
]
)
[REQUIRED]
The name of the Timestream database.
[REQUIRED]
The name of the Timestream table.
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.
Contains the list of dimensions for time series data points.
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.
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 .
The value of the dimension.
The data type of the dimension for the time series data point.
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.
Contains the measure value for the time series data point.
Contains the data type of the measure value for the time series data point. Default type is DOUBLE .
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.
The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS .
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 .
Note
Version must be 1 or greater, or you will receive a ValidationException error.
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.
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
Name of the MeasureValue.
For constraints on MeasureValue names, refer to Naming Constraints in the Timestream developer guide.
Value for the MeasureValue.
Contains the data type of the MeasureValue for the time series data point.
[REQUIRED]
An array of records containing the unique measure, dimension, time, and version attributes for each time series data point.
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.
Contains the list of dimensions for time series data points.
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.
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 .
The value of the dimension.
The data type of the dimension for the time series data point.
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.
Contains the measure value for the time series data point.
Contains the data type of the measure value for the time series data point. Default type is DOUBLE .
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.
The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. Default is MILLISECONDS .
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 .
Note
Version must be 1 or greater, or you will receive a ValidationException error.
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.
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
Name of the MeasureValue.
For constraints on MeasureValue names, refer to Naming Constraints in the Timestream developer guide.
Value for the MeasureValue.
Contains the data type of the MeasureValue for the time series data point.
dict
Response Syntax
{
'RecordsIngested': {
'Total': 123,
'MemoryStore': 123,
'MagneticStore': 123
}
}
Response Structure
(dict) --
RecordsIngested (dict) --
Information on the records ingested by this request.
Total (integer) --
Total count of successfully ingested records.
MemoryStore (integer) --
Count of records ingested into the memory store.
MagneticStore (integer) --
Count of records ingested into the magnetic store.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.ValidationExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.RejectedRecordsExceptionTimestreamWrite.Client.exceptions.InvalidEndpointExceptionThe available paginators are: