AWS.TimestreamQuery — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Sending a Request Using TimestreamQuery

var timestreamquery = new AWS.TimestreamQuery();
timestreamquery.cancelQuery(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the TimestreamQuery object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var timestreamquery = new AWS.TimestreamQuery({apiVersion: '2018-11-01'});

You can also set the API version globally in AWS.config.apiVersions using the timestreamquery service identifier:

AWS.config.apiVersions = {
  timestreamquery: '2018-11-01',
  // other service API versions
};

var timestreamquery = new AWS.TimestreamQuery();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.TimestreamQuery(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelQuery(params = {}, callback) ⇒ AWS.Request

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.

createScheduledQuery(params = {}, callback) ⇒ AWS.Request

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.

deleteScheduledQuery(params = {}, callback) ⇒ AWS.Request

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

describeAccountSettings(params = {}, callback) ⇒ AWS.Request

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.

describeEndpoints(params = {}, callback) ⇒ AWS.Request

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.

describeScheduledQuery(params = {}, callback) ⇒ AWS.Request

Provides detailed information about a scheduled query.

executeScheduledQuery(params = {}, callback) ⇒ AWS.Request

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

listScheduledQueries(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List all tags on a Timestream query resource.

prepareQuery(params = {}, callback) ⇒ AWS.Request

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.

query(params = {}, callback) ⇒ AWS.Request

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:

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the association of tags from a Timestream query resource.

updateAccountSettings(params = {}, callback) ⇒ AWS.Request

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.

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

updateScheduledQuery(params = {}, callback) ⇒ AWS.Request

Update a scheduled query.