- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
TimestreamQueryClient
Installation
npm install @aws-sdk/client-timestream-query
yarn add @aws-sdk/client-timestream-query
pnpm add @aws-sdk/client-timestream-query
TimestreamQueryClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CancelQueryCommand | 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 |
CreateScheduledQueryCommand | 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 |
DeleteScheduledQueryCommand | Deletes a given scheduled query. This is an irreversible operation. |
DescribeAccountSettingsCommand | 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. |
DescribeEndpointsCommand | 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 . |
DescribeScheduledQueryCommand | Provides detailed information about a scheduled query. |
ExecuteScheduledQueryCommand | You can use this API to run a scheduled query manually. If you enabled |
ListScheduledQueriesCommand | Gets a list of all scheduled queries in the caller's Amazon account and Region. |
ListTagsForResourceCommand | List all tags on a Timestream query resource. |
PrepareQueryCommand | 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 |
QueryCommand | If you enabled The maximum number of Your query request will fail in the following cases:
|
TagResourceCommand | 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. |
UntagResourceCommand | Removes the association of tags from a Timestream query resource. |
UpdateAccountSettingsCommand | 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 After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing. |
UpdateScheduledQueryCommand | Update a scheduled query. |
TimestreamQueryClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: TimestreamQueryClientConfig