2020/09/29 - Amazon Timestream Write - 15 new api methods
Changes Update timestream-write client to latest version
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 also: AWS API Documentation
Request Syntax
client.update_database(
DatabaseName='string',
KmsKeyId='string'
)
string
[REQUIRED]
The name of the database.
string
[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:
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
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) --
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.
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.
See also: AWS API Documentation
Request Syntax
client.delete_table(
DatabaseName='string',
TableName='string'
)
string
[REQUIRED]
The name of the database where the Timestream database is to be deleted.
string
[REQUIRED]
The name of the Timestream table to be deleted.
None
Returns a list of your Timestream databases. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_databases(
NextToken='string',
MaxResults=123
)
string
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
integer
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.
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.
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
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).
list
[REQUIRED]
The tags to be assigned to the Timestream resource.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of the tag. Tag keys are case sensitive.
Value (string) -- [REQUIRED]
The value of the tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{}
Response Structure
(dict) --
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. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_database(
DatabaseName='string'
)
string
[REQUIRED]
The name of the Timestream database.
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 name of the Timestream table.
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.
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 AWS managed KMS keys for more info. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_database(
DatabaseName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the Timestream database.
string
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 AWS managed KMS keys for more info.
list
A list of key-value pairs to label the table.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of the tag. Tag keys are case sensitive.
Value (string) -- [REQUIRED]
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.
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because Timestream’s 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:
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.
See also: AWS API Documentation
Request Syntax
client.describe_endpoints()
dict
Response Syntax
{
'Endpoints': [
{
'Address': 'string',
'CachePeriodInMinutes': 123
},
]
}
Response Structure
(dict) --
Endpoints (list) --
An Endpoints object is returned when a DescribeEndpoints request is made.
(dict) --
Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
Address (string) --
An endpoint address.
CachePeriodInMinutes (integer) --
The TTL for the endpoint, in minutes.
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. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.write_records(
DatabaseName='string',
TableName='string',
CommonAttributes={
'Dimensions': [
{
'Name': 'string',
'Value': 'string',
'DimensionValueType': 'VARCHAR'
},
],
'MeasureName': 'string',
'MeasureValue': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN',
'Time': 'string',
'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS'
},
Records=[
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string',
'DimensionValueType': 'VARCHAR'
},
],
'MeasureName': 'string',
'MeasureValue': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN',
'Time': 'string',
'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS'
},
]
)
string
[REQUIRED]
The name of the Timestream database.
string
[REQUIRED]
The name of the Timesream table.
dict
A record containing the common measure and dimension attributes shared across all the records in the request. The measure and dimension attributes specified in here will be merged with the measure and dimension attributes in the records object when the data is written into Timestream.
Dimensions (list) --
Contains the list of dimensions for time series data points.
(dict) --
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.
Name (string) -- [REQUIRED]
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 names can only contain alphanumeric characters and underscores. Dimension names cannot end with an underscore.
Value (string) -- [REQUIRED]
The value of the dimension.
DimensionValueType (string) --
The data type of the dimension for the time series data point.
MeasureName (string) --
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.
MeasureValue (string) --
Contains the measure value for the time series data point.
MeasureValueType (string) --
Contains the data type of the measure value for the time series data point.
Time (string) --
Contains the time at which the measure value for the data point was collected.
TimeUnit (string) --
The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.
list
[REQUIRED]
An array of records containing the unique dimension and measure attributes for each time series data point.
(dict) --
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.
Dimensions (list) --
Contains the list of dimensions for time series data points.
(dict) --
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.
Name (string) -- [REQUIRED]
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 names can only contain alphanumeric characters and underscores. Dimension names cannot end with an underscore.
Value (string) -- [REQUIRED]
The value of the dimension.
DimensionValueType (string) --
The data type of the dimension for the time series data point.
MeasureName (string) --
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.
MeasureValue (string) --
Contains the measure value for the time series data point.
MeasureValueType (string) --
Contains the data type of the measure value for the time series data point.
Time (string) --
Contains the time at which the measure value for the data point was collected.
TimeUnit (string) --
The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.
None
Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_table(
DatabaseName='string',
TableName='string'
)
string
[REQUIRED]
The name of the Timestream database.
string
[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)
}
}
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.
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.
Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.update_table(
DatabaseName='string',
TableName='string',
RetentionProperties={
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
}
)
string
[REQUIRED]
The name of the Timestream database.
string
[REQUIRED]
The name of the Timesream table.
dict
[REQUIRED]
The retention duration of the memory store and the magnetic store.
MemoryStoreRetentionPeriodInHours (integer) -- [REQUIRED]
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) -- [REQUIRED]
The duration for which data must be stored in the magnetic store.
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)
}
}
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.
Removes the association of tags from a Timestream resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
list
[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.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
List all tags on a Timestream resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The tags currently associated with the Timestream resource.
(dict) --
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.
Key (string) --
The key of the tag. Tag keys are case sensitive.
Value (string) --
The value of the tag. Tag values are case-sensitive and can be null.
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.
All tables in the database must be deleted first, or a ValidationException error will be thrown.
See also: AWS API Documentation
Request Syntax
client.delete_database(
DatabaseName='string'
)
string
[REQUIRED]
The name of the Timestream database to be deleted.
None
The CreateTable operation adds a new table to an existing database in your account. In an AWS 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 seperate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_table(
DatabaseName='string',
TableName='string',
RetentionProperties={
'MemoryStoreRetentionPeriodInHours': 123,
'MagneticStoreRetentionPeriodInDays': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the Timestream database.
string
[REQUIRED]
The name of the Timestream table.
dict
The duration for which your time series data must be stored in the memory store and the magnetic store.
MemoryStoreRetentionPeriodInHours (integer) -- [REQUIRED]
The duration for which data must be stored in the memory store.
MagneticStoreRetentionPeriodInDays (integer) -- [REQUIRED]
The duration for which data must be stored in the magnetic store.
list
A list of key-value pairs to label the table.
(dict) --
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.
Key (string) -- [REQUIRED]
The key of the tag. Tag keys are case sensitive.
Value (string) -- [REQUIRED]
The value of the tag. Tag values are case-sensitive and can be null.
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)
}
}
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.
A list of tables, along with the name, status and retention properties of each table.
See also: AWS API Documentation
Request Syntax
client.list_tables(
DatabaseName='string',
NextToken='string',
MaxResults=123
)
string
The name of the Timestream database.
string
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
integer
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.
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)
},
],
'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.
NextToken (string) --
A token to specify where to start paginating. This is the NextToken from a previously truncated response.