com.amazonaws.services.timestreamwrite

Interface AmazonTimestreamWrite

All Known Subinterfaces:

AmazonTimestreamWriteAsync

All Known Implementing Classes:

AbstractAmazonTimestreamWrite, AbstractAmazonTimestreamWriteAsync, AmazonTimestreamWriteAsyncClient, AmazonTimestreamWriteClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTimestreamWrite

Interface for accessing Timestream Write.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateDatabaseResult	createDatabase(CreateDatabaseRequest createDatabaseRequest) Creates a new Timestream database.
CreateTableResult	createTable(CreateTableRequest createTableRequest) The CreateTable operation 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.
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) DescribeEndpoints 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.
ListDatabasesResult	listDatabases(ListDatabasesRequest listDatabasesRequest) Returns a list of your Timestream databases.
ListTablesResult	listTables(ListTablesRequest listTablesRequest) A list of tables, along with the name, status and retention properties of each table.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 tagResourceRequest) Associate 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) The WriteRecords operation enables you to write your time series data into Timestream.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDatabase

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. Refer to AWS managed KMS keys for more info. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

createDatabaseRequest -

Returns:

Result of the CreateDatabase operation returned by the service.

Throws:

ConflictException - Timestream was unable to process this request because it contains resource that already exists.

ValidationException - Invalid or malformed request.

AccessDeniedException - You are not authorized to perform this action.

ServiceQuotaExceededException - Instance quota of resource exceeded for this account.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

InvalidEndpointException - The requested endpoint was invalid.

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

See Also:

AWS API Documentation

createTable

CreateTableResult createTable(CreateTableRequest createTableRequest)

The CreateTable operation adds a new table to an existing database in your account. In an AWS 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 seperate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

createTableRequest -

Returns:

Result of the CreateTable operation returned by the service.

Throws:

ConflictException - Timestream was unable to process this request because it contains resource that already exists.

ValidationException - 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 - Instance quota of resource exceeded for this account.

ThrottlingException - Too many requests were made by a user exceeding 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 invalid.

See Also:

AWS API Documentation

deleteDatabase

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.

Parameters:

deleteDatabaseRequest -

Returns:

Result of the DeleteDatabase operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding 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 - Invalid or malformed request.

AccessDeniedException - You are not authorized to perform this action.

InvalidEndpointException - The requested endpoint was invalid.

See Also:

AWS API Documentation

deleteTable

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.

Parameters:

deleteTableRequest -

Returns:

Result of the DeleteTable operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - 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 invalid.

See Also:

AWS API Documentation

describeDatabase

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. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

describeDatabaseRequest -

Returns:

Result of the DescribeDatabase operation returned by the service.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ValidationException - Invalid or malformed request.

AccessDeniedException - You are not authorized to perform this action.

ThrottlingException - Too many requests were made by a user exceeding 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 invalid.

See Also:

AWS API Documentation

describeEndpoints

DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s 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:

• 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 to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ValidationException - Invalid or malformed request.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

See Also:

AWS API Documentation

describeTable

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. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

describeTableRequest -

Returns:

Result of the DescribeTable operation returned by the service.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ValidationException - Invalid or malformed request.

AccessDeniedException - You are not authorized to perform this action.

ThrottlingException - Too many requests were made by a user exceeding 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 invalid.

See Also:

AWS API Documentation

listDatabases

ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest)

Returns a list of your Timestream databases. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

listDatabasesRequest -

Returns:

Result of the ListDatabases operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - Invalid or malformed request.

AccessDeniedException - You are not authorized to perform this action.

InvalidEndpointException - The requested endpoint was invalid.

See Also:

AWS API Documentation

listTables

ListTablesResult listTables(ListTablesRequest listTablesRequest)

A list of tables, along with the name, status and retention properties of each table.

Parameters:

listTablesRequest -

Returns:

Result of the ListTables operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - 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 invalid.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List all tags on a Timestream resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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 exceeding service quotas. The request was throttled.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was invalid.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException - Instance quota of resource exceeded for this account.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was invalid.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the association of tags from a Timestream resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - Invalid or malformed request.

ServiceQuotaExceededException - Instance quota of resource exceeded for this account.

ThrottlingException - Too many requests were made by a user exceeding 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 invalid.

See Also:

AWS API Documentation

updateDatabase

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.

Parameters:

updateDatabaseRequest -

Returns:

Result of the UpdateDatabase operation returned by the service.

Throws:

ValidationException - 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 - Instance quota of resource exceeded for this account.

ThrottlingException - Too many requests were made by a user exceeding 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 invalid.

See Also:

AWS API Documentation

updateTable

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.

Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

updateTableRequest -

Returns:

Result of the UpdateTable operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - 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 invalid.

See Also:

AWS API Documentation

writeRecords

WriteRecordsResult writeRecords(WriteRecordsRequest writeRecordsRequest)

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. For more information, see Access Management in the Timestream Developer Guide.

Parameters:

writeRecordsRequest -

Returns:

Result of the WriteRecords operation returned by the service.

Throws:

InternalServerException - Timestream was unable to fully process this request because of an internal server error.

ThrottlingException - Too many requests were made by a user exceeding service quotas. The request was throttled.

ValidationException - 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 different measure values.

• 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 Access Management in the Timestream Developer Guide.

InvalidEndpointException - The requested endpoint was invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.