@aws-sdk/client-timestream-query 3.312.0 → 3.316.0

package/dist-types/TimestreamQuery.d.ts

@@ -13,165 +13,91 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput } from "./commands/UpdateScheduledQueryCommand";
 import { TimestreamQueryClient } from "./TimestreamQueryClient";
-/**
- * @public
- * <fullname>Amazon Timestream Query
- *         </fullname>
- *         <p></p>
- */
-export declare class TimestreamQuery extends TimestreamQueryClient {
+export interface TimestreamQuery {
     /**
-     * @public
-     * <p> 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
-     *                 <code>CancellationMessage</code>, indicating that the query has already been
-     *             canceled. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html">code
-     *                 sample</a> for details. </p>
+     * @see {@link CancelQueryCommand}
      */
     cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise<CancelQueryCommandOutput>;
     cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
     cancelQuery(args: CancelQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p> 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
-     *                 <code>ScheduledQueryExecutionRoleArn</code> parameter to run the query. You can use
-     *             the <code>NotificationConfiguration</code> parameter to configure notification for your
-     *             scheduled query operations.</p>
+     * @see {@link CreateScheduledQueryCommand}
      */
     createScheduledQuery(args: CreateScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<CreateScheduledQueryCommandOutput>;
     createScheduledQuery(args: CreateScheduledQueryCommandInput, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void): void;
     createScheduledQuery(args: CreateScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a given scheduled query. This is an irreversible operation. </p>
+     * @see {@link DeleteScheduledQueryCommand}
      */
     deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScheduledQueryCommandOutput>;
     deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void): void;
     deleteScheduledQuery(args: DeleteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p>DescribeEndpoints returns a list of available endpoints to make Timestream
-     *             API calls against. This API is available through both Write and Query.</p>
-     *         <p>Because the Timestream SDKs are designed to transparently work with the
-     *             service’s architecture, including the management and mapping of the service endpoints,
-     *                 <i>it is not recommended that you use this API unless</i>:</p>
-     *         <ul>
-     *             <li>
-     *                 <p>You are using <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints">VPC endpoints (Amazon Web Services PrivateLink) with Timestream
-     *                     </a>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                 <p>Your application uses a programming language that does not yet have SDK
-     *                     support</p>
-     *             </li>
-     *             <li>
-     *                 <p>You require better control over the client-side implementation</p>
-     *             </li>
-     *          </ul>
-     *         <p>For detailed information on how and when to use and implement DescribeEndpoints, see
-     *                 <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery">The Endpoint Discovery Pattern</a>.</p>
+     * @see {@link DescribeEndpointsCommand}
      */
     describeEndpoints(args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointsCommandOutput>;
     describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
     describeEndpoints(args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Provides detailed information about a scheduled query.</p>
+     * @see {@link DescribeScheduledQueryCommand}
      */
     describeScheduledQuery(args: DescribeScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScheduledQueryCommandOutput>;
     describeScheduledQuery(args: DescribeScheduledQueryCommandInput, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void): void;
     describeScheduledQuery(args: DescribeScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p> You can use this API to run a scheduled query manually. </p>
+     * @see {@link ExecuteScheduledQueryCommand}
      */
     executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteScheduledQueryCommandOutput>;
     executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void): void;
     executeScheduledQuery(args: ExecuteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Gets a list of all scheduled queries in the caller's Amazon account and Region. <code>ListScheduledQueries</code> is eventually consistent. </p>
+     * @see {@link ListScheduledQueriesCommand}
      */
     listScheduledQueries(args: ListScheduledQueriesCommandInput, options?: __HttpHandlerOptions): Promise<ListScheduledQueriesCommandOutput>;
     listScheduledQueries(args: ListScheduledQueriesCommandInput, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void): void;
     listScheduledQueries(args: ListScheduledQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void): void;
     /**
-     * @public
-     * <p>List all tags on a Timestream query resource.</p>
+     * @see {@link ListTagsForResourceCommand}
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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 the
-     *                 <code>PrepareQueryRequest$ValidateOnly</code> set to <code>true</code>. </p>
+     * @see {@link PrepareQueryCommand}
      */
     prepareQuery(args: PrepareQueryCommandInput, options?: __HttpHandlerOptions): Promise<PrepareQueryCommandOutput>;
     prepareQuery(args: PrepareQueryCommandInput, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void;
     prepareQuery(args: PrepareQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p>
-     *             <code>Query</code> is a synchronous operation that enables you to run a query against
-     *             your Amazon Timestream data. <code>Query</code> will time out after 60 seconds.
-     *             You must update the default timeout in the SDK to support a timeout of 60 seconds. See
-     *             the <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html">code
-     *                 sample</a> for details. </p>
-     *         <p>Your query request will fail in the following cases:</p>
-     *         <ul>
-     *             <li>
-     *                 <p> If you submit a <code>Query</code> request with the same client token outside
-     *                     of the 5-minute idempotency window. </p>
-     *             </li>
-     *             <li>
-     *                 <p> If you submit a <code>Query</code> request with the same client token, but
-     *                     change other parameters, within the 5-minute idempotency window. </p>
-     *             </li>
-     *             <li>
-     *                 <p> If the size of the row (including the query metadata) exceeds 1 MB, then the
-     *                     query will fail with the following error message: </p>
-     *                 <p>
-     *                   <code>Query aborted as max page response size has been exceeded by the output
-     *                         result row</code>
-     *                 </p>
-     *             </li>
-     *             <li>
-     *                 <p> 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 <code>Invalid
-     *                         pagination token</code> error. </p>
-     *             </li>
-     *          </ul>
+     * @see {@link QueryCommand}
      */
     query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise<QueryCommandOutput>;
     query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void;
     query(args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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. </p>
+     * @see {@link TagResourceCommand}
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Removes the association of tags from a Timestream query resource.</p>
+     * @see {@link UntagResourceCommand}
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Update a scheduled query.</p>
+     * @see {@link UpdateScheduledQueryCommand}
      */
     updateScheduledQuery(args: UpdateScheduledQueryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateScheduledQueryCommandOutput>;
     updateScheduledQuery(args: UpdateScheduledQueryCommandInput, cb: (err: any, data?: UpdateScheduledQueryCommandOutput) => void): void;
     updateScheduledQuery(args: UpdateScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduledQueryCommandOutput) => void): void;
 }
+/**
+ * @public
+ * <fullname>Amazon Timestream Query
+ *         </fullname>
+ *         <p></p>
+ */
+export declare class TimestreamQuery extends TimestreamQueryClient implements TimestreamQuery {
+}

package/dist-types/ts3.4/TimestreamQuery.d.ts

@@ -49,7 +49,7 @@ import {
   UpdateScheduledQueryCommandOutput,
 } from "./commands/UpdateScheduledQueryCommand";
 import { TimestreamQueryClient } from "./TimestreamQueryClient";
-export declare class TimestreamQuery extends TimestreamQueryClient {
+export interface TimestreamQuery {
   cancelQuery(
     args: CancelQueryCommandInput,
     options?: __HttpHandlerOptions
@@ -220,3 +220,6 @@ export declare class TimestreamQuery extends TimestreamQueryClient {
     cb: (err: any, data?: UpdateScheduledQueryCommandOutput) => void
   ): void;
 }
+export declare class TimestreamQuery
+  extends TimestreamQueryClient
+  implements TimestreamQuery {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-timestream-query",
   "description": "AWS SDK for JavaScript Timestream Query Client for Node.js, Browser and React Native",
-  "version": "3.312.0",
+  "version": "3.316.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.312.0",
+    "@aws-sdk/client-sts": "3.316.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.310.0",
+    "@aws-sdk/credential-provider-node": "3.316.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -41,14 +41,14 @@
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.310.0",
+    "@aws-sdk/smithy-client": "3.316.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.310.0",
-    "@aws-sdk/util-defaults-mode-node": "3.310.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
+    "@aws-sdk/util-defaults-mode-node": "3.316.0",
     "@aws-sdk/util-endpoints": "3.310.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",