Interface TimestreamQueryAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aTimestreamQueryAsyncClient
.default CompletableFuture
<CancelQueryResponse> cancelQuery
(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a query that has been issued.default CompletableFuture
<CancelQueryResponse> cancelQuery
(CancelQueryRequest cancelQueryRequest) Cancels a query that has been issued.static TimestreamQueryAsyncClient
create()
Create aTimestreamQueryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createScheduledQuery
(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest) Create a scheduled query that will be run on your behalf at the configured schedule.createScheduledQuery
(CreateScheduledQueryRequest createScheduledQueryRequest) Create a scheduled query that will be run on your behalf at the configured schedule.deleteScheduledQuery
(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest) Deletes a given scheduled query.deleteScheduledQuery
(DeleteScheduledQueryRequest deleteScheduledQueryRequest) Deletes a given scheduled query.describeEndpoints
(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.describeEndpoints
(DescribeEndpointsRequest describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.describeScheduledQuery
(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest) Provides detailed information about a scheduled query.describeScheduledQuery
(DescribeScheduledQueryRequest describeScheduledQueryRequest) Provides detailed information about a scheduled query.executeScheduledQuery
(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest) You can use this API to run a scheduled query manually.executeScheduledQuery
(ExecuteScheduledQueryRequest executeScheduledQueryRequest) You can use this API to run a scheduled query manually.listScheduledQueries
(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.listScheduledQueries
(ListScheduledQueriesRequest listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.default ListScheduledQueriesPublisher
listScheduledQueriesPaginator
(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.default ListScheduledQueriesPublisher
listScheduledQueriesPaginator
(ListScheduledQueriesRequest listScheduledQueriesRequest) This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags on a Timestream query resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags on a Timestream query resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.default CompletableFuture
<PrepareQueryResponse> prepareQuery
(Consumer<PrepareQueryRequest.Builder> prepareQueryRequest) A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.default CompletableFuture
<PrepareQueryResponse> prepareQuery
(PrepareQueryRequest prepareQueryRequest) A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.default CompletableFuture
<QueryResponse> query
(Consumer<QueryRequest.Builder> queryRequest) Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.default CompletableFuture
<QueryResponse> query
(QueryRequest queryRequest) Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.default QueryPublisher
queryPaginator
(Consumer<QueryRequest.Builder> queryRequest) This is a variant ofquery(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation.default QueryPublisher
queryPaginator
(QueryRequest queryRequest) This is a variant ofquery(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate a set of tags with a Timestream resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associate a set of tags with a Timestream resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a Timestream query resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Timestream query resource.updateScheduledQuery
(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest) Update a scheduled query.updateScheduledQuery
(UpdateScheduledQueryRequest updateScheduledQueryRequest) Update a scheduled query.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelQuery
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:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelQuery
default CompletableFuture<CancelQueryResponse> cancelQuery(Consumer<CancelQueryRequest.Builder> 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.
This is a convenience which creates an instance of the
CancelQueryRequest.Builder
avoiding the need to create one manually viaCancelQueryRequest.builder()
- Parameters:
cancelQueryRequest
- AConsumer
that will call methods onCancelQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScheduledQuery
default CompletableFuture<CreateScheduledQueryResponse> 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 theNotificationConfiguration
parameter to configure notification for your scheduled query operations.- Parameters:
createScheduledQueryRequest
-- Returns:
- A Java Future containing the result of the CreateScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScheduledQuery
default CompletableFuture<CreateScheduledQueryResponse> createScheduledQuery(Consumer<CreateScheduledQueryRequest.Builder> 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 theNotificationConfiguration
parameter to configure notification for your scheduled query operations.
This is a convenience which creates an instance of the
CreateScheduledQueryRequest.Builder
avoiding the need to create one manually viaCreateScheduledQueryRequest.builder()
- Parameters:
createScheduledQueryRequest
- AConsumer
that will call methods onCreateScheduledQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScheduledQuery
default CompletableFuture<DeleteScheduledQueryResponse> deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest) Deletes a given scheduled query. This is an irreversible operation.
- Parameters:
deleteScheduledQueryRequest
-- Returns:
- A Java Future containing the result of the DeleteScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScheduledQuery
default CompletableFuture<DeleteScheduledQueryResponse> deleteScheduledQuery(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest) Deletes a given scheduled query. This is an irreversible operation.
This is a convenience which creates an instance of the
DeleteScheduledQueryRequest.Builder
avoiding the need to create one manually viaDeleteScheduledQueryRequest.builder()
- Parameters:
deleteScheduledQueryRequest
- AConsumer
that will call methods onDeleteScheduledQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEndpoints
default CompletableFuture<DescribeEndpointsResponse> 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:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeEndpoints
default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeEndpointsRequest.builder()
- Parameters:
describeEndpointsRequest
- AConsumer
that will call methods onDescribeEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeScheduledQuery
default CompletableFuture<DescribeScheduledQueryResponse> describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest) Provides detailed information about a scheduled query.
- Parameters:
describeScheduledQueryRequest
-- Returns:
- A Java Future containing the result of the DescribeScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScheduledQuery
default CompletableFuture<DescribeScheduledQueryResponse> describeScheduledQuery(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest) Provides detailed information about a scheduled query.
This is a convenience which creates an instance of the
DescribeScheduledQueryRequest.Builder
avoiding the need to create one manually viaDescribeScheduledQueryRequest.builder()
- Parameters:
describeScheduledQueryRequest
- AConsumer
that will call methods onDescribeScheduledQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
executeScheduledQuery
default CompletableFuture<ExecuteScheduledQueryResponse> executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest) You can use this API to run a scheduled query manually.
- Parameters:
executeScheduledQueryRequest
-- Returns:
- A Java Future containing the result of the ExecuteScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
executeScheduledQuery
default CompletableFuture<ExecuteScheduledQueryResponse> executeScheduledQuery(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest) You can use this API to run a scheduled query manually.
This is a convenience which creates an instance of the
ExecuteScheduledQueryRequest.Builder
avoiding the need to create one manually viaExecuteScheduledQueryRequest.builder()
- Parameters:
executeScheduledQueryRequest
- AConsumer
that will call methods onExecuteScheduledQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExecuteScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScheduledQueries
default CompletableFuture<ListScheduledQueriesResponse> 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:
- A Java Future containing the result of the ListScheduledQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScheduledQueries
default CompletableFuture<ListScheduledQueriesResponse> listScheduledQueries(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueries
is eventually consistent.
This is a convenience which creates an instance of the
ListScheduledQueriesRequest.Builder
avoiding the need to create one manually viaListScheduledQueriesRequest.builder()
- Parameters:
listScheduledQueriesRequest
- AConsumer
that will call methods onListScheduledQueriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListScheduledQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScheduledQueriesPaginator
default ListScheduledQueriesPublisher listScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest) This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.- Parameters:
listScheduledQueriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScheduledQueriesPaginator
default ListScheduledQueriesPublisher listScheduledQueriesPaginator(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.
This is a convenience which creates an instance of the
ListScheduledQueriesRequest.Builder
avoiding the need to create one manually viaListScheduledQueriesRequest.builder()
- Parameters:
listScheduledQueriesRequest
- AConsumer
that will call methods onListScheduledQueriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags on a Timestream query resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags on a Timestream query resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
prepareQuery
default CompletableFuture<PrepareQueryResponse> 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 totrue
.- Parameters:
prepareQueryRequest
-- Returns:
- A Java Future containing the result of the PrepareQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
prepareQuery
default CompletableFuture<PrepareQueryResponse> prepareQuery(Consumer<PrepareQueryRequest.Builder> 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 totrue
.
This is a convenience which creates an instance of the
PrepareQueryRequest.Builder
avoiding the need to create one manually viaPrepareQueryRequest.builder()
- Parameters:
prepareQueryRequest
- AConsumer
that will call methods onPrepareQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PrepareQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
query
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:
- A Java Future containing the result of the Query operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
query
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.
This is a convenience which creates an instance of the
QueryRequest.Builder
avoiding the need to create one manually viaQueryRequest.builder()
- Parameters:
queryRequest
- AConsumer
that will call methods onQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the Query operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
queryPaginator
This is a variant of
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.QueryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.QueryResponse response) { //... }; });
Please notice that the configuration of MaxRows won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation.- Parameters:
queryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
queryPaginator
This is a variant of
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.QueryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreamquery.model.QueryResponse response) { //... }; });
Please notice that the configuration of MaxRows won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation.
This is a convenience which creates an instance of the
QueryRequest.Builder
avoiding the need to create one manually viaQueryRequest.builder()
- Parameters:
queryRequest
- AConsumer
that will call methods onQueryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- ConflictException Unable to poll results for a cancelled query.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Timestream query resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a Timestream query resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateScheduledQuery
default CompletableFuture<UpdateScheduledQueryResponse> updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest) Update a scheduled query.
- Parameters:
updateScheduledQueryRequest
-- Returns:
- A Java Future containing the result of the UpdateScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateScheduledQuery
default CompletableFuture<UpdateScheduledQueryResponse> updateScheduledQuery(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest) Update a scheduled query.
This is a convenience which creates an instance of the
UpdateScheduledQueryRequest.Builder
avoiding the need to create one manually viaUpdateScheduledQueryRequest.builder()
- Parameters:
updateScheduledQueryRequest
- AConsumer
that will call methods onUpdateScheduledQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateScheduledQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException You are not authorized to perform this action.
- InternalServerException Timestream 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aTimestreamQueryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aTimestreamQueryAsyncClient
.
-