@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonTimestreamWrite extends Object implements AmazonTimestreamWrite
AmazonTimestreamWrite
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonTimestreamWrite() |
Modifier and Type | Method and Description |
---|---|
CreateDatabaseResult |
createDatabase(CreateDatabaseRequest request)
Creates a new Timestream database.
|
CreateTableResult |
createTable(CreateTableRequest request)
The CreateTable operation adds a new table to an existing database in your account.
|
DeleteDatabaseResult |
deleteDatabase(DeleteDatabaseRequest request)
Deletes a given Timestream database.
|
DeleteTableResult |
deleteTable(DeleteTableRequest request)
Deletes a given Timestream table.
|
DescribeDatabaseResult |
describeDatabase(DescribeDatabaseRequest request)
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 request)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
DescribeTableResult |
describeTable(DescribeTableRequest request)
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.
|
ListDatabasesResult |
listDatabases(ListDatabasesRequest request)
Returns a list of your Timestream databases.
|
ListTablesResult |
listTables(ListTablesRequest request)
A list of tables, along with the name, status and retention properties of each table.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List all tags on a Timestream resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associate a set of tags with a Timestream resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the association of tags from a Timestream resource.
|
UpdateDatabaseResult |
updateDatabase(UpdateDatabaseRequest request)
Modifies the KMS key for an existing database.
|
UpdateTableResult |
updateTable(UpdateTableRequest request)
Modifies the retention duration of the memory store and magnetic store for your Timestream table.
|
WriteRecordsResult |
writeRecords(WriteRecordsRequest request)
The WriteRecords operation enables you to write your time series data into Timestream.
|
public CreateDatabaseResult createDatabase(CreateDatabaseRequest request)
AmazonTimestreamWrite
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. Refer to Amazon Web Services managed KMS keys for more info. Service quotas apply. See code sample for details.
createDatabase
in interface AmazonTimestreamWrite
public CreateTableResult createTable(CreateTableRequest request)
AmazonTimestreamWrite
The CreateTable operation 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 may 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.
createTable
in interface AmazonTimestreamWrite
public DeleteDatabaseResult deleteDatabase(DeleteDatabaseRequest request)
AmazonTimestreamWrite
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.
deleteDatabase
in interface AmazonTimestreamWrite
public DeleteTableResult deleteTable(DeleteTableRequest request)
AmazonTimestreamWrite
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.
deleteTable
in interface AmazonTimestreamWrite
public DescribeDatabaseResult describeDatabase(DescribeDatabaseRequest request)
AmazonTimestreamWrite
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.
describeDatabase
in interface AmazonTimestreamWrite
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
AmazonTimestreamWrite
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API 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.
describeEndpoints
in interface AmazonTimestreamWrite
public DescribeTableResult describeTable(DescribeTableRequest request)
AmazonTimestreamWrite
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.
describeTable
in interface AmazonTimestreamWrite
public ListDatabasesResult listDatabases(ListDatabasesRequest request)
AmazonTimestreamWrite
Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
listDatabases
in interface AmazonTimestreamWrite
public ListTablesResult listTables(ListTablesRequest request)
AmazonTimestreamWrite
A list of tables, along with the name, status and retention properties of each table. See code sample for details.
listTables
in interface AmazonTimestreamWrite
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonTimestreamWrite
List all tags on a Timestream resource.
listTagsForResource
in interface AmazonTimestreamWrite
public TagResourceResult tagResource(TagResourceRequest request)
AmazonTimestreamWrite
Associate 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.
tagResource
in interface AmazonTimestreamWrite
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonTimestreamWrite
Removes the association of tags from a Timestream resource.
untagResource
in interface AmazonTimestreamWrite
public UpdateDatabaseResult updateDatabase(UpdateDatabaseRequest request)
AmazonTimestreamWrite
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.
updateDatabase
in interface AmazonTimestreamWrite
public UpdateTableResult updateTable(UpdateTableRequest request)
AmazonTimestreamWrite
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.
updateTable
in interface AmazonTimestreamWrite
public WriteRecordsResult writeRecords(WriteRecordsRequest request)
AmazonTimestreamWrite
The WriteRecords operation 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 with 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 support 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 not
specified for the record in the request. Timestream will update an existing record’s measure value along with its
Version
upon receiving a write request with a higher Version
number for that record.
Upon receiving 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
will store 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
.
writeRecords
in interface AmazonTimestreamWrite
public void shutdown()
AmazonTimestreamWrite
shutdown
in interface AmazonTimestreamWrite
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonTimestreamWrite
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.
getCachedResponseMetadata
in interface AmazonTimestreamWrite
request
- The originally executed request.Copyright © 2022. All rights reserved.