Class: Aws::TimestreamWrite::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TimestreamWrite::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-timestreamwrite/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
375 376 377 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#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 batch load task 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.
504 505 506 507 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 504 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.
567 568 569 570 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 567 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.
654 655 656 657 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 654 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.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample for details.
693 694 695 696 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 693 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.
See code sample for details.
734 735 736 737 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 734 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.
817 818 819 820 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 817 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.
858 859 860 861 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 858 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.
902 903 904 905 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 902 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.
953 954 955 956 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 953 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1010 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1062 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1124 1125 1126 1127 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1124 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.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1155 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#resume_batch_load_task(params = {}) ⇒ Struct
Returns an empty response.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1175 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.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1209 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.
1237 1238 1239 1240 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1237 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.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1297 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.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1376 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() 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
.
1519 1520 1521 1522 |
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/client.rb', line 1519 def write_records(params = {}, = {}) req = build_request(:write_records, params) req.send_request() end |