@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonTimestreamWrite
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonTimestreamWrite instead.
Amazon Timestream is a fast, scalable, fully managed time-series database service that makes it easy to store and analyze trillions of time-series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications.
Timestream is built from the ground up to effectively ingest, process, and store time-series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateBatchLoadTaskResult |
createBatchLoadTask(CreateBatchLoadTaskRequest createBatchLoadTaskRequest)
Creates a new Timestream batch load task.
|
CreateDatabaseResult |
createDatabase(CreateDatabaseRequest createDatabaseRequest)
Creates a new Timestream database.
|
CreateTableResult |
createTable(CreateTableRequest createTableRequest)
Adds a new table to an existing database in your account.
|
DeleteDatabaseResult |
deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest)
Deletes a given Timestream database.
|
DeleteTableResult |
deleteTable(DeleteTableRequest deleteTableRequest)
Deletes a given Timestream table.
|
DescribeBatchLoadTaskResult |
describeBatchLoadTask(DescribeBatchLoadTaskRequest describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details.
|
DescribeDatabaseResult |
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.
|
DescribeEndpointsResult |
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns a list of available endpoints to make Timestream API calls against.
|
DescribeTableResult |
describeTable(DescribeTableRequest describeTableRequest)
Returns information about the table, including the table name, database name, retention duration of the memory
store and the magnetic store.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListBatchLoadTasksResult |
listBatchLoadTasks(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other
details.
|
ListDatabasesResult |
listDatabases(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases.
|
ListTablesResult |
listTables(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Timestream resource.
|
ResumeBatchLoadTaskResult |
resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Timestream resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream resource.
|
UpdateDatabaseResult |
updateDatabase(UpdateDatabaseRequest updateDatabaseRequest)
Modifies the KMS key for an existing database.
|
UpdateTableResult |
updateTable(UpdateTableRequest updateTableRequest)
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
|
WriteRecordsResult |
writeRecords(WriteRecordsRequest writeRecordsRequest)
Enables you to write your time-series data into Timestream.
|
static final String ENDPOINT_PREFIX
CreateBatchLoadTaskResult createBatchLoadTask(CreateBatchLoadTaskRequest createBatchLoadTaskRequest)
Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location
and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and
events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report
will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown.
For more information, see Amazon Web Services
managed keys. Service
quotas apply. For details, see code
sample.
createBatchLoadTaskRequest - 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.CreateDatabaseResult createDatabase(CreateDatabaseRequest createDatabaseRequest)
Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
createDatabaseRequest - 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.CreateTableResult createTable(CreateTableRequest createTableRequest)
Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.
createTableRequest - 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.DeleteDatabaseResult deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest)
Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.
All tables in the database must be deleted first, or a ValidationException error will be thrown.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample for details.
deleteDatabaseRequest - 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.DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest)
Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample for details.
deleteTableRequest - 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.DescribeBatchLoadTaskResult describeBatchLoadTask(DescribeBatchLoadTaskRequest describeBatchLoadTaskRequest)
Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.
describeBatchLoadTaskRequest - 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.DescribeDatabaseResult describeDatabase(DescribeDatabaseRequest describeDatabaseRequest)
Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.
describeDatabaseRequest - 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.DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don't recommend that you use this API operation unless:
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
describeEndpointsRequest - 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.DescribeTableResult describeTable(DescribeTableRequest describeTableRequest)
Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.
describeTableRequest - 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.ListBatchLoadTasksResult listBatchLoadTasks(ListBatchLoadTasksRequest listBatchLoadTasksRequest)
Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.
listBatchLoadTasksRequest - 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.ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest)
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
listDatabasesRequest - 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.ListTablesResult listTables(ListTablesRequest listTablesRequest)
Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
listTablesRequest - 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a Timestream resource.
listTagsForResourceRequest - 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.ResumeBatchLoadTaskResult resumeBatchLoadTask(ResumeBatchLoadTaskRequest resumeBatchLoadTaskRequest)
resumeBatchLoadTaskRequest - 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
tagResourceRequest - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream resource.
untagResourceRequest - 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.UpdateDatabaseResult updateDatabase(UpdateDatabaseRequest updateDatabaseRequest)
Modifies the KMS key for an existing database. While updating the database, you must specify the database name
and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent
UpdateDatabase requests, first writer wins.
See code sample for details.
updateDatabaseRequest - 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.UpdateTableResult updateTable(UpdateTableRequest updateTableRequest)
Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.
See code sample for details.
updateTableRequest - 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.WriteRecordsResult writeRecords(WriteRecordsRequest writeRecordsRequest)
Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database.
Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply.
See code sample for details.
Upserts
You can use the Version parameter in a WriteRecords request to update data points.
Timestream tracks a version number with each record. Version defaults to 1 when it's
not specified for the record in the request. Timestream updates an existing record’s measure value along with its
Version when it receives a write request with a higher Version number for that record.
When it receives an update request where the measure value is the same as that of the existing record, Timestream
still updates Version, if it is greater than the existing value of Version. You can
update a data point as many times as desired, as long as the value of Version continuously
increases.
For example, suppose you write a new record without indicating Version in the request. Timestream
stores this record, and set Version to 1. Now, suppose you try to update this record
with a WriteRecords request of the same record with a different measure value but, like before, do
not provide Version. In this case, Timestream will reject this update with a
RejectedRecordsException since the updated record’s version is not greater than the existing value
of Version.
However, if you were to resend the update request with Version set to 2, Timestream
would then succeed in updating the record’s value, and the Version would be set to 2.
Next, suppose you sent a WriteRecords request with this same record and an identical measure value,
but with Version set to 3. In this case, Timestream would only update
Version to 3. Any further updates would need to send a version number greater than
3, or the update requests would receive a RejectedRecordsException.
writeRecordsRequest - 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 ExistingVersion field in the
RejectedRecords response will indicate the current record’s version. To force an update, you
can resend the request with a version for the record set to a value greater than the
ExistingVersion.
Records with timestamps that lie outside the retention duration of the memory store.
Records with dimensions or measures that exceed the Timestream defined limits.
For more information, see Quotas in the Amazon Timestream Developer Guide.
InvalidEndpointException - The requested endpoint was not valid.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.