@aws-sdk/client-timestream-query 3.296.0 → 3.298.0

package/dist-types/commands/ListScheduledQueriesCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListScheduledQueriesRequest, ListScheduledQueriesResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link ListScheduledQueriesCommand}.
  */
 export interface ListScheduledQueriesCommandInput extends ListScheduledQueriesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListScheduledQueriesCommand}.
  */
 export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets a list of all scheduled queries in the caller's Amazon account and Region. <code>ListScheduledQueries</code> is eventually consistent. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesR
  * const response = await client.send(command);
  * ```
  *
+ * @param ListScheduledQueriesCommandInput - {@link ListScheduledQueriesCommandInput}
+ * @returns {@link ListScheduledQueriesCommandOutput}
  * @see {@link ListScheduledQueriesCommandInput} for command's `input` shape.
  * @see {@link ListScheduledQueriesCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListScheduledQueriesCommandOutput extends ListScheduledQueriesR
 export declare class ListScheduledQueriesCommand extends $Command<ListScheduledQueriesCommandInput, ListScheduledQueriesCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: ListScheduledQueriesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListScheduledQueriesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListScheduledQueriesCommandInput, ListScheduledQueriesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>List all tags on a Timestream query resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/PrepareQueryCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PrepareQueryRequest, PrepareQueryResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link PrepareQueryCommand}.
  */
 export interface PrepareQueryCommandInput extends PrepareQueryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PrepareQueryCommand}.
  */
 export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -27,6 +32,8 @@ export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param PrepareQueryCommandInput - {@link PrepareQueryCommandInput}
+ * @returns {@link PrepareQueryCommandOutput}
  * @see {@link PrepareQueryCommandInput} for command's `input` shape.
  * @see {@link PrepareQueryCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -53,11 +60,20 @@ export interface PrepareQueryCommandOutput extends PrepareQueryResponse, __Metad
 export declare class PrepareQueryCommand extends $Command<PrepareQueryCommandInput, PrepareQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: PrepareQueryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PrepareQueryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PrepareQueryCommandInput, PrepareQueryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/QueryCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { QueryRequest, QueryResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link QueryCommand}.
  */
 export interface QueryCommandInput extends QueryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link QueryCommand}.
  */
 export interface QueryCommandOutput extends QueryResponse, __MetadataBearer {
 }
 /**
+ * @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.
@@ -55,6 +60,8 @@ export interface QueryCommandOutput extends QueryResponse, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param QueryCommandInput - {@link QueryCommandInput}
+ * @returns {@link QueryCommandOutput}
  * @see {@link QueryCommandInput} for command's `input` shape.
  * @see {@link QueryCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -88,11 +95,20 @@ export interface QueryCommandOutput extends QueryResponse, __MetadataBearer {
 export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: QueryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: QueryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<QueryCommandInput, QueryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -27,6 +32,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -51,11 +58,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the association of tags from a Timestream query resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateScheduledQueryCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateScheduledQueryRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamQueryClientResolvedConfig } from "../TimestreamQueryClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateScheduledQueryCommand}.
  */
 export interface UpdateScheduledQueryCommandInput extends UpdateScheduledQueryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateScheduledQueryCommand}.
  */
 export interface UpdateScheduledQueryCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Update a scheduled query.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateScheduledQueryCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateScheduledQueryCommandInput - {@link UpdateScheduledQueryCommandInput}
+ * @returns {@link UpdateScheduledQueryCommandOutput}
  * @see {@link UpdateScheduledQueryCommandInput} for command's `input` shape.
  * @see {@link UpdateScheduledQueryCommandOutput} for command's `response` shape.
  * @see {@link TimestreamQueryClientResolvedConfig | config} for TimestreamQueryClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateScheduledQueryCommandOutput extends __MetadataBearer {
 export declare class UpdateScheduledQueryCommand extends $Command<UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput, TimestreamQueryClientResolvedConfig> {
     readonly input: UpdateScheduledQueryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateScheduledQueryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamQueryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/TimestreamQueryServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from TimestreamQuery service.
  */
 export declare class TimestreamQueryServiceException extends __ServiceException {