@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonTimestreamQueryAsyncClient extends AmazonTimestreamQueryClient implements AmazonTimestreamQueryAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, cancelQuery, createScheduledQuery, deleteScheduledQuery, describeEndpoints, describeScheduledQuery, executeScheduledQuery, getCachedResponseMetadata, listScheduledQueries, listTagsForResource, prepareQuery, query, tagResource, untagResource, updateScheduledQueryaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelQuery, createScheduledQuery, deleteScheduledQuery, describeEndpoints, describeScheduledQuery, executeScheduledQuery, getCachedResponseMetadata, listScheduledQueries, listTagsForResource, prepareQuery, query, tagResource, untagResource, updateScheduledQuerypublic static AmazonTimestreamQueryAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelQueryResult> cancelQueryAsync(CancelQueryRequest request)
AmazonTimestreamQueryAsync
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.
cancelQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<CancelQueryResult> cancelQueryAsync(CancelQueryRequest request, AsyncHandler<CancelQueryRequest,CancelQueryResult> asyncHandler)
AmazonTimestreamQueryAsync
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.
cancelQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateScheduledQueryResult> createScheduledQueryAsync(CreateScheduledQueryRequest request)
AmazonTimestreamQueryAsync
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.
createScheduledQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<CreateScheduledQueryResult> createScheduledQueryAsync(CreateScheduledQueryRequest request, AsyncHandler<CreateScheduledQueryRequest,CreateScheduledQueryResult> asyncHandler)
AmazonTimestreamQueryAsync
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.
createScheduledQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteScheduledQueryResult> deleteScheduledQueryAsync(DeleteScheduledQueryRequest request)
AmazonTimestreamQueryAsyncDeletes a given scheduled query. This is an irreversible operation.
deleteScheduledQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<DeleteScheduledQueryResult> deleteScheduledQueryAsync(DeleteScheduledQueryRequest request, AsyncHandler<DeleteScheduledQueryRequest,DeleteScheduledQueryResult> asyncHandler)
AmazonTimestreamQueryAsyncDeletes a given scheduled query. This is an irreversible operation.
deleteScheduledQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEndpointsResult> describeEndpointsAsync(DescribeEndpointsRequest request)
AmazonTimestreamQueryAsyncDescribeEndpoints 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.
describeEndpointsAsync in interface AmazonTimestreamQueryAsyncpublic Future<DescribeEndpointsResult> describeEndpointsAsync(DescribeEndpointsRequest request, AsyncHandler<DescribeEndpointsRequest,DescribeEndpointsResult> asyncHandler)
AmazonTimestreamQueryAsyncDescribeEndpoints 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.
describeEndpointsAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeScheduledQueryResult> describeScheduledQueryAsync(DescribeScheduledQueryRequest request)
AmazonTimestreamQueryAsyncProvides detailed information about a scheduled query.
describeScheduledQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<DescribeScheduledQueryResult> describeScheduledQueryAsync(DescribeScheduledQueryRequest request, AsyncHandler<DescribeScheduledQueryRequest,DescribeScheduledQueryResult> asyncHandler)
AmazonTimestreamQueryAsyncProvides detailed information about a scheduled query.
describeScheduledQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ExecuteScheduledQueryResult> executeScheduledQueryAsync(ExecuteScheduledQueryRequest request)
AmazonTimestreamQueryAsyncYou can use this API to run a scheduled query manually.
executeScheduledQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<ExecuteScheduledQueryResult> executeScheduledQueryAsync(ExecuteScheduledQueryRequest request, AsyncHandler<ExecuteScheduledQueryRequest,ExecuteScheduledQueryResult> asyncHandler)
AmazonTimestreamQueryAsyncYou can use this API to run a scheduled query manually.
executeScheduledQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListScheduledQueriesResult> listScheduledQueriesAsync(ListScheduledQueriesRequest request)
AmazonTimestreamQueryAsync
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
listScheduledQueriesAsync in interface AmazonTimestreamQueryAsyncpublic Future<ListScheduledQueriesResult> listScheduledQueriesAsync(ListScheduledQueriesRequest request, AsyncHandler<ListScheduledQueriesRequest,ListScheduledQueriesResult> asyncHandler)
AmazonTimestreamQueryAsync
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
listScheduledQueriesAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonTimestreamQueryAsyncList all tags on a Timestream query resource.
listTagsForResourceAsync in interface AmazonTimestreamQueryAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonTimestreamQueryAsyncList all tags on a Timestream query resource.
listTagsForResourceAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PrepareQueryResult> prepareQueryAsync(PrepareQueryRequest request)
AmazonTimestreamQueryAsync
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 the PrepareQueryRequest$ValidateOnly set
to true.
prepareQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<PrepareQueryResult> prepareQueryAsync(PrepareQueryRequest request, AsyncHandler<PrepareQueryRequest,PrepareQueryResult> asyncHandler)
AmazonTimestreamQueryAsync
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 the PrepareQueryRequest$ValidateOnly set
to true.
prepareQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<QueryResult> queryAsync(QueryRequest request)
AmazonTimestreamQueryAsync
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.
queryAsync in interface AmazonTimestreamQueryAsyncpublic Future<QueryResult> queryAsync(QueryRequest request, AsyncHandler<QueryRequest,QueryResult> asyncHandler)
AmazonTimestreamQueryAsync
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.
queryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonTimestreamQueryAsyncAssociate 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.
tagResourceAsync in interface AmazonTimestreamQueryAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonTimestreamQueryAsyncAssociate 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.
tagResourceAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonTimestreamQueryAsyncRemoves the association of tags from a Timestream query resource.
untagResourceAsync in interface AmazonTimestreamQueryAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonTimestreamQueryAsyncRemoves the association of tags from a Timestream query resource.
untagResourceAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateScheduledQueryResult> updateScheduledQueryAsync(UpdateScheduledQueryRequest request)
AmazonTimestreamQueryAsyncUpdate a scheduled query.
updateScheduledQueryAsync in interface AmazonTimestreamQueryAsyncpublic Future<UpdateScheduledQueryResult> updateScheduledQueryAsync(UpdateScheduledQueryRequest request, AsyncHandler<UpdateScheduledQueryRequest,UpdateScheduledQueryResult> asyncHandler)
AmazonTimestreamQueryAsyncUpdate a scheduled query.
updateScheduledQueryAsync in interface AmazonTimestreamQueryAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonTimestreamQueryshutdown in class AmazonTimestreamQueryClient