@aws-sdk/client-keyspaces 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { GetTableRequest, GetTableResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetTableCommand}.
  */
 export interface GetTableCommandInput extends GetTableRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetTableCommand}.
  */
 export interface GetTableCommandOutput extends GetTableResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns information about the table, including the table's name and current status, the keyspace name,
  *          configuration settings, and metadata.</p>
  *          <p>To read table metadata using <code>GetTable</code>, <code>Select</code> action
@@ -28,6 +33,8 @@ export interface GetTableCommandOutput extends GetTableResponse, __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param GetTableCommandInput - {@link GetTableCommandInput}
+ * @returns {@link GetTableCommandOutput}
  * @see {@link GetTableCommandInput} for command's `input` shape.
  * @see {@link GetTableCommandOutput} for command's `response` shape.
  * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -53,11 +60,20 @@ export interface GetTableCommandOutput extends GetTableResponse, __MetadataBeare
 export declare class GetTableCommand extends $Command<GetTableCommandInput, GetTableCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: GetTableCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetTableCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetTableCommandInput, GetTableCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { ListTablesRequest, ListTablesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTablesCommand}.
  */
 export interface ListTablesCommandInput extends ListTablesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTablesCommand}.
  */
 export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of tables for a specified keyspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTablesCommandInput - {@link ListTablesCommandInput}
+ * @returns {@link ListTablesCommandOutput}
  * @see {@link ListTablesCommandInput} for command's `input` shape.
  * @see {@link ListTablesCommandOutput} for command's `response` shape.
  * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
 export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: ListTablesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTablesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTablesCommandInput, ListTablesCommandOutput>;
+    /**
+     * @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 { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @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>Returns a list of all tags associated with the specified Amazon Keyspaces 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 KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { RestoreTableRequest, RestoreTableResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RestoreTableCommand}.
  */
 export interface RestoreTableCommandInput extends RestoreTableRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RestoreTableCommand}.
  */
 export interface RestoreTableCommandOutput extends RestoreTableResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Restores the specified table to the specified point in time within the
  *          <code>earliest_restorable_timestamp</code> and the current time. For more information about restore points, see
  *          <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window">
@@ -71,6 +76,8 @@ export interface RestoreTableCommandOutput extends RestoreTableResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param RestoreTableCommandInput - {@link RestoreTableCommandInput}
+ * @returns {@link RestoreTableCommandOutput}
  * @see {@link RestoreTableCommandInput} for command's `input` shape.
  * @see {@link RestoreTableCommandOutput} for command's `response` shape.
  * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -101,11 +108,20 @@ export interface RestoreTableCommandOutput extends RestoreTableResponse, __Metad
 export declare class RestoreTableCommand extends $Command<RestoreTableCommandInput, RestoreTableCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: RestoreTableCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RestoreTableCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreTableCommandInput, RestoreTableCommandOutput>;
+    /**
+     * @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 { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @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>Associates a set of tags with a Amazon Keyspaces resource. You can then
  *          activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking.
  *       For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
@@ -31,6 +36,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 KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, 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 { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @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 Amazon Keyspaces 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 KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
 import { UpdateTableRequest, UpdateTableResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateTableCommand}.
  */
 export interface UpdateTableCommandInput extends UpdateTableRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateTableCommand}.
  */
 export interface UpdateTableCommandOutput extends UpdateTableResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds new columns to the table or updates one of the table's settings, for example
  *          capacity mode, encryption, point-in-time recovery, or ttl settings.
  *       Note that you can only update one specific table setting per update operation.</p>
@@ -27,6 +32,8 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateTableCommandInput - {@link UpdateTableCommandInput}
+ * @returns {@link UpdateTableCommandOutput}
  * @see {@link UpdateTableCommandInput} for command's `input` shape.
  * @see {@link UpdateTableCommandOutput} for command's `response` shape.
  * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
 export declare class UpdateTableCommand extends $Command<UpdateTableCommandInput, UpdateTableCommandOutput, KeyspacesClientResolvedConfig> {
     readonly input: UpdateTableCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateTableCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KeyspacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTableCommandInput, UpdateTableCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/KeyspacesServiceException.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 Keyspaces service.
  */
 export declare class KeyspacesServiceException extends __ServiceException {