Interface TimestreamWriteAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aTimestreamWriteAsyncClient.static TimestreamWriteAsyncClientcreate()Create aTimestreamWriteAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createBatchLoadTask(Consumer<CreateBatchLoadTaskRequest.Builder> createBatchLoadTaskRequest) Creates a new Timestream batch load task.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.describeBatchLoadTask(Consumer<DescribeBatchLoadTaskRequest.Builder> describeBatchLoadTaskRequest) Returns information about the batch load task, including configurations, mappings, progress, and other details.describeBatchLoadTask(DescribeBatchLoadTaskRequest describeBatchLoadTaskRequest) Returns information about the batch load task, including configurations, mappings, progress, and other details.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.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.describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest) Returns a list of available endpoints to make Timestream API calls against.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.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.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 ListBatchLoadTasksPublisherlistBatchLoadTasksPaginator(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest) This is a variant oflistBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)operation.default ListBatchLoadTasksPublisherlistBatchLoadTasksPaginator(ListBatchLoadTasksRequest listBatchLoadTasksRequest) This is a variant oflistBatchLoadTasks(software.amazon.awssdk.services.timestreamwrite.model.ListBatchLoadTasksRequest)operation.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 ListDatabasesPublisherlistDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest)operation.default ListDatabasesPublisherlistDatabasesPaginator(ListDatabasesRequest listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.timestreamwrite.model.ListDatabasesRequest)operation.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 ListTablesPublisherlistTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest)operation.default ListTablesPublisherlistTablesPaginator(ListTablesRequest listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.timestreamwrite.model.ListTablesRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on a Timestream resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a Timestream resource.resumeBatchLoadTask(Consumer<ResumeBatchLoadTaskRequest.Builder> resumeBatchLoadTaskRequest) resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest) The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createBatchLoadTask
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_S3is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.- Parameters:
createBatchLoadTaskRequest-- Returns:
- A Java Future containing the result of the CreateBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ValidationException An invalid or malformed request.
- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBatchLoadTask
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_S3is 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.Builderavoiding the need to create one manually viaCreateBatchLoadTaskRequest.builder()- Parameters:
createBatchLoadTaskRequest- AConsumerthat will call methods onCreateBatchLoadTaskRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ValidationException An invalid or malformed request.
- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatabase
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.
- Parameters:
createDatabaseRequest-- Returns:
- A Java Future containing the result of the CreateDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InvalidEndpointException The requested endpoint was not valid.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatabase
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.Builderavoiding the need to create one manually viaCreateDatabaseRequest.builder()- Parameters:
createDatabaseRequest- AConsumerthat will call methods onCreateDatabaseRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InvalidEndpointException The requested endpoint was not valid.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTable
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.
- Parameters:
createTableRequest-- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InvalidEndpointException The requested endpoint was not valid.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTable
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.Builderavoiding the need to create one manually viaCreateTableRequest.builder()- Parameters:
createTableRequest- AConsumerthat will call methods onCreateTableRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Timestream was unable to process this request because it contains resource that already exists.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InvalidEndpointException The requested endpoint was not valid.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatabase
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.
- Parameters:
deleteDatabaseRequest-- Returns:
- A Java Future containing the result of the DeleteDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatabase
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.Builderavoiding the need to create one manually viaDeleteDatabaseRequest.builder()- Parameters:
deleteDatabaseRequest- AConsumerthat will call methods onDeleteDatabaseRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTable
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.
- Parameters:
deleteTableRequest-- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTable
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.Builderavoiding the need to create one manually viaDeleteTableRequest.builder()- Parameters:
deleteTableRequest- AConsumerthat will call methods onDeleteTableRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBatchLoadTask
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.
- Parameters:
describeBatchLoadTaskRequest-- Returns:
- A Java Future containing the result of the DescribeBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBatchLoadTask
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.Builderavoiding the need to create one manually viaDescribeBatchLoadTaskRequest.builder()- Parameters:
describeBatchLoadTaskRequest- AConsumerthat will call methods onDescribeBatchLoadTaskRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDatabase
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.
- Parameters:
describeDatabaseRequest-- Returns:
- A Java Future containing the result of the DescribeDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDatabase
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.Builderavoiding the need to create one manually viaDescribeDatabaseRequest.builder()- Parameters:
describeDatabaseRequest- AConsumerthat will call methods onDescribeDatabaseRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEndpoints
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.
- Parameters:
describeEndpointsRequest-- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ValidationException An invalid or malformed request.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeEndpoints
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.Builderavoiding the need to create one manually viaDescribeEndpointsRequest.builder()- Parameters:
describeEndpointsRequest- AConsumerthat will call methods onDescribeEndpointsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ValidationException An invalid or malformed request.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeTable
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.
- Parameters:
describeTableRequest-- Returns:
- A Java Future containing the result of the DescribeTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTable
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.Builderavoiding the need to create one manually viaDescribeTableRequest.builder()- Parameters:
describeTableRequest- AConsumerthat will call methods onDescribeTableRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchLoadTasks
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.
- Parameters:
listBatchLoadTasksRequest-- Returns:
- A Java Future containing the result of the ListBatchLoadTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchLoadTasks
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.Builderavoiding the need to create one manually viaListBatchLoadTasksRequest.builder()- Parameters:
listBatchLoadTasksRequest- AConsumerthat will call methods onListBatchLoadTasksRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListBatchLoadTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchLoadTasksPaginator
default ListBatchLoadTasksPublisher listBatchLoadTasksPaginator(ListBatchLoadTasksRequest listBatchLoadTasksRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listBatchLoadTasksRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBatchLoadTasksPaginator
default ListBatchLoadTasksPublisher listBatchLoadTasksPaginator(Consumer<ListBatchLoadTasksRequest.Builder> listBatchLoadTasksRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListBatchLoadTasksPublisher publisher = client.listBatchLoadTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListBatchLoadTasksRequest.builder()- Parameters:
listBatchLoadTasksRequest- AConsumerthat will call methods onListBatchLoadTasksRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- AccessDeniedException You are not authorized to perform this action.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest) Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
- Parameters:
listDatabasesRequest-- Returns:
- A Java Future containing the result of the ListDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
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.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listDatabasesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTables
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
- Parameters:
listTablesRequest-- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTables
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.Builderavoiding the need to create one manually viaListTablesRequest.builder()- Parameters:
listTablesRequest- AConsumerthat will call methods onListTablesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTablesPaginator
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listTablesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTablesPaginator
default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreamwrite.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListTablesRequest.builder()- Parameters:
listTablesRequest- AConsumerthat will call methods onListTablesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a Timestream resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeBatchLoadTask
default CompletableFuture<ResumeBatchLoadTaskResponse> resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest) - Parameters:
resumeBatchLoadTaskRequest-- Returns:
- A Java Future containing the result of the ResumeBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeBatchLoadTask
default CompletableFuture<ResumeBatchLoadTaskResponse> resumeBatchLoadTask(Consumer<ResumeBatchLoadTaskRequest.Builder> resumeBatchLoadTaskRequest)
This is a convenience which creates an instance of the
ResumeBatchLoadTaskRequest.Builderavoiding the need to create one manually viaResumeBatchLoadTaskRequest.builder()- Parameters:
resumeBatchLoadTaskRequest- AConsumerthat will call methods onResumeBatchLoadTaskRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ResumeBatchLoadTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- AccessDeniedException You are not authorized to perform this action.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Timestream resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An invalid or malformed request.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An invalid or malformed request.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDatabase
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 concurrentUpdateDatabaserequests, first writer wins.See code sample for details.
- Parameters:
updateDatabaseRequest-- Returns:
- A Java Future containing the result of the UpdateDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDatabase
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 concurrentUpdateDatabaserequests, first writer wins.See code sample for details.
This is a convenience which creates an instance of the
UpdateDatabaseRequest.Builderavoiding the need to create one manually viaUpdateDatabaseRequest.builder()- Parameters:
updateDatabaseRequest- AConsumerthat will call methods onUpdateDatabaseRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An invalid or malformed request.
- AccessDeniedException You are not authorized to perform this action.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ServiceQuotaExceededException The instance quota of resource exceeded for this account.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTable
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.
- Parameters:
updateTableRequest-- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTable
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.Builderavoiding the need to create one manually viaUpdateTableRequest.builder()- Parameters:
updateTableRequest- AConsumerthat will call methods onUpdateTableRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
writeRecords
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
Versionparameter in aWriteRecordsrequest to update data points. Timestream tracks a version number with each record.Versiondefaults to1when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with itsVersionwhen it receives a write request with a higherVersionnumber for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updatesVersion, if it is greater than the existing value ofVersion. You can update a data point as many times as desired, as long as the value ofVersioncontinuously increases.For example, suppose you write a new record without indicating
Versionin the request. Timestream stores this record, and setVersionto1. Now, suppose you try to update this record with aWriteRecordsrequest of the same record with a different measure value but, like before, do not provideVersion. In this case, Timestream will reject this update with aRejectedRecordsExceptionsince the updated record’s version is not greater than the existing value of Version.However, if you were to resend the update request with
Versionset to2, Timestream would then succeed in updating the record’s value, and theVersionwould be set to2. Next, suppose you sent aWriteRecordsrequest with this same record and an identical measure value, but withVersionset to3. In this case, Timestream would only updateVersionto3. Any further updates would need to send a version number greater than3, or the update requests would receive aRejectedRecordsException.- Parameters:
writeRecordsRequest-- Returns:
- A Java Future containing the result of the WriteRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- 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:
-
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
ExistingVersionfield in theRejectedRecordsresponse 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 theExistingVersion. -
-
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.
-
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
writeRecords
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
Versionparameter in aWriteRecordsrequest to update data points. Timestream tracks a version number with each record.Versiondefaults to1when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with itsVersionwhen it receives a write request with a higherVersionnumber for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updatesVersion, if it is greater than the existing value ofVersion. You can update a data point as many times as desired, as long as the value ofVersioncontinuously increases.For example, suppose you write a new record without indicating
Versionin the request. Timestream stores this record, and setVersionto1. Now, suppose you try to update this record with aWriteRecordsrequest of the same record with a different measure value but, like before, do not provideVersion. In this case, Timestream will reject this update with aRejectedRecordsExceptionsince the updated record’s version is not greater than the existing value of Version.However, if you were to resend the update request with
Versionset to2, Timestream would then succeed in updating the record’s value, and theVersionwould be set to2. Next, suppose you sent aWriteRecordsrequest with this same record and an identical measure value, but withVersionset to3. In this case, Timestream would only updateVersionto3. Any further updates would need to send a version number greater than3, or the update requests would receive aRejectedRecordsException.
This is a convenience which creates an instance of the
WriteRecordsRequest.Builderavoiding the need to create one manually viaWriteRecordsRequest.builder()- Parameters:
writeRecordsRequest- AConsumerthat will call methods onWriteRecordsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the WriteRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Timestream was unable to fully process this request because of an internal server error.
- ThrottlingException Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
- ValidationException An invalid or malformed request.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- AccessDeniedException You are not authorized to perform this action.
- 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:
-
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
ExistingVersionfield in theRejectedRecordsresponse 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 theExistingVersion. -
-
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.
-
- InvalidEndpointException The requested endpoint was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamWriteException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aTimestreamWriteAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aTimestreamWriteAsyncClient.
-