Interface TimestreamQueryClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TimestreamQueryClient extends AwsClient
Service client for accessing Timestream Query. This can be created using the staticbuilder()method.Amazon Timestream Query
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static TimestreamQueryClientBuilderbuilder()Create a builder that can be used to configure and create aTimestreamQueryClient.default CancelQueryResponsecancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)Cancels a query that has been issued.default CancelQueryResponsecancelQuery(CancelQueryRequest cancelQueryRequest)Cancels a query that has been issued.static TimestreamQueryClientcreate()Create aTimestreamQueryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateScheduledQueryResponsecreateScheduledQuery(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest)Create a scheduled query that will be run on your behalf at the configured schedule.default CreateScheduledQueryResponsecreateScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest)Create a scheduled query that will be run on your behalf at the configured schedule.default DeleteScheduledQueryResponsedeleteScheduledQuery(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest)Deletes a given scheduled query.default DeleteScheduledQueryResponsedeleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest)Deletes a given scheduled query.default DescribeEndpointsResponsedescribeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.default DescribeEndpointsResponsedescribeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.default DescribeScheduledQueryResponsedescribeScheduledQuery(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest)Provides detailed information about a scheduled query.default DescribeScheduledQueryResponsedescribeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest)Provides detailed information about a scheduled query.default ExecuteScheduledQueryResponseexecuteScheduledQuery(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest)You can use this API to run a scheduled query manually.default ExecuteScheduledQueryResponseexecuteScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest)You can use this API to run a scheduled query manually.default ListScheduledQueriesResponselistScheduledQueries(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)Gets a list of all scheduled queries in the caller's Amazon account and Region.default ListScheduledQueriesResponselistScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest)Gets a list of all scheduled queries in the caller's Amazon account and Region.default ListScheduledQueriesIterablelistScheduledQueriesPaginator(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)operation.default ListScheduledQueriesIterablelistScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest)This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)List all tags on a Timestream query resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)List all tags on a Timestream query resource.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)operation.default PrepareQueryResponseprepareQuery(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 PrepareQueryResponseprepareQuery(PrepareQueryRequest prepareQueryRequest)A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.default QueryResponsequery(Consumer<QueryRequest.Builder> queryRequest)Queryis a synchronous operation that enables you to run a query against your Amazon Timestream data.default QueryResponsequery(QueryRequest queryRequest)Queryis a synchronous operation that enables you to run a query against your Amazon Timestream data.default QueryIterablequeryPaginator(Consumer<QueryRequest.Builder> queryRequest)This is a variant ofquery(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)operation.default QueryIterablequeryPaginator(QueryRequest queryRequest)This is a variant ofquery(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)operation.default TimestreamQueryServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Associate a set of tags with a Timestream resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Associate a set of tags with a Timestream resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes the association of tags from a Timestream query resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes the association of tags from a Timestream query resource.default UpdateScheduledQueryResponseupdateScheduledQuery(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest)Update a scheduled query.default UpdateScheduledQueryResponseupdateScheduledQuery(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelQuery
default CancelQueryResponse cancelQuery(CancelQueryRequest cancelQueryRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a
CancellationMessage, indicating that the query has already been canceled. See code sample for details.- Parameters:
cancelQueryRequest-- Returns:
- Result of the CancelQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelQuery
default CancelQueryResponse cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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.Builderavoiding the need to create one manually viaCancelQueryRequest.builder()- Parameters:
cancelQueryRequest- AConsumerthat will call methods onCancelQueryRequest.Builderto create a request.- Returns:
- Result of the CancelQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createScheduledQuery
default CreateScheduledQueryResponse createScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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
ScheduledQueryExecutionRoleArnparameter to run the query. You can use theNotificationConfigurationparameter to configure notification for your scheduled query operations.- Parameters:
createScheduledQueryRequest-- Returns:
- Result of the CreateScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.ConflictException- Unable to poll results for a cancelled query.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
createScheduledQuery
default CreateScheduledQueryResponse createScheduledQuery(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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
ScheduledQueryExecutionRoleArnparameter to run the query. You can use theNotificationConfigurationparameter to configure notification for your scheduled query operations.
This is a convenience which creates an instance of the
CreateScheduledQueryRequest.Builderavoiding the need to create one manually viaCreateScheduledQueryRequest.builder()- Parameters:
createScheduledQueryRequest- AConsumerthat will call methods onCreateScheduledQueryRequest.Builderto create a request.- Returns:
- Result of the CreateScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.ConflictException- Unable to poll results for a cancelled query.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScheduledQuery
default DeleteScheduledQueryResponse deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Deletes a given scheduled query. This is an irreversible operation.
- Parameters:
deleteScheduledQueryRequest-- Returns:
- Result of the DeleteScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScheduledQuery
default DeleteScheduledQueryResponse deleteScheduledQuery(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Deletes a given scheduled query. This is an irreversible operation.
This is a convenience which creates an instance of the
DeleteScheduledQueryRequest.Builderavoiding the need to create one manually viaDeleteScheduledQueryRequest.builder()- Parameters:
deleteScheduledQueryRequest- AConsumerthat will call methods onDeleteScheduledQueryRequest.Builderto create a request.- Returns:
- Result of the DeleteScheduledQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEndpoints
default DescribeEndpointsResponse describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, TimestreamQueryException
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
-
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
-
Your application uses a programming language that does not yet have SDK support
-
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
- Parameters:
describeEndpointsRequest-- Returns:
- Result of the DescribeEndpoints operation returned by the service.
- Throws:
InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeEndpoints
default DescribeEndpointsResponse describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest) throws InternalServerException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, TimestreamQueryException
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.Builderavoiding the need to create one manually viaDescribeEndpointsRequest.builder()- Parameters:
describeEndpointsRequest- AConsumerthat will call methods onDescribeEndpointsRequest.Builderto create a request.- Returns:
- Result of the DescribeEndpoints operation returned by the service.
- Throws:
InternalServerException- Timestream was unable to fully process this request because of an internal server error.ValidationException- Invalid or malformed request.ThrottlingException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeScheduledQuery
default DescribeScheduledQueryResponse describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Provides detailed information about a scheduled query.
- Parameters:
describeScheduledQueryRequest-- Returns:
- Result of the DescribeScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeScheduledQuery
default DescribeScheduledQueryResponse describeScheduledQuery(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Provides detailed information about a scheduled query.
This is a convenience which creates an instance of the
DescribeScheduledQueryRequest.Builderavoiding the need to create one manually viaDescribeScheduledQueryRequest.builder()- Parameters:
describeScheduledQueryRequest- AConsumerthat will call methods onDescribeScheduledQueryRequest.Builderto create a request.- Returns:
- Result of the DescribeScheduledQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
executeScheduledQuery
default ExecuteScheduledQueryResponse executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
You can use this API to run a scheduled query manually.
- Parameters:
executeScheduledQueryRequest-- Returns:
- Result of the ExecuteScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
executeScheduledQuery
default ExecuteScheduledQueryResponse executeScheduledQuery(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
You can use this API to run a scheduled query manually.
This is a convenience which creates an instance of the
ExecuteScheduledQueryRequest.Builderavoiding the need to create one manually viaExecuteScheduledQueryRequest.builder()- Parameters:
executeScheduledQueryRequest- AConsumerthat will call methods onExecuteScheduledQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteScheduledQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listScheduledQueries
default ListScheduledQueriesResponse listScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueriesis eventually consistent.- Parameters:
listScheduledQueriesRequest-- Returns:
- Result of the ListScheduledQueries operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
listScheduledQueries
default ListScheduledQueriesResponse listScheduledQueries(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueriesis eventually consistent.
This is a convenience which creates an instance of the
ListScheduledQueriesRequest.Builderavoiding the need to create one manually viaListScheduledQueriesRequest.builder()- Parameters:
listScheduledQueriesRequest- AConsumerthat will call methods onListScheduledQueriesRequest.Builderto create a request.- Returns:
- Result of the ListScheduledQueries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listScheduledQueriesPaginator
default ListScheduledQueriesIterable listScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client.listScheduledQueriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client .listScheduledQueriesPaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client.listScheduledQueriesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listScheduledQueriesPaginator
default ListScheduledQueriesIterable listScheduledQueriesPaginator(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client.listScheduledQueriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client .listScheduledQueriesPaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesIterable responses = client.listScheduledQueriesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListScheduledQueriesRequest.builder()- Parameters:
listScheduledQueriesRequest- AConsumerthat will call methods onListScheduledQueriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
List all tags on a Timestream query resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
List all tags on a Timestream query resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareQuery
default PrepareQueryResponse prepareQuery(PrepareQueryRequest prepareQueryRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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$ValidateOnlyset totrue.- Parameters:
prepareQueryRequest-- Returns:
- Result of the PrepareQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareQuery
default PrepareQueryResponse prepareQuery(Consumer<PrepareQueryRequest.Builder> prepareQueryRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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$ValidateOnlyset totrue.
This is a convenience which creates an instance of the
PrepareQueryRequest.Builderavoiding the need to create one manually viaPrepareQueryRequest.builder()- Parameters:
prepareQueryRequest- AConsumerthat will call methods onPrepareQueryRequest.Builderto create a request.- Returns:
- Result of the PrepareQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
query
default QueryResponse query(QueryRequest queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Queryis a synchronous operation that enables you to run a query against your Amazon Timestream data.Querywill 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
Queryrequest with the same client token outside of the 5-minute idempotency window. -
If you submit a
Queryrequest 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 tokenerror.
- Parameters:
queryRequest-- Returns:
- Result of the Query operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.ConflictException- Unable to poll results for a cancelled query.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
query
default QueryResponse query(Consumer<QueryRequest.Builder> queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Queryis a synchronous operation that enables you to run a query against your Amazon Timestream data.Querywill 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
Queryrequest with the same client token outside of the 5-minute idempotency window. -
If you submit a
Queryrequest 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 tokenerror.
This is a convenience which creates an instance of the
QueryRequest.Builderavoiding the need to create one manually viaQueryRequest.builder()- Parameters:
queryRequest- AConsumerthat will call methods onQueryRequest.Builderto create a request.- Returns:
- Result of the Query operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.ConflictException- Unable to poll results for a cancelled query.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
queryPaginator
default QueryIterable queryPaginator(QueryRequest queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.QueryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
queryPaginator
default QueryIterable queryPaginator(Consumer<QueryRequest.Builder> queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
This is a variant of
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); for (software.amazon.awssdk.services.timestreamquery.model.QueryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.timestreamquery.paginators.QueryIterable responses = client.queryPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaQueryRequest.builder()- Parameters:
queryRequest- AConsumerthat will call methods onQueryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ServiceQuotaExceededException- You have exceeded the service quota.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The requested resource could not be found.ServiceQuotaExceededException- You have exceeded the service quota.ThrottlingException- The request was denied due to request throttling.ValidationException- Invalid or malformed request.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Removes the association of tags from a Timestream query resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ValidationException- Invalid or malformed request.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- The requested resource could not be found.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Removes the association of tags from a Timestream query resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ValidationException- Invalid or malformed request.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- The requested resource could not be found.InvalidEndpointException- The requested endpoint was not valid.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateScheduledQuery
default UpdateScheduledQueryResponse updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Update a scheduled query.
- Parameters:
updateScheduledQueryRequest-- Returns:
- Result of the UpdateScheduledQuery operation returned by the service.
- Throws:
AccessDeniedException- You are not authorized to perform this action.InternalServerException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateScheduledQuery
default UpdateScheduledQueryResponse updateScheduledQuery(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException
Update a scheduled query.
This is a convenience which creates an instance of the
UpdateScheduledQueryRequest.Builderavoiding the need to create one manually viaUpdateScheduledQueryRequest.builder()- Parameters:
updateScheduledQueryRequest- AConsumerthat will call methods onUpdateScheduledQueryRequest.Builderto create a request.- Returns:
- Result of the UpdateScheduledQuery operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static TimestreamQueryClient create()
Create aTimestreamQueryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static TimestreamQueryClientBuilder builder()
Create a builder that can be used to configure and create aTimestreamQueryClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default TimestreamQueryServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-