Interface TimestreamQueryClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic TimestreamQueryClientBuilder
builder()
Create a builder that can be used to configure and create aTimestreamQueryClient
.default CancelQueryResponse
cancelQuery
(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a query that has been issued.default CancelQueryResponse
cancelQuery
(CancelQueryRequest cancelQueryRequest) Cancels a query that has been issued.static TimestreamQueryClient
create()
Create aTimestreamQueryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateScheduledQueryResponse
createScheduledQuery
(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest) Create a scheduled query that will be run on your behalf at the configured schedule.default CreateScheduledQueryResponse
createScheduledQuery
(CreateScheduledQueryRequest createScheduledQueryRequest) Create a scheduled query that will be run on your behalf at the configured schedule.default DeleteScheduledQueryResponse
deleteScheduledQuery
(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest) Deletes a given scheduled query.default DeleteScheduledQueryResponse
deleteScheduledQuery
(DeleteScheduledQueryRequest deleteScheduledQueryRequest) Deletes a given scheduled query.default DescribeEndpointsResponse
describeEndpoints
(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.default DescribeEndpointsResponse
describeEndpoints
(DescribeEndpointsRequest describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.default DescribeScheduledQueryResponse
describeScheduledQuery
(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest) Provides detailed information about a scheduled query.default DescribeScheduledQueryResponse
describeScheduledQuery
(DescribeScheduledQueryRequest describeScheduledQueryRequest) Provides detailed information about a scheduled query.default ExecuteScheduledQueryResponse
executeScheduledQuery
(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest) You can use this API to run a scheduled query manually.default ExecuteScheduledQueryResponse
executeScheduledQuery
(ExecuteScheduledQueryRequest executeScheduledQueryRequest) You can use this API to run a scheduled query manually.default ListScheduledQueriesResponse
listScheduledQueries
(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.default ListScheduledQueriesResponse
listScheduledQueries
(ListScheduledQueriesRequest listScheduledQueriesRequest) Gets a list of all scheduled queries in the caller's Amazon account and Region.default ListScheduledQueriesIterable
listScheduledQueriesPaginator
(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest) This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.default ListScheduledQueriesIterable
listScheduledQueriesPaginator
(ListScheduledQueriesRequest listScheduledQueriesRequest) This is a variant oflistScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags on a Timestream query resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags on a Timestream query resource.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.default 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 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 QueryResponse
query
(Consumer<QueryRequest.Builder> queryRequest) Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.default QueryResponse
query
(QueryRequest queryRequest) Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.default QueryIterable
queryPaginator
(Consumer<QueryRequest.Builder> queryRequest) This is a variant ofquery(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation.default QueryIterable
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., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate a set of tags with a Timestream resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associate a set of tags with a Timestream resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a Timestream query resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Timestream query resource.default UpdateScheduledQueryResponse
updateScheduledQuery
(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest) Update a scheduled query.default UpdateScheduledQueryResponse
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
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCancelQueryRequest.builder()
- Parameters:
cancelQueryRequest
- AConsumer
that will call methods onCancelQueryRequest.Builder
to create a request.- Returns:
- Result of the CancelQuery operation returned by the service.
- See Also:
-
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
ScheduledQueryExecutionRoleArn
parameter to run the query. You can use theNotificationConfiguration
parameter to configure notification for your scheduled query operations.- Parameters:
createScheduledQueryRequest
-- Returns:
- Result of the CreateScheduledQuery operation returned by the service.
- See Also:
-
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
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:
- Result of the CreateScheduledQuery operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteScheduledQueryRequest.builder()
- Parameters:
deleteScheduledQueryRequest
- AConsumer
that will call methods onDeleteScheduledQueryRequest.Builder
to create a request.- Returns:
- Result of the DeleteScheduledQuery operation returned by the service.
- See Also:
-
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.
- See Also:
-
-
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.Builder
avoiding the need to create one manually viaDescribeEndpointsRequest.builder()
- Parameters:
describeEndpointsRequest
- AConsumer
that will call methods onDescribeEndpointsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpoints operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDescribeScheduledQueryRequest.builder()
- Parameters:
describeScheduledQueryRequest
- AConsumer
that will call methods onDescribeScheduledQueryRequest.Builder
to create a request.- Returns:
- Result of the DescribeScheduledQuery operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaExecuteScheduledQueryRequest.builder()
- Parameters:
executeScheduledQueryRequest
- AConsumer
that will call methods onExecuteScheduledQueryRequest.Builder
to create a request.- Returns:
- Result of the ExecuteScheduledQuery operation returned by the service.
- See Also:
-
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.
ListScheduledQueries
is eventually consistent.- Parameters:
listScheduledQueriesRequest
-- Returns:
- Result of the ListScheduledQueries operation returned by the service.
- See Also:
-
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.
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:
- Result of the ListScheduledQueries operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
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
ValidateOnly
set totrue
.- Parameters:
prepareQueryRequest
-- Returns:
- Result of the PrepareQuery operation returned by the service.
- See Also:
-
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
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:
- Result of the PrepareQuery operation returned by the service.
- See Also:
-
query
default QueryResponse query(QueryRequest queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException Query
is a synchronous operation that enables you to run a query against your Amazon Timestream data.Query
will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details.Your query request will fail in the following cases:
-
If you submit a
Query
request with the same client token outside of the 5-minute idempotency window. -
If you submit a
Query
request with the same client token, but change other parameters, within the 5-minute idempotency window. -
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
-
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token
error.
- Parameters:
queryRequest
-- Returns:
- Result of the Query operation returned by the service.
- See Also:
-
-
query
default QueryResponse query(Consumer<QueryRequest.Builder> queryRequest) throws AccessDeniedException, ConflictException, InternalServerException, QueryExecutionException, ThrottlingException, ValidationException, InvalidEndpointException, AwsServiceException, SdkClientException, TimestreamQueryException 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:
- Result of the Query operation returned by the service.
- See Also:
-
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.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 iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateScheduledQueryRequest.builder()
- Parameters:
updateScheduledQueryRequest
- AConsumer
that will call methods onUpdateScheduledQueryRequest.Builder
to create a request.- Returns:
- Result of the UpdateScheduledQuery operation returned by the service.
- See Also:
-
create
Create aTimestreamQueryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aTimestreamQueryClient
. -
serviceMetadata
-
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
-