Class: Aws::TimestreamWrite::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TimestreamWrite::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-timestreamwrite/client.rb
Overview
An API client for TimestreamWrite. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::TimestreamWrite::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_batch_load_task(params = {}) ⇒ Types::CreateBatchLoadTaskResponse
Creates a new Timestream batch load task.
-
#create_database(params = {}) ⇒ Types::CreateDatabaseResponse
Creates a new Timestream database.
-
#create_table(params = {}) ⇒ Types::CreateTableResponse
Adds a new table to an existing database in your account.
-
#delete_database(params = {}) ⇒ Struct
Deletes a given Timestream database.
-
#delete_table(params = {}) ⇒ Struct
Deletes a given Timestream table.
-
#describe_batch_load_task(params = {}) ⇒ Types::DescribeBatchLoadTaskResponse
Returns information about the batch load task, including configurations, mappings, progress, and other details.
-
#describe_database(params = {}) ⇒ Types::DescribeDatabaseResponse
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.
-
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
Returns a list of available endpoints to make Timestream API calls against.
-
#describe_table(params = {}) ⇒ Types::DescribeTableResponse
Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store.
-
#list_batch_load_tasks(params = {}) ⇒ Types::ListBatchLoadTasksResponse
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details.
-
#list_databases(params = {}) ⇒ Types::ListDatabasesResponse
Returns a list of your Timestream databases.
-
#list_tables(params = {}) ⇒ Types::ListTablesResponse
Provides a list of tables, along with the name, status, and retention properties of each table.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on a Timestream resource.
-
#resume_batch_load_task(params = {}) ⇒ Struct
Returns an empty response.
-
#tag_resource(params = {}) ⇒ Struct
Associates a set of tags with a Timestream resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association of tags from a Timestream resource.
-
#update_database(params = {}) ⇒ Types::UpdateDatabaseResponse
Modifies the KMS key for an existing database.
-
#update_table(params = {}) ⇒ Types::UpdateTableResponse
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
-
#write_records(params = {}) ⇒ Types::WriteRecordsResponse
Enables you to write your time-series data into Timestream.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1610 1611 1612 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1610 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1613 1614 1615 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1613 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1588 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-timestreamwrite' context[:gem_version] = '1.25.0' Seahorse::Client::Request.new(handlers, context) end |
#create_batch_load_task(params = {}) ⇒ Types::CreateBatchLoadTaskResponse
Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when ‘SSE_S3` is the option. Otherwise an error is thrown. For more information, see [Amazon Web Services managed keys]. [Service quotas apply]. For details, see [code sample].
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk [2]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [3]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html
524 525 526 527 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 524 def create_batch_load_task(params = {}, = {}) req = build_request(:create_batch_load_task, params) req.send_request() end |
#create_database(params = {}) ⇒ Types::CreateDatabaseResponse
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. For more information, see [Amazon Web Services managed keys]. [Service quotas apply]. For details, see [code sample].
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk [2]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [3]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html
587 588 589 590 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 587 def create_database(params = {}, = {}) req = build_request(:create_database, params) req.send_request() end |
#create_table(params = {}) ⇒ Types::CreateTableResponse
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 might 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.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html
690 691 692 693 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 690 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#delete_database(params = {}) ⇒ Struct
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 markdown=“1”> 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.
</note>
See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html
729 730 731 732 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 729 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_table(params = {}) ⇒ Struct
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 markdown=“1”> Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
</note>
See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html
770 771 772 773 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 770 def delete_table(params = {}, = {}) req = build_request(:delete_table, params) req.send_request() end |
#describe_batch_load_task(params = {}) ⇒ Types::DescribeBatchLoadTaskResponse
Returns information about the batch load task, including configurations, mappings, progress, and other details. [Service quotas apply]. See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html
853 854 855 856 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 853 def describe_batch_load_task(params = {}, = {}) req = build_request(:describe_batch_load_task, params) req.send_request() end |
#describe_database(params = {}) ⇒ Types::DescribeDatabaseResponse
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.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html
894 895 896 897 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 894 def describe_database(params = {}, = {}) req = build_request(:describe_database, params) req.send_request() end |
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, *we don’t recommend that you use this API operation unless*:
-
You are using [VPC endpoints (Amazon Web Services PrivateLink) with Timestream]
-
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 and when to use and implement DescribeEndpoints, see [The Endpoint Discovery Pattern].
[1]: docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints [2]: docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery
938 939 940 941 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 938 def describe_endpoints(params = {}, = {}) req = build_request(:describe_endpoints, params) req.send_request() end |
#describe_table(params = {}) ⇒ Types::DescribeTableResponse
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.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html
993 994 995 996 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 993 def describe_table(params = {}, = {}) req = build_request(:describe_table, params) req.send_request() end |
#list_batch_load_tasks(params = {}) ⇒ Types::ListBatchLoadTasksResponse
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1050 1051 1052 1053 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1050 def list_batch_load_tasks(params = {}, = {}) req = build_request(:list_batch_load_tasks, params) req.send_request() end |
#list_databases(params = {}) ⇒ Types::ListDatabasesResponse
Returns a list of your Timestream databases. [Service quotas apply]. See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1102 1103 1104 1105 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1102 def list_databases(params = {}, = {}) req = build_request(:list_databases, params) req.send_request() end |
#list_tables(params = {}) ⇒ Types::ListTablesResponse
Provides a list of tables, along with the name, status, and retention properties of each table. See [code sample] for details.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1168 1169 1170 1171 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1168 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on a Timestream resource.
1199 1200 1201 1202 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1199 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#resume_batch_load_task(params = {}) ⇒ Struct
Returns an empty response.
1219 1220 1221 1222 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1219 def resume_batch_load_task(params = {}, = {}) req = build_request(:resume_batch_load_task, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates 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.
1253 1254 1255 1256 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1253 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association of tags from a Timestream resource.
1281 1282 1283 1284 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1281 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_database(params = {}) ⇒ Types::UpdateDatabaseResponse
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.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html
1341 1342 1343 1344 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1341 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_table(params = {}) ⇒ Types::UpdateTableResponse
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.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
1436 1437 1438 1439 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1436 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1603 1604 1605 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1603 def waiter_names [] end |
#write_records(params = {}) ⇒ Types::WriteRecordsResponse
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 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 supports 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 it’s not specified for the record in the request. Timestream updates an existing record’s measure value along with its ‘Version` when it receives a write request with a higher `Version` number for that record. When it receives 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 stores 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`.
[1]: docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html [2]: docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html
1579 1580 1581 1582 |
# File 'lib/aws-sdk-timestreamwrite/client.rb', line 1579 def write_records(params = {}, = {}) req = build_request(:write_records, params) req.send_request() end |