@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonTimestreamQueryAsync extends AmazonTimestreamQuery
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonTimestreamQueryAsync
instead.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CancelQueryResult> |
cancelQueryAsync(CancelQueryRequest cancelQueryRequest)
Cancels a query that has been issued.
|
Future<CancelQueryResult> |
cancelQueryAsync(CancelQueryRequest cancelQueryRequest,
AsyncHandler<CancelQueryRequest,CancelQueryResult> asyncHandler)
Cancels a query that has been issued.
|
Future<CreateScheduledQueryResult> |
createScheduledQueryAsync(CreateScheduledQueryRequest createScheduledQueryRequest)
Create a scheduled query that will be run on your behalf at the configured schedule.
|
Future<CreateScheduledQueryResult> |
createScheduledQueryAsync(CreateScheduledQueryRequest createScheduledQueryRequest,
AsyncHandler<CreateScheduledQueryRequest,CreateScheduledQueryResult> asyncHandler)
Create a scheduled query that will be run on your behalf at the configured schedule.
|
Future<DeleteScheduledQueryResult> |
deleteScheduledQueryAsync(DeleteScheduledQueryRequest deleteScheduledQueryRequest)
Deletes a given scheduled query.
|
Future<DeleteScheduledQueryResult> |
deleteScheduledQueryAsync(DeleteScheduledQueryRequest deleteScheduledQueryRequest,
AsyncHandler<DeleteScheduledQueryRequest,DeleteScheduledQueryResult> asyncHandler)
Deletes a given scheduled query.
|
Future<DescribeEndpointsResult> |
describeEndpointsAsync(DescribeEndpointsRequest describeEndpointsRequest)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
Future<DescribeEndpointsResult> |
describeEndpointsAsync(DescribeEndpointsRequest describeEndpointsRequest,
AsyncHandler<DescribeEndpointsRequest,DescribeEndpointsResult> asyncHandler)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
Future<DescribeScheduledQueryResult> |
describeScheduledQueryAsync(DescribeScheduledQueryRequest describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
|
Future<DescribeScheduledQueryResult> |
describeScheduledQueryAsync(DescribeScheduledQueryRequest describeScheduledQueryRequest,
AsyncHandler<DescribeScheduledQueryRequest,DescribeScheduledQueryResult> asyncHandler)
Provides detailed information about a scheduled query.
|
Future<ExecuteScheduledQueryResult> |
executeScheduledQueryAsync(ExecuteScheduledQueryRequest executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
|
Future<ExecuteScheduledQueryResult> |
executeScheduledQueryAsync(ExecuteScheduledQueryRequest executeScheduledQueryRequest,
AsyncHandler<ExecuteScheduledQueryRequest,ExecuteScheduledQueryResult> asyncHandler)
You can use this API to run a scheduled query manually.
|
Future<ListScheduledQueriesResult> |
listScheduledQueriesAsync(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
Future<ListScheduledQueriesResult> |
listScheduledQueriesAsync(ListScheduledQueriesRequest listScheduledQueriesRequest,
AsyncHandler<ListScheduledQueriesRequest,ListScheduledQueriesResult> asyncHandler)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all tags on a Timestream query resource.
|
Future<PrepareQueryResult> |
prepareQueryAsync(PrepareQueryRequest prepareQueryRequest)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running.
|
Future<PrepareQueryResult> |
prepareQueryAsync(PrepareQueryRequest prepareQueryRequest,
AsyncHandler<PrepareQueryRequest,PrepareQueryResult> asyncHandler)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running.
|
Future<QueryResult> |
queryAsync(QueryRequest queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
Future<QueryResult> |
queryAsync(QueryRequest queryRequest,
AsyncHandler<QueryRequest,QueryResult> asyncHandler)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Associate a set of tags with a Timestream resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associate a set of tags with a Timestream resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream query resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association of tags from a Timestream query resource.
|
Future<UpdateScheduledQueryResult> |
updateScheduledQueryAsync(UpdateScheduledQueryRequest updateScheduledQueryRequest)
Update a scheduled query.
|
Future<UpdateScheduledQueryResult> |
updateScheduledQueryAsync(UpdateScheduledQueryRequest updateScheduledQueryRequest,
AsyncHandler<UpdateScheduledQueryRequest,UpdateScheduledQueryResult> asyncHandler)
Update a scheduled query.
|
cancelQuery, createScheduledQuery, deleteScheduledQuery, describeEndpoints, describeScheduledQuery, executeScheduledQuery, getCachedResponseMetadata, listScheduledQueries, listTagsForResource, prepareQuery, query, shutdown, tagResource, untagResource, updateScheduledQuery
Future<CancelQueryResult> cancelQueryAsync(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.
cancelQueryRequest
- Future<CancelQueryResult> cancelQueryAsync(CancelQueryRequest cancelQueryRequest, AsyncHandler<CancelQueryRequest,CancelQueryResult> asyncHandler)
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.
cancelQueryRequest
- asyncHandler
- 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.Future<CreateScheduledQueryResult> createScheduledQueryAsync(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.
createScheduledQueryRequest
- Future<CreateScheduledQueryResult> createScheduledQueryAsync(CreateScheduledQueryRequest createScheduledQueryRequest, AsyncHandler<CreateScheduledQueryRequest,CreateScheduledQueryResult> asyncHandler)
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.
createScheduledQueryRequest
- asyncHandler
- 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.Future<DeleteScheduledQueryResult> deleteScheduledQueryAsync(DeleteScheduledQueryRequest deleteScheduledQueryRequest)
Deletes a given scheduled query. This is an irreversible operation.
deleteScheduledQueryRequest
- Future<DeleteScheduledQueryResult> deleteScheduledQueryAsync(DeleteScheduledQueryRequest deleteScheduledQueryRequest, AsyncHandler<DeleteScheduledQueryRequest,DeleteScheduledQueryResult> asyncHandler)
Deletes a given scheduled query. This is an irreversible operation.
deleteScheduledQueryRequest
- asyncHandler
- 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.Future<DescribeEndpointsResult> describeEndpointsAsync(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.
describeEndpointsRequest
- Future<DescribeEndpointsResult> describeEndpointsAsync(DescribeEndpointsRequest describeEndpointsRequest, AsyncHandler<DescribeEndpointsRequest,DescribeEndpointsResult> asyncHandler)
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.
describeEndpointsRequest
- asyncHandler
- 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.Future<DescribeScheduledQueryResult> describeScheduledQueryAsync(DescribeScheduledQueryRequest describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
describeScheduledQueryRequest
- Future<DescribeScheduledQueryResult> describeScheduledQueryAsync(DescribeScheduledQueryRequest describeScheduledQueryRequest, AsyncHandler<DescribeScheduledQueryRequest,DescribeScheduledQueryResult> asyncHandler)
Provides detailed information about a scheduled query.
describeScheduledQueryRequest
- asyncHandler
- 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.Future<ExecuteScheduledQueryResult> executeScheduledQueryAsync(ExecuteScheduledQueryRequest executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
executeScheduledQueryRequest
- Future<ExecuteScheduledQueryResult> executeScheduledQueryAsync(ExecuteScheduledQueryRequest executeScheduledQueryRequest, AsyncHandler<ExecuteScheduledQueryRequest,ExecuteScheduledQueryResult> asyncHandler)
You can use this API to run a scheduled query manually.
executeScheduledQueryRequest
- asyncHandler
- 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.Future<ListScheduledQueriesResult> listScheduledQueriesAsync(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
listScheduledQueriesRequest
- Future<ListScheduledQueriesResult> listScheduledQueriesAsync(ListScheduledQueriesRequest listScheduledQueriesRequest, AsyncHandler<ListScheduledQueriesRequest,ListScheduledQueriesResult> asyncHandler)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
listScheduledQueriesRequest
- asyncHandler
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all tags on a Timestream query resource.
listTagsForResourceRequest
- asyncHandler
- 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.Future<PrepareQueryResult> prepareQueryAsync(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 the PrepareQueryRequest$ValidateOnly
set
to true
.
prepareQueryRequest
- Future<PrepareQueryResult> prepareQueryAsync(PrepareQueryRequest prepareQueryRequest, AsyncHandler<PrepareQueryRequest,PrepareQueryResult> asyncHandler)
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
.
prepareQueryRequest
- asyncHandler
- 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.Future<QueryResult> queryAsync(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.
queryRequest
- Future<QueryResult> queryAsync(QueryRequest queryRequest, AsyncHandler<QueryRequest,QueryResult> asyncHandler)
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.
queryRequest
- asyncHandler
- 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.Future<TagResourceResult> tagResourceAsync(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.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest
- asyncHandler
- 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream query resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association of tags from a Timestream query resource.
untagResourceRequest
- asyncHandler
- 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.Future<UpdateScheduledQueryResult> updateScheduledQueryAsync(UpdateScheduledQueryRequest updateScheduledQueryRequest)
Update a scheduled query.
updateScheduledQueryRequest
- Future<UpdateScheduledQueryResult> updateScheduledQueryAsync(UpdateScheduledQueryRequest updateScheduledQueryRequest, AsyncHandler<UpdateScheduledQueryRequest,UpdateScheduledQueryResult> asyncHandler)
Update a scheduled query.
updateScheduledQueryRequest
- asyncHandler
- 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.