com.amazonaws.services.timestreamquery

Interface AmazonTimestreamQuery

All Known Subinterfaces:

AmazonTimestreamQueryAsync

All Known Implementing Classes:

AbstractAmazonTimestreamQuery, AbstractAmazonTimestreamQueryAsync, AmazonTimestreamQueryAsyncClient, AmazonTimestreamQueryClient

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

Interface for accessing Timestream Query.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonTimestreamQuery instead.

Amazon Timestream Query

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
CancelQueryResult	cancelQuery(CancelQueryRequest cancelQueryRequest) Cancels a query that has been issued.
CreateScheduledQueryResult	createScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest) Create a scheduled query that will be run on your behalf at the configured schedule.
DeleteScheduledQueryResult	deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest) Deletes a given scheduled query.
DescribeAccountSettingsResult	describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest) Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
DescribeScheduledQueryResult	describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest) Provides detailed information about a scheduled query.
ExecuteScheduledQueryResult	executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest) You can use this API to run a scheduled query manually.
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.
ListScheduledQueriesResult	listScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags on a Timestream query resource.
PrepareQueryResult	prepareQuery(PrepareQueryRequest prepareQueryRequest) A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.
QueryResult	query(QueryRequest queryRequest) Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.
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 query resource.
UpdateAccountSettingsResult	updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured.
UpdateScheduledQueryResult	updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest) Update a scheduled query.

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

cancelQuery

CancelQueryResult cancelQuery(CancelQueryRequest cancelQueryRequest)

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

Parameters:

cancelQueryRequest -

Returns:

Result of the CancelQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

createScheduledQuery

CreateScheduledQueryResult createScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest)

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Parameters:

createScheduledQueryRequest -

Returns:

Result of the CreateScheduledQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

ConflictException - Unable to poll results for a cancelled query.

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

ServiceQuotaExceededException - You have exceeded the service quota.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

deleteScheduledQuery

DeleteScheduledQueryResult deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest)

Deletes a given scheduled query. This is an irreversible operation.

Parameters:

deleteScheduledQueryRequest -

Returns:

Result of the DeleteScheduledQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ResourceNotFoundException - The requested resource could not be found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

describeAccountSettings

DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

Parameters:

describeAccountSettingsRequest -

Returns:

Result of the DescribeAccountSettings operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ThrottlingException - The request was denied due to request throttling.

InvalidEndpointException - The requested endpoint was not valid.

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

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

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

ValidationException - Invalid or malformed request.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeScheduledQuery

DescribeScheduledQueryResult describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest)

Provides detailed information about a scheduled query.

Parameters:

describeScheduledQueryRequest -

Returns:

Result of the DescribeScheduledQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ResourceNotFoundException - The requested resource could not be found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

executeScheduledQuery

ExecuteScheduledQueryResult executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest)

You can use this API to run a scheduled query manually.

Parameters:

executeScheduledQueryRequest -

Returns:

Result of the ExecuteScheduledQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ResourceNotFoundException - The requested resource could not be found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

listScheduledQueries

ListScheduledQueriesResult listScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest)

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

Parameters:

listScheduledQueriesRequest -

Returns:

Result of the ListScheduledQueries operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List all tags on a Timestream query resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The requested resource could not be found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

prepareQuery

PrepareQueryResult prepareQuery(PrepareQueryRequest prepareQueryRequest)

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

Parameters:

prepareQueryRequest -

Returns:

Result of the PrepareQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

query

QueryResult query(QueryRequest queryRequest)

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data. Query will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details.

Your query request will fail in the following cases:

• If you submit a Query request with the same client token outside of the 5-minute idempotency window.

• If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window.

• If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:

  Query aborted as max page response size has been exceeded by the output result row

• If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

Parameters:

queryRequest -

Returns:

Result of the Query operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

ConflictException - Unable to poll results for a cancelled query.

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

QueryExecutionException - Timestream was unable to run the query successfully.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

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 requested resource could not be found.

ServiceQuotaExceededException - You have exceeded the service quota.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the association of tags from a Timestream query resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - Invalid or malformed request.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource could not be found.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

updateAccountSettings

UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

Parameters:

updateAccountSettingsRequest -

Returns:

Result of the UpdateAccountSettings operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

See Also:

AWS API Documentation

updateScheduledQuery

UpdateScheduledQueryResult updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest)

Update a scheduled query.

Parameters:

updateScheduledQueryRequest -

Returns:

Result of the UpdateScheduledQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

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

ResourceNotFoundException - The requested resource could not be found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - Invalid or malformed request.

InvalidEndpointException - The requested endpoint was not valid.

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.