AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.

If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.

The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.

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:

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginQuery and EndQuery.

Namespace: Amazon.TimestreamQuery
Assembly: AWSSDK.TimestreamQuery.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<QueryResponse> QueryAsync(
         QueryRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.TimestreamQuery.Model.QueryRequest

Container for the necessary parameters to execute the Query service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the Query service method, as returned by TimestreamQuery.

Exceptions

ExceptionCondition
AccessDeniedException You do not have the necessary permissions to access the account settings.
ConflictException Unable to poll results for a cancelled query.
InternalServerException An internal server error occurred while processing the request.
InvalidEndpointException The requested endpoint is invalid.
QueryExecutionException Timestream was unable to run the query successfully.
ThrottlingException The request was throttled due to excessive requests.
ValidationException Invalid or malformed request.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also