TimestreamWrite

Client

class 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.

client = session.create_client('timestream-write')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
True if the operation can be paginated, False otherwise.
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 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

response = client.create_database(
    DatabaseName='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the Timestream database.

  • KmsKeyId (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.
  • Tags (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.

Return type

dict

Returns

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

create_table(**kwargs)

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

response = client.create_table(
    DatabaseName='string',
    TableName='string',
    RetentionProperties={
        'MemoryStoreRetentionPeriodInHours': 123,
        'MagneticStoreRetentionPeriodInDays': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the Timestream database.

  • TableName (string) --

    [REQUIRED]

    The name of the Timestream table.

  • RetentionProperties (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.

  • Tags (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.

Return type

dict

Returns

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.

Exceptions

delete_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.

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 also: AWS API Documentation

Request Syntax

response = client.delete_database(
    DatabaseName='string'
)
Parameters
DatabaseName (string) --

[REQUIRED]

The name of the Timestream database to be deleted.

Returns
None

Exceptions

delete_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.

Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See also: AWS API Documentation

Request Syntax

response = client.delete_table(
    DatabaseName='string',
    TableName='string'
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

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

  • TableName (string) --

    [REQUIRED]

    The name of the Timestream table to be deleted.

Returns

None

Exceptions

describe_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. For more information, see Access Management in the Timestream Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_database(
    DatabaseName='string'
)
Parameters
DatabaseName (string) --

[REQUIRED]

The name of the Timestream database.

Return type
dict
Returns
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.

Exceptions

describe_endpoints()

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

response = client.describe_endpoints()
Return type
dict
Returns
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.

Exceptions

describe_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. For more information, see Access Management in the Timestream Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_table(
    DatabaseName='string',
    TableName='string'
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the Timestream database.

  • TableName (string) --

    [REQUIRED]

    The name of the Timestream table.

Return type

dict

Returns

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.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_databases(**kwargs)

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

response = client.list_databases(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
  • MaxResults (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.
Return type

dict

Returns

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

list_tables(**kwargs)

A list of tables, along with the name, status and retention properties of each table.

See also: AWS API Documentation

Request Syntax

response = client.list_tables(
    DatabaseName='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • DatabaseName (string) -- The name of the Timestream database.
  • NextToken (string) -- The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
  • MaxResults (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.
Return type

dict

Returns

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.

Exceptions

list_tags_for_resource(**kwargs)

List all tags on a Timestream resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters
ResourceARN (string) --

[REQUIRED]

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

Return type
dict
Returns
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.

Exceptions

tag_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'
        },
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

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

  • Tags (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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_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',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

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

  • TagKeys (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) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_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 also: AWS API Documentation

Request Syntax

response = client.update_database(
    DatabaseName='string',
    KmsKeyId='string'
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the database.

  • KmsKeyId (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
Return type

dict

Returns

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

update_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.

Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_table(
    DatabaseName='string',
    TableName='string',
    RetentionProperties={
        'MemoryStoreRetentionPeriodInHours': 123,
        'MagneticStoreRetentionPeriodInDays': 123
    }
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the Timestream database.

  • TableName (string) --

    [REQUIRED]

    The name of the Timesream table.

  • RetentionProperties (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.

Return type

dict

Returns

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.

Exceptions

write_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. For more information, see Access Management in the Timestream Developer Guide.

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',
        'Time': 'string',
        'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS',
        'Version': 123
    },
    Records=[
        {
            'Dimensions': [
                {
                    'Name': 'string',
                    'Value': 'string',
                    'DimensionValueType': 'VARCHAR'
                },
            ],
            'MeasureName': 'string',
            'MeasureValue': 'string',
            'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN',
            'Time': 'string',
            'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS',
            'Version': 123
        },
    ]
)
Parameters
  • DatabaseName (string) --

    [REQUIRED]

    The name of the Timestream database.

  • TableName (string) --

    [REQUIRED]

    The name of the Timesream table.

  • CommonAttributes (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.

          For constraints on Dimension names, see Naming Constraints .

        • 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. 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.

    • TimeUnit (string) --

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

    • Version (integer) --

      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 to 1.

  • Records (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.

            For constraints on Dimension names, see Naming Constraints .

          • 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. 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.

      • TimeUnit (string) --

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

      • Version (integer) --

        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 to 1.

Returns

None

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class TimestreamWrite.Client.exceptions.AccessDeniedException

You are not authorized to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You are not authorized to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.ConflictException

Timestream was unable to process this request because it contains resource that already exists.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Timestream was unable to process this request because it contains resource that already exists.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.InternalServerException

Timestream was unable to fully process this request because of an internal server error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Timestream was unable to fully process this request because of an internal server error.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.InvalidEndpointException

The requested endpoint was invalid.

Example

try:
  ...
except client.exceptions.InvalidEndpointException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested endpoint was invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.RejectedRecordsException

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 different measure values.
  • 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 Access Management in the Timestream Developer Guide.

Example

try:
  ...
except client.exceptions.RejectedRecordsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RejectedRecords': [
        {
            'RecordIndex': 123,
            'Reason': 'string',
            'ExistingVersion': 123
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    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 different measure values.
    • 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 Access Management in the Timestream Developer Guide.

    • Message (string) --

    • RejectedRecords (list) --

      • (dict) --

        Records that were not successfully inserted into Timestream due to data validation issues that must be resolved prior to reinserting time series data into the system.

        • RecordIndex (integer) --

          The index of the record in the input request for WriteRecords. Indexes begin with 0.

        • Reason (string) --

          The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:

          • Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but different measure values.
          • Records with timestamps that lie outside the retention duration of the memory store

          Note

          When the retention window is updated, you will receive a RejectedRecords exception if you immediately try to ingest data within the new window. To avoid a RejectedRecords exception, wait until the duration of the new window to ingest new data. For further information, see Best Practices for Configuring Timestream and the explanation of how storage works in Timestream .

          • Records with dimensions or measures that exceed the Timestream defined limits.

          For more information, see Access Management in the Timestream Developer Guide.

        • ExistingVersion (integer) --

          The existing version of the record. This value is populated in scenarios where an identical record exists with a higher version than the version in the write request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.ResourceNotFoundException

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.ServiceQuotaExceededException

Instance quota of resource exceeded for this account.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Instance quota of resource exceeded for this account.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.ThrottlingException

Too many requests were made by a user exceeding service quotas. The request was throttled.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Too many requests were made by a user exceeding service quotas. The request was throttled.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class TimestreamWrite.Client.exceptions.ValidationException

Invalid or malformed request.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Invalid or malformed request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: