@aws-sdk/client-docdb 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DBSubnetGroupMessage, DescribeDBSubnetGroupsMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeDBSubnetGroupsCommand}.
  */
 export interface DescribeDBSubnetGroupsCommandInput extends DescribeDBSubnetGroupsMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeDBSubnetGroupsCommand}.
  */
 export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a
  *                 <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeDBSubnetGroupsCommandInput - {@link DescribeDBSubnetGroupsCommandInput}
+ * @returns {@link DescribeDBSubnetGroupsCommandOutput}
  * @see {@link DescribeDBSubnetGroupsCommandInput} for command's `input` shape.
  * @see {@link DescribeDBSubnetGroupsCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -39,11 +46,20 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
 export declare class DescribeDBSubnetGroupsCommand extends $Command<DescribeDBSubnetGroupsCommandInput, DescribeDBSubnetGroupsCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeDBSubnetGroupsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeDBSubnetGroupsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBSubnetGroupsCommandInput, DescribeDBSubnetGroupsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeEngineDefaultClusterParametersMessage, DescribeEngineDefaultClusterParametersResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEngineDefaultClusterParametersCommand}.
  */
 export interface DescribeEngineDefaultClusterParametersCommandInput extends DescribeEngineDefaultClusterParametersMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEngineDefaultClusterParametersCommand}.
  */
 export interface DescribeEngineDefaultClusterParametersCommandOutput extends DescribeEngineDefaultClusterParametersResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns the default engine and system parameter information for the cluster database
  *             engine.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEngineDefaultClusterParametersCommandInput - {@link DescribeEngineDefaultClusterParametersCommandInput}
+ * @returns {@link DescribeEngineDefaultClusterParametersCommandOutput}
  * @see {@link DescribeEngineDefaultClusterParametersCommandInput} for command's `input` shape.
  * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -35,11 +42,20 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
 export declare class DescribeEngineDefaultClusterParametersCommand extends $Command<DescribeEngineDefaultClusterParametersCommandInput, DescribeEngineDefaultClusterParametersCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeEngineDefaultClusterParametersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEngineDefaultClusterParametersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEngineDefaultClusterParametersCommandInput, DescribeEngineDefaultClusterParametersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeEventCategoriesMessage, EventCategoriesMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventCategoriesCommand}.
  */
 export interface DescribeEventCategoriesCommandInput extends DescribeEventCategoriesMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventCategoriesCommand}.
  */
 export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Displays a list of categories for all event source types, or, if specified, for a
  *             specified source type. </p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEventCategoriesCommandInput - {@link DescribeEventCategoriesCommandInput}
+ * @returns {@link DescribeEventCategoriesCommandOutput}
  * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape.
  * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -35,11 +42,20 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
 export declare class DescribeEventCategoriesCommand extends $Command<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeEventCategoriesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventCategoriesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeEventSubscriptionsMessage, EventSubscriptionsMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventSubscriptionsCommand}.
  */
 export interface DescribeEventSubscriptionsCommandInput extends DescribeEventSubscriptionsMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventSubscriptionsCommand}.
  */
 export interface DescribeEventSubscriptionsCommandOutput extends EventSubscriptionsMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.</p>
  *         <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEventSubscriptionsCommandInput - {@link DescribeEventSubscriptionsCommandInput}
+ * @returns {@link DescribeEventSubscriptionsCommandOutput}
  * @see {@link DescribeEventSubscriptionsCommandInput} for command's `input` shape.
  * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
 export declare class DescribeEventSubscriptionsCommand extends $Command<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeEventSubscriptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventSubscriptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeEventsMessage, EventsMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventsCommand}.
  */
 export interface DescribeEventsCommandInput extends DescribeEventsMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventsCommand}.
  */
 export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput}
+ * @returns {@link DescribeEventsCommandOutput}
  * @see {@link DescribeEventsCommandInput} for command's `input` shape.
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -34,11 +41,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
 export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeEventsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsCommandInput, DescribeEventsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeGlobalClustersMessage, GlobalClustersMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeGlobalClustersCommand}.
  */
 export interface DescribeGlobalClustersCommandInput extends DescribeGlobalClustersMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeGlobalClustersCommand}.
  */
 export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns information about Amazon DocumentDB global  clusters. This API supports pagination.</p>
  *         <note>
  *             <p>This action only applies to Amazon DocumentDB clusters.</p>
@@ -28,6 +33,8 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeGlobalClustersCommandInput - {@link DescribeGlobalClustersCommandInput}
+ * @returns {@link DescribeGlobalClustersCommandOutput}
  * @see {@link DescribeGlobalClustersCommandInput} for command's `input` shape.
  * @see {@link DescribeGlobalClustersCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -40,11 +47,20 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
 export declare class DescribeGlobalClustersCommand extends $Command<DescribeGlobalClustersCommandInput, DescribeGlobalClustersCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeGlobalClustersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeGlobalClustersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGlobalClustersCommandInput, DescribeGlobalClustersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribeOrderableDBInstanceOptionsMessage, OrderableDBInstanceOptionsMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeOrderableDBInstanceOptionsCommand}.
  */
 export interface DescribeOrderableDBInstanceOptionsCommandInput extends DescribeOrderableDBInstanceOptionsMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeOrderableDBInstanceOptionsCommand}.
  */
 export interface DescribeOrderableDBInstanceOptionsCommandOutput extends OrderableDBInstanceOptionsMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of orderable instance options for the specified engine.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeOrderableDBInstanceOptionsCommandInput - {@link DescribeOrderableDBInstanceOptionsCommandInput}
+ * @returns {@link DescribeOrderableDBInstanceOptionsCommandOutput}
  * @see {@link DescribeOrderableDBInstanceOptionsCommandInput} for command's `input` shape.
  * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -34,11 +41,20 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
 export declare class DescribeOrderableDBInstanceOptionsCommand extends $Command<DescribeOrderableDBInstanceOptionsCommandInput, DescribeOrderableDBInstanceOptionsCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribeOrderableDBInstanceOptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeOrderableDBInstanceOptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeOrderableDBInstanceOptionsCommandInput, DescribeOrderableDBInstanceOptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DescribePendingMaintenanceActionsMessage, PendingMaintenanceActionsMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribePendingMaintenanceActionsCommand}.
  */
 export interface DescribePendingMaintenanceActionsCommandInput extends DescribePendingMaintenanceActionsMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribePendingMaintenanceActionsCommand}.
  */
 export interface DescribePendingMaintenanceActionsCommandOutput extends PendingMaintenanceActionsMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of resources (for example, instances) that have at least one pending
  *             maintenance action.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribePendingMaintenanceActionsCommandInput - {@link DescribePendingMaintenanceActionsCommandInput}
+ * @returns {@link DescribePendingMaintenanceActionsCommandOutput}
  * @see {@link DescribePendingMaintenanceActionsCommandInput} for command's `input` shape.
  * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
 export declare class DescribePendingMaintenanceActionsCommand extends $Command<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput, DocDBClientResolvedConfig> {
     readonly input: DescribePendingMaintenanceActionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribePendingMaintenanceActionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { FailoverDBClusterMessage, FailoverDBClusterResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link FailoverDBClusterCommand}.
  */
 export interface FailoverDBClusterCommandInput extends FailoverDBClusterMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link FailoverDBClusterCommand}.
  */
 export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Forces a failover for a cluster.</p>
  *         <p>A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).</p>
  *         <p>If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.</p>
@@ -27,6 +32,8 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
  * const response = await client.send(command);
  * ```
  *
+ * @param FailoverDBClusterCommandInput - {@link FailoverDBClusterCommandInput}
+ * @returns {@link FailoverDBClusterCommandOutput}
  * @see {@link FailoverDBClusterCommandInput} for command's `input` shape.
  * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -47,11 +54,20 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
 export declare class FailoverDBClusterCommand extends $Command<FailoverDBClusterCommandInput, FailoverDBClusterCommandOutput, DocDBClientResolvedConfig> {
     readonly input: FailoverDBClusterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: FailoverDBClusterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<FailoverDBClusterCommandInput, FailoverDBClusterCommandOutput>;
+    /**
+     * @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 { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { ListTagsForResourceMessage, TagListMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends TagListMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all tags on an Amazon DocumentDB 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 TagListMessage, __Meta
  * 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 DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DocDBClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { ModifyDBClusterMessage, ModifyDBClusterResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ModifyDBClusterCommand}.
  */
 export interface ModifyDBClusterCommandInput extends ModifyDBClusterMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link ModifyDBClusterCommand}.
  */
 export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database
  *             configuration parameters by specifying these parameters and the new values in the
  *             request. </p>
@@ -27,6 +32,8 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param ModifyDBClusterCommandInput - {@link ModifyDBClusterCommandInput}
+ * @returns {@link ModifyDBClusterCommandOutput}
  * @see {@link ModifyDBClusterCommandInput} for command's `input` shape.
  * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -76,11 +83,20 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
 export declare class ModifyDBClusterCommand extends $Command<ModifyDBClusterCommandInput, ModifyDBClusterCommandOutput, DocDBClientResolvedConfig> {
     readonly input: ModifyDBClusterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ModifyDBClusterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyDBClusterCommandInput, ModifyDBClusterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
 import { DBClusterParameterGroupNameMessage, ModifyDBClusterParameterGroupMessage } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ModifyDBClusterParameterGroupCommand}.
  */
 export interface ModifyDBClusterParameterGroupCommandInput extends ModifyDBClusterParameterGroupMessage {
 }
 /**
+ * @public
+ *
  * The output of {@link ModifyDBClusterParameterGroupCommand}.
  */
 export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterParameterGroupNameMessage, __MetadataBearer {
 }
 /**
+ * @public
  * <p> Modifies the parameters of a cluster parameter group. To modify more than one
  *             parameter, submit a list of the following: <code>ParameterName</code>,
  *                 <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20
@@ -43,6 +48,8 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
  * const response = await client.send(command);
  * ```
  *
+ * @param ModifyDBClusterParameterGroupCommandInput - {@link ModifyDBClusterParameterGroupCommandInput}
+ * @returns {@link ModifyDBClusterParameterGroupCommandOutput}
  * @see {@link ModifyDBClusterParameterGroupCommandInput} for command's `input` shape.
  * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape.
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
 export declare class ModifyDBClusterParameterGroupCommand extends $Command<ModifyDBClusterParameterGroupCommandInput, ModifyDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
     readonly input: ModifyDBClusterParameterGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ModifyDBClusterParameterGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyDBClusterParameterGroupCommandInput, ModifyDBClusterParameterGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }