@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface TimestreamWriteAsyncClient extends AwsClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static TimestreamWriteAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
TimestreamWriteAsyncClient. |
static TimestreamWriteAsyncClient |
create()
Create a
TimestreamWriteAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateBatchLoadTaskResponse> |
createBatchLoadTask(Consumer<CreateBatchLoadTaskRequest.Builder> createBatchLoadTaskRequest)
Creates a new Timestream batch load task.
|
default CompletableFuture<CreateBatchLoadTaskResponse> |
createBatchLoadTask(CreateBatchLoadTaskRequest createBatchLoadTaskRequest)
Creates a new Timestream batch load task.
|
default CompletableFuture<CreateDatabaseResponse> |
createDatabase(Consumer<CreateDatabaseRequest.Builder> createDatabaseRequest)
Creates a new Timestream database.
|
default CompletableFuture<CreateDatabaseResponse> |
createDatabase(CreateDatabaseRequest createDatabaseRequest)
Creates a new Timestream database.
|
default CompletableFuture<CreateTableResponse> |
createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
Adds a new table to an existing database in your account.
|
default CompletableFuture<CreateTableResponse> |
createTable(CreateTableRequest createTableRequest)
Adds a new table to an existing database in your account.
|
default CompletableFuture<DeleteDatabaseResponse> |
deleteDatabase(Consumer<DeleteDatabaseRequest.Builder> deleteDatabaseRequest)
Deletes a given Timestream database.
|
default CompletableFuture<DeleteDatabaseResponse> |
deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest)
Deletes a given Timestream database.
|
default CompletableFuture<DeleteTableResponse> |
deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
Deletes a given Timestream table.
|
default CompletableFuture<DeleteTableResponse> |
deleteTable(DeleteTableRequest deleteTableRequest)
Deletes a given Timestream table.
|
default CompletableFuture<DescribeBatchLoadTaskResponse> |
describeBatchLoadTask(Consumer<DescribeBatchLoadTaskRequest.Builder> describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details.
|
default CompletableFuture<DescribeBatchLoadTaskResponse> |
describeBatchLoadTask(DescribeBatchLoadTaskRequest describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details.
|
default CompletableFuture<DescribeDatabaseResponse> |
describeDatabase(Consumer<DescribeDatabaseRequest.Builder> describeDatabaseRequest)
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.
|
default CompletableFuture<DescribeDatabaseResponse> |
describeDatabase(DescribeDatabaseRequest describeDatabaseRequest)
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.
|
default CompletableFuture<DescribeEndpointsResponse> |
describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
Returns a list of available endpoints to make Timestream API calls against.
|
default CompletableFuture<DescribeEndpointsResponse> |
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns a list of available endpoints to make Timestream API calls against.
|
default CompletableFuture<DescribeTableResponse> |
describeTable(Consumer<DescribeTableRequest.Builder> describeTableRequest)
Returns information about the table, including the table name, database name, retention duration of the memory
store and the magnetic store.
|
default CompletableFuture<DescribeTableResponse> |
describeTable(DescribeTableRequest describeTableRequest)
Returns information about the table, including the table name, database name, retention duration of the memory
store and the magnetic store.
|
default CompletableFuture<ListBatchLoadTasksResponse> |
listBatchLoadTasks(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other
details.
|
default CompletableFuture<ListBatchLoadTasksResponse> |
listBatchLoadTasks(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other
details.
|
default ListBatchLoadTasksPublisher |
listBatchLoadTasksPaginator(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other
details.
|
default ListBatchLoadTasksPublisher |
listBatchLoadTasksPaginator(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other
details.
|
default CompletableFuture<ListDatabasesResponse> |
listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Returns a list of your Timestream databases.
|
default CompletableFuture<ListDatabasesResponse> |
listDatabases(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases.
|
default ListDatabasesPublisher |
listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Returns a list of your Timestream databases.
|
default ListDatabasesPublisher |
listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases.
|
default CompletableFuture<ListTablesResponse> |
listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table.
|
default CompletableFuture<ListTablesResponse> |
listTables(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table.
|
default ListTablesPublisher |
listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table.
|
default ListTablesPublisher |
listTablesPaginator(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a Timestream resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Timestream resource.
|
default CompletableFuture<ResumeBatchLoadTaskResponse> |
resumeBatchLoadTask(Consumer<ResumeBatchLoadTaskRequest.Builder> resumeBatchLoadTaskRequest) |
default CompletableFuture<ResumeBatchLoadTaskResponse> |
resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest) |
default TimestreamWriteServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates a set of tags with a Timestream resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Timestream resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Timestream resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream resource.
|
default CompletableFuture<UpdateDatabaseResponse> |
updateDatabase(Consumer<UpdateDatabaseRequest.Builder> updateDatabaseRequest)
Modifies the KMS key for an existing database.
|
default CompletableFuture<UpdateDatabaseResponse> |
updateDatabase(UpdateDatabaseRequest updateDatabaseRequest)
Modifies the KMS key for an existing database.
|
default CompletableFuture<UpdateTableResponse> |
updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
|
default CompletableFuture<UpdateTableResponse> |
updateTable(UpdateTableRequest updateTableRequest)
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
|
default CompletableFuture<WriteRecordsResponse> |
writeRecords(Consumer<WriteRecordsRequest.Builder> writeRecordsRequest)
Enables you to write your time-series data into Timestream.
|
default CompletableFuture<WriteRecordsResponse> |
writeRecords(WriteRecordsRequest writeRecordsRequest)
Enables you to write your time-series data into Timestream.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateBatchLoadTaskResponse> createBatchLoadTask(CreateBatchLoadTaskRequest createBatchLoadTaskRequest)
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.
createBatchLoadTaskRequest - default CompletableFuture<CreateBatchLoadTaskResponse> createBatchLoadTask(Consumer<CreateBatchLoadTaskRequest.Builder> createBatchLoadTaskRequest)
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.
This is a convenience which creates an instance of the CreateBatchLoadTaskRequest.Builder avoiding the
need to create one manually via CreateBatchLoadTaskRequest.builder()
createBatchLoadTaskRequest - A Consumer that will call methods on CreateBatchLoadTaskRequest.Builder to create a
request.default CompletableFuture<CreateDatabaseResponse> createDatabase(CreateDatabaseRequest createDatabaseRequest)
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.
createDatabaseRequest - default CompletableFuture<CreateDatabaseResponse> createDatabase(Consumer<CreateDatabaseRequest.Builder> createDatabaseRequest)
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.
This is a convenience which creates an instance of the CreateDatabaseRequest.Builder avoiding the need to
create one manually via CreateDatabaseRequest.builder()
createDatabaseRequest - A Consumer that will call methods on CreateDatabaseRequest.Builder to create a request.default CompletableFuture<CreateTableResponse> createTable(CreateTableRequest createTableRequest)
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.
createTableRequest - default CompletableFuture<CreateTableResponse> createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
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.
This is a convenience which creates an instance of the CreateTableRequest.Builder avoiding the need to
create one manually via CreateTableRequest.builder()
createTableRequest - A Consumer that will call methods on CreateTableRequest.Builder to create a request.default CompletableFuture<DeleteDatabaseResponse> deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest)
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 code sample for details.
deleteDatabaseRequest - default CompletableFuture<DeleteDatabaseResponse> deleteDatabase(Consumer<DeleteDatabaseRequest.Builder> deleteDatabaseRequest)
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 code sample for details.
This is a convenience which creates an instance of the DeleteDatabaseRequest.Builder avoiding the need to
create one manually via DeleteDatabaseRequest.builder()
deleteDatabaseRequest - A Consumer that will call methods on DeleteDatabaseRequest.Builder to create a request.default CompletableFuture<DeleteTableResponse> deleteTable(DeleteTableRequest deleteTableRequest)
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 code sample for details.
deleteTableRequest - default CompletableFuture<DeleteTableResponse> deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
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 code sample for details.
This is a convenience which creates an instance of the DeleteTableRequest.Builder avoiding the need to
create one manually via DeleteTableRequest.builder()
deleteTableRequest - A Consumer that will call methods on DeleteTableRequest.Builder to create a request.default CompletableFuture<DescribeBatchLoadTaskResponse> describeBatchLoadTask(DescribeBatchLoadTaskRequest describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.
describeBatchLoadTaskRequest - default CompletableFuture<DescribeBatchLoadTaskResponse> describeBatchLoadTask(Consumer<DescribeBatchLoadTaskRequest.Builder> describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.
This is a convenience which creates an instance of the DescribeBatchLoadTaskRequest.Builder avoiding the
need to create one manually via DescribeBatchLoadTaskRequest.builder()
describeBatchLoadTaskRequest - A Consumer that will call methods on DescribeBatchLoadTaskRequest.Builder to create a
request.default CompletableFuture<DescribeDatabaseResponse> describeDatabase(DescribeDatabaseRequest describeDatabaseRequest)
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.
describeDatabaseRequest - default CompletableFuture<DescribeDatabaseResponse> describeDatabase(Consumer<DescribeDatabaseRequest.Builder> describeDatabaseRequest)
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.
This is a convenience which creates an instance of the DescribeDatabaseRequest.Builder avoiding the need
to create one manually via DescribeDatabaseRequest.builder()
describeDatabaseRequest - A Consumer that will call methods on DescribeDatabaseRequest.Builder to create a request.default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
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.
describeEndpointsRequest - default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
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.
This is a convenience which creates an instance of the DescribeEndpointsRequest.Builder avoiding the need
to create one manually via DescribeEndpointsRequest.builder()
describeEndpointsRequest - A Consumer that will call methods on DescribeEndpointsRequest.Builder to create a request.default CompletableFuture<DescribeTableResponse> describeTable(DescribeTableRequest describeTableRequest)
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.
describeTableRequest - default CompletableFuture<DescribeTableResponse> describeTable(Consumer<DescribeTableRequest.Builder> describeTableRequest)
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.
This is a convenience which creates an instance of the DescribeTableRequest.Builder avoiding the need to
create one manually via DescribeTableRequest.builder()
describeTableRequest - A Consumer that will call methods on DescribeTableRequest.Builder to create a request.default CompletableFuture<ListBatchLoadTasksResponse> listBatchLoadTasks(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
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.
listBatchLoadTasksRequest - default CompletableFuture<ListBatchLoadTasksResponse> listBatchLoadTasks(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest)
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.
This is a convenience which creates an instance of the ListBatchLoadTasksRequest.Builder avoiding the
need to create one manually via ListBatchLoadTasksRequest.builder()
listBatchLoadTasksRequest - A Consumer that will call methods on ListBatchLoadTasksRequest.Builder to create a
request.default ListBatchLoadTasksPublisher listBatchLoadTasksPaginator(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
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.
This is a variant of
listBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)
operation.
listBatchLoadTasksRequest - default ListBatchLoadTasksPublisher listBatchLoadTasksPaginator(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest)
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.
This is a variant of
listBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)
operation.
This is a convenience which creates an instance of the ListBatchLoadTasksRequest.Builder avoiding the
need to create one manually via ListBatchLoadTasksRequest.builder()
listBatchLoadTasksRequest - A Consumer that will call methods on ListBatchLoadTasksRequest.Builder to create a
request.default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
listDatabasesRequest - default CompletableFuture<ListDatabasesResponse> listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.default ListDatabasesPublisher listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
This is a variant of
listDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest) operation.
listDatabasesRequest - default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
This is a variant of
listDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest) operation.
This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.default CompletableFuture<ListTablesResponse> listTables(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
listTablesRequest - default CompletableFuture<ListTablesResponse> listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to
create one manually via ListTablesRequest.builder()
listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.default ListTablesPublisher listTablesPaginator(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
This is a variant of listTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListTablesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListTablesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest) operation.
listTablesRequest - default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
This is a variant of listTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamwrite.model.ListTablesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamwrite.model.ListTablesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest) operation.
This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to
create one manually via ListTablesRequest.builder()
listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Timestream resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a Timestream resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ResumeBatchLoadTaskResponse> resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest)
resumeBatchLoadTaskRequest - default CompletableFuture<ResumeBatchLoadTaskResponse> resumeBatchLoadTask(Consumer<ResumeBatchLoadTaskRequest.Builder> resumeBatchLoadTaskRequest)
This is a convenience which creates an instance of the ResumeBatchLoadTaskRequest.Builder avoiding the
need to create one manually via ResumeBatchLoadTaskRequest.builder()
resumeBatchLoadTaskRequest - A Consumer that will call methods on ResumeBatchLoadTaskRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Timestream resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateDatabaseResponse> updateDatabase(UpdateDatabaseRequest updateDatabaseRequest)
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.
updateDatabaseRequest - default CompletableFuture<UpdateDatabaseResponse> updateDatabase(Consumer<UpdateDatabaseRequest.Builder> updateDatabaseRequest)
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.
This is a convenience which creates an instance of the UpdateDatabaseRequest.Builder avoiding the need to
create one manually via UpdateDatabaseRequest.builder()
updateDatabaseRequest - A Consumer that will call methods on UpdateDatabaseRequest.Builder to create a request.default CompletableFuture<UpdateTableResponse> updateTable(UpdateTableRequest updateTableRequest)
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.
updateTableRequest - default CompletableFuture<UpdateTableResponse> updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
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.
This is a convenience which creates an instance of the UpdateTableRequest.Builder avoiding the need to
create one manually via UpdateTableRequest.builder()
updateTableRequest - A Consumer that will call methods on UpdateTableRequest.Builder to create a request.default CompletableFuture<WriteRecordsResponse> writeRecords(WriteRecordsRequest writeRecordsRequest)
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.
writeRecordsRequest - Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but:
Measure values are different
Version is not present in the request or the value of version in the new record is equal to or lower than the existing value
In this case, if Timestream rejects data, the ExistingVersion field in the
RejectedRecords response will indicate the current record’s version. To force an update, you
can resend the request with a version for the record set to a value greater than the
ExistingVersion.
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 Quotas in the Amazon Timestream Developer Guide.
default CompletableFuture<WriteRecordsResponse> writeRecords(Consumer<WriteRecordsRequest.Builder> writeRecordsRequest)
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.
This is a convenience which creates an instance of the WriteRecordsRequest.Builder avoiding the need to
create one manually via WriteRecordsRequest.builder()
writeRecordsRequest - A Consumer that will call methods on WriteRecordsRequest.Builder to create a request.Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but:
Measure values are different
Version is not present in the request or the value of version in the new record is equal to or lower than the existing value
In this case, if Timestream rejects data, the ExistingVersion field in the
RejectedRecords response will indicate the current record’s version. To force an update, you
can resend the request with a version for the record set to a value greater than the
ExistingVersion.
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 Quotas in the Amazon Timestream Developer Guide.
default TimestreamWriteServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic TimestreamWriteAsyncClient create()
TimestreamWriteAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TimestreamWriteAsyncClientBuilder builder()
TimestreamWriteAsyncClient.Copyright © 2023. All rights reserved.