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.

Interface for accessing TimestreamQuery

Amazon Timestream Query

Inheritance Hierarchy

Amazon.TimestreamQuery.IAmazonTimestreamQuery

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

Syntax

C# 
public interface IAmazonTimestreamQuery
         IAmazonService, IDisposable

The IAmazonTimestreamQuery type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.TimestreamQuery.Model.ITimestreamQueryPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelQuery(CancelQueryRequest)

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

Public Method CancelQueryAsync(CancelQueryRequest, CancellationToken)

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.

Public Method CreateScheduledQuery(CreateScheduledQueryRequest)

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Public Method CreateScheduledQueryAsync(CreateScheduledQueryRequest, CancellationToken)

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 the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Public Method DeleteScheduledQuery(DeleteScheduledQueryRequest)

Deletes a given scheduled query. This is an irreversible operation.

Public Method DeleteScheduledQueryAsync(DeleteScheduledQueryRequest, CancellationToken)

Deletes a given scheduled query. This is an irreversible operation.

Public Method DescribeAccountSettings(DescribeAccountSettingsRequest)

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

Public Method DescribeAccountSettingsAsync(DescribeAccountSettingsRequest, CancellationToken)

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

Public Method DescribeEndpoints(DescribeEndpointsRequest)

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

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

Public Method DescribeEndpointsAsync(DescribeEndpointsRequest, CancellationToken)

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:

For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.

Public Method DescribeScheduledQuery(DescribeScheduledQueryRequest)

Provides detailed information about a scheduled query.

Public Method DescribeScheduledQueryAsync(DescribeScheduledQueryRequest, CancellationToken)

Provides detailed information about a scheduled query.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method ExecuteScheduledQuery(ExecuteScheduledQueryRequest)

You can use this API to run a scheduled query manually.

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

Public Method ExecuteScheduledQueryAsync(ExecuteScheduledQueryRequest, CancellationToken)

You can use this API to run a scheduled query manually.

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

Public Method ListScheduledQueries(ListScheduledQueriesRequest)

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

Public Method ListScheduledQueriesAsync(ListScheduledQueriesRequest, CancellationToken)

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

Public Method ListTagsForResource(ListTagsForResourceRequest)

List all tags on a Timestream query resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

List all tags on a Timestream query resource.

Public Method PrepareQuery(PrepareQueryRequest)

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

Public Method PrepareQueryAsync(PrepareQueryRequest, CancellationToken)

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 to true.

Public Method Query(QueryRequest)

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:

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

Public Method QueryAsync(QueryRequest, CancellationToken)

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:

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

Public Method TagResource(TagResourceRequest)

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Removes the association of tags from a Timestream query resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes the association of tags from a Timestream query resource.

Public Method UpdateAccountSettings(UpdateAccountSettingsRequest)

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

Public Method UpdateAccountSettingsAsync(UpdateAccountSettingsRequest, CancellationToken)

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective.

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

Public Method UpdateScheduledQuery(UpdateScheduledQueryRequest)

Update a scheduled query.

Public Method UpdateScheduledQueryAsync(UpdateScheduledQueryRequest, CancellationToken)

Update a scheduled query.

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, 3.5