com.amazonaws.services.timestreamquery

Interface AmazonTimestreamQuery

All Known Subinterfaces:

AmazonTimestreamQueryAsync

All Known Implementing Classes:

AbstractAmazonTimestreamQuery, AbstractAmazonTimestreamQueryAsync, AmazonTimestreamQueryAsyncClient, AmazonTimestreamQueryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTimestreamQuery

Interface for accessing Timestream Query.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonTimestreamQuery instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelQueryResult	cancelQuery(CancelQueryRequest cancelQueryRequest) Cancels a query that has been issued.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
QueryResult	query(QueryRequest queryRequest) Query is a synchronous operation that enables you to execute a query.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelQuery

CancelQueryResult cancelQuery(CancelQueryRequest cancelQueryRequest)

Cancels a query that has been issued. Cancellation is guaranteed only if the query has not completed execution 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.

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 invalid.

See Also:

AWS API Documentation

describeEndpoints

DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s 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:

• 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 to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.

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.

See Also:

AWS API Documentation

query

QueryResult query(QueryRequest queryRequest)

Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.

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 invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.