@aws-sdk/client-docdb 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/dist-cjs/commands/AddSourceIdentifierToSubscriptionCommand.js +2 -3
  2. package/dist-cjs/commands/AddTagsToResourceCommand.js +2 -3
  3. package/dist-cjs/commands/ApplyPendingMaintenanceActionCommand.js +2 -3
  4. package/dist-cjs/commands/CopyDBClusterParameterGroupCommand.js +2 -3
  5. package/dist-cjs/commands/CopyDBClusterSnapshotCommand.js +2 -3
  6. package/dist-cjs/commands/CreateDBClusterCommand.js +2 -3
  7. package/dist-cjs/commands/CreateDBClusterParameterGroupCommand.js +2 -3
  8. package/dist-cjs/commands/CreateDBClusterSnapshotCommand.js +2 -3
  9. package/dist-cjs/commands/CreateDBInstanceCommand.js +2 -3
  10. package/dist-cjs/commands/CreateDBSubnetGroupCommand.js +2 -3
  11. package/dist-cjs/commands/CreateEventSubscriptionCommand.js +2 -3
  12. package/dist-cjs/commands/CreateGlobalClusterCommand.js +2 -3
  13. package/dist-cjs/commands/DeleteDBClusterCommand.js +2 -3
  14. package/dist-cjs/commands/DeleteDBClusterParameterGroupCommand.js +2 -3
  15. package/dist-cjs/commands/DeleteDBClusterSnapshotCommand.js +2 -3
  16. package/dist-cjs/commands/DeleteDBInstanceCommand.js +2 -3
  17. package/dist-cjs/commands/DeleteDBSubnetGroupCommand.js +2 -3
  18. package/dist-cjs/commands/DeleteEventSubscriptionCommand.js +2 -3
  19. package/dist-cjs/commands/DeleteGlobalClusterCommand.js +2 -3
  20. package/dist-cjs/commands/DescribeCertificatesCommand.js +2 -3
  21. package/dist-cjs/commands/DescribeDBClusterParameterGroupsCommand.js +2 -3
  22. package/dist-cjs/commands/DescribeDBClusterParametersCommand.js +2 -3
  23. package/dist-cjs/commands/DescribeDBClusterSnapshotAttributesCommand.js +2 -3
  24. package/dist-cjs/commands/DescribeDBClusterSnapshotsCommand.js +2 -3
  25. package/dist-cjs/commands/DescribeDBClustersCommand.js +2 -3
  26. package/dist-cjs/commands/DescribeDBEngineVersionsCommand.js +2 -3
  27. package/dist-cjs/commands/DescribeDBInstancesCommand.js +2 -3
  28. package/dist-cjs/commands/DescribeDBSubnetGroupsCommand.js +2 -3
  29. package/dist-cjs/commands/DescribeEngineDefaultClusterParametersCommand.js +2 -3
  30. package/dist-cjs/commands/DescribeEventCategoriesCommand.js +2 -3
  31. package/dist-cjs/commands/DescribeEventSubscriptionsCommand.js +2 -3
  32. package/dist-cjs/commands/DescribeEventsCommand.js +2 -3
  33. package/dist-cjs/commands/DescribeGlobalClustersCommand.js +2 -3
  34. package/dist-cjs/commands/DescribeOrderableDBInstanceOptionsCommand.js +2 -3
  35. package/dist-cjs/commands/DescribePendingMaintenanceActionsCommand.js +2 -3
  36. package/dist-cjs/commands/FailoverDBClusterCommand.js +2 -3
  37. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  38. package/dist-cjs/commands/ModifyDBClusterCommand.js +2 -3
  39. package/dist-cjs/commands/ModifyDBClusterParameterGroupCommand.js +2 -3
  40. package/dist-cjs/commands/ModifyDBClusterSnapshotAttributeCommand.js +2 -3
  41. package/dist-cjs/commands/ModifyDBInstanceCommand.js +2 -3
  42. package/dist-cjs/commands/ModifyDBSubnetGroupCommand.js +2 -3
  43. package/dist-cjs/commands/ModifyEventSubscriptionCommand.js +2 -3
  44. package/dist-cjs/commands/ModifyGlobalClusterCommand.js +2 -3
  45. package/dist-cjs/commands/RebootDBInstanceCommand.js +2 -3
  46. package/dist-cjs/commands/RemoveFromGlobalClusterCommand.js +2 -3
  47. package/dist-cjs/commands/RemoveSourceIdentifierFromSubscriptionCommand.js +2 -3
  48. package/dist-cjs/commands/RemoveTagsFromResourceCommand.js +2 -3
  49. package/dist-cjs/commands/ResetDBClusterParameterGroupCommand.js +2 -3
  50. package/dist-cjs/commands/RestoreDBClusterFromSnapshotCommand.js +2 -3
  51. package/dist-cjs/commands/RestoreDBClusterToPointInTimeCommand.js +2 -3
  52. package/dist-cjs/commands/StartDBClusterCommand.js +2 -3
  53. package/dist-cjs/commands/StopDBClusterCommand.js +2 -3
  54. package/dist-cjs/models/models_0.js +1 -535
  55. package/dist-cjs/protocols/Aws_query.js +135 -592
  56. package/dist-es/commands/AddSourceIdentifierToSubscriptionCommand.js +2 -3
  57. package/dist-es/commands/AddTagsToResourceCommand.js +2 -3
  58. package/dist-es/commands/ApplyPendingMaintenanceActionCommand.js +2 -3
  59. package/dist-es/commands/CopyDBClusterParameterGroupCommand.js +2 -3
  60. package/dist-es/commands/CopyDBClusterSnapshotCommand.js +2 -3
  61. package/dist-es/commands/CreateDBClusterCommand.js +2 -3
  62. package/dist-es/commands/CreateDBClusterParameterGroupCommand.js +2 -3
  63. package/dist-es/commands/CreateDBClusterSnapshotCommand.js +2 -3
  64. package/dist-es/commands/CreateDBInstanceCommand.js +2 -3
  65. package/dist-es/commands/CreateDBSubnetGroupCommand.js +2 -3
  66. package/dist-es/commands/CreateEventSubscriptionCommand.js +2 -3
  67. package/dist-es/commands/CreateGlobalClusterCommand.js +2 -3
  68. package/dist-es/commands/DeleteDBClusterCommand.js +2 -3
  69. package/dist-es/commands/DeleteDBClusterParameterGroupCommand.js +2 -3
  70. package/dist-es/commands/DeleteDBClusterSnapshotCommand.js +2 -3
  71. package/dist-es/commands/DeleteDBInstanceCommand.js +2 -3
  72. package/dist-es/commands/DeleteDBSubnetGroupCommand.js +2 -3
  73. package/dist-es/commands/DeleteEventSubscriptionCommand.js +2 -3
  74. package/dist-es/commands/DeleteGlobalClusterCommand.js +2 -3
  75. package/dist-es/commands/DescribeCertificatesCommand.js +2 -3
  76. package/dist-es/commands/DescribeDBClusterParameterGroupsCommand.js +2 -3
  77. package/dist-es/commands/DescribeDBClusterParametersCommand.js +2 -3
  78. package/dist-es/commands/DescribeDBClusterSnapshotAttributesCommand.js +2 -3
  79. package/dist-es/commands/DescribeDBClusterSnapshotsCommand.js +2 -3
  80. package/dist-es/commands/DescribeDBClustersCommand.js +2 -3
  81. package/dist-es/commands/DescribeDBEngineVersionsCommand.js +2 -3
  82. package/dist-es/commands/DescribeDBInstancesCommand.js +2 -3
  83. package/dist-es/commands/DescribeDBSubnetGroupsCommand.js +2 -3
  84. package/dist-es/commands/DescribeEngineDefaultClusterParametersCommand.js +2 -3
  85. package/dist-es/commands/DescribeEventCategoriesCommand.js +2 -3
  86. package/dist-es/commands/DescribeEventSubscriptionsCommand.js +2 -3
  87. package/dist-es/commands/DescribeEventsCommand.js +2 -3
  88. package/dist-es/commands/DescribeGlobalClustersCommand.js +2 -3
  89. package/dist-es/commands/DescribeOrderableDBInstanceOptionsCommand.js +2 -3
  90. package/dist-es/commands/DescribePendingMaintenanceActionsCommand.js +2 -3
  91. package/dist-es/commands/FailoverDBClusterCommand.js +2 -3
  92. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  93. package/dist-es/commands/ModifyDBClusterCommand.js +2 -3
  94. package/dist-es/commands/ModifyDBClusterParameterGroupCommand.js +2 -3
  95. package/dist-es/commands/ModifyDBClusterSnapshotAttributeCommand.js +2 -3
  96. package/dist-es/commands/ModifyDBInstanceCommand.js +2 -3
  97. package/dist-es/commands/ModifyDBSubnetGroupCommand.js +2 -3
  98. package/dist-es/commands/ModifyEventSubscriptionCommand.js +2 -3
  99. package/dist-es/commands/ModifyGlobalClusterCommand.js +2 -3
  100. package/dist-es/commands/RebootDBInstanceCommand.js +2 -3
  101. package/dist-es/commands/RemoveFromGlobalClusterCommand.js +2 -3
  102. package/dist-es/commands/RemoveSourceIdentifierFromSubscriptionCommand.js +2 -3
  103. package/dist-es/commands/RemoveTagsFromResourceCommand.js +2 -3
  104. package/dist-es/commands/ResetDBClusterParameterGroupCommand.js +2 -3
  105. package/dist-es/commands/RestoreDBClusterFromSnapshotCommand.js +2 -3
  106. package/dist-es/commands/RestoreDBClusterToPointInTimeCommand.js +2 -3
  107. package/dist-es/commands/StartDBClusterCommand.js +2 -3
  108. package/dist-es/commands/StopDBClusterCommand.js +2 -3
  109. package/dist-es/models/models_0.js +0 -399
  110. package/dist-es/protocols/Aws_query.js +135 -592
  111. package/dist-types/DocDB.d.ts +54 -0
  112. package/dist-types/DocDBClient.d.ts +24 -4
  113. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +16 -0
  114. package/dist-types/commands/AddTagsToResourceCommand.d.ts +16 -0
  115. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +16 -0
  116. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +16 -0
  117. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +16 -0
  118. package/dist-types/commands/CreateDBClusterCommand.d.ts +16 -0
  119. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +16 -0
  120. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +16 -0
  121. package/dist-types/commands/CreateDBInstanceCommand.d.ts +16 -0
  122. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +16 -0
  123. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +16 -0
  124. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +16 -0
  125. package/dist-types/commands/DeleteDBClusterCommand.d.ts +16 -0
  126. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +16 -0
  127. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +16 -0
  128. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +16 -0
  129. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +16 -0
  130. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +16 -0
  131. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +16 -0
  132. package/dist-types/commands/DescribeCertificatesCommand.d.ts +16 -0
  133. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +16 -0
  134. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +16 -0
  135. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  136. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +16 -0
  137. package/dist-types/commands/DescribeDBClustersCommand.d.ts +16 -0
  138. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +16 -0
  139. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +16 -0
  140. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +16 -0
  141. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +16 -0
  142. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +16 -0
  143. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +16 -0
  144. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  145. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +16 -0
  146. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +16 -0
  147. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +16 -0
  148. package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -0
  149. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  150. package/dist-types/commands/ModifyDBClusterCommand.d.ts +16 -0
  151. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +16 -0
  152. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
  153. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +16 -0
  154. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +16 -0
  155. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +16 -0
  156. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +16 -0
  157. package/dist-types/commands/RebootDBInstanceCommand.d.ts +16 -0
  158. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +16 -0
  159. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +16 -0
  160. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  161. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +16 -0
  162. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +16 -0
  163. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +16 -0
  164. package/dist-types/commands/StartDBClusterCommand.d.ts +16 -0
  165. package/dist-types/commands/StopDBClusterCommand.d.ts +16 -0
  166. package/dist-types/models/DocDBServiceException.d.ts +2 -0
  167. package/dist-types/models/models_0.d.ts +274 -534
  168. package/dist-types/pagination/DescribeCertificatesPaginator.d.ts +3 -0
  169. package/dist-types/pagination/DescribeDBClusterParameterGroupsPaginator.d.ts +3 -0
  170. package/dist-types/pagination/DescribeDBClusterParametersPaginator.d.ts +3 -0
  171. package/dist-types/pagination/DescribeDBClusterSnapshotsPaginator.d.ts +3 -0
  172. package/dist-types/pagination/DescribeDBClustersPaginator.d.ts +3 -0
  173. package/dist-types/pagination/DescribeDBEngineVersionsPaginator.d.ts +3 -0
  174. package/dist-types/pagination/DescribeDBInstancesPaginator.d.ts +3 -0
  175. package/dist-types/pagination/DescribeDBSubnetGroupsPaginator.d.ts +3 -0
  176. package/dist-types/pagination/DescribeEventSubscriptionsPaginator.d.ts +3 -0
  177. package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
  178. package/dist-types/pagination/DescribeGlobalClustersPaginator.d.ts +3 -0
  179. package/dist-types/pagination/DescribeOrderableDBInstanceOptionsPaginator.d.ts +3 -0
  180. package/dist-types/pagination/DescribePendingMaintenanceActionsPaginator.d.ts +3 -0
  181. package/dist-types/pagination/Interfaces.d.ts +3 -0
  182. package/dist-types/ts3.4/models/models_0.d.ts +0 -381
  183. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { StartDBClusterMessage, StartDBClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartDBClusterCommand}.
8
10
  */
9
11
  export interface StartDBClusterCommandInput extends StartDBClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartDBClusterCommand}.
13
17
  */
14
18
  export interface StartDBClusterCommandOutput extends StartDBClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Restarts the stopped cluster that is specified by <code>DBClusterIdentifier</code>.
18
23
  * For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
19
24
  * Starting an Amazon DocumentDB Cluster</a>.</p>
@@ -27,6 +32,8 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param StartDBClusterCommandInput - {@link StartDBClusterCommandInput}
36
+ * @returns {@link StartDBClusterCommandOutput}
30
37
  * @see {@link StartDBClusterCommandInput} for command's `input` shape.
31
38
  * @see {@link StartDBClusterCommandOutput} for command's `response` shape.
32
39
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -47,11 +54,20 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
47
54
  export declare class StartDBClusterCommand extends $Command<StartDBClusterCommandInput, StartDBClusterCommandOutput, DocDBClientResolvedConfig> {
48
55
  readonly input: StartDBClusterCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: StartDBClusterCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDBClusterCommandInput, StartDBClusterCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { StopDBClusterMessage, StopDBClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopDBClusterCommand}.
8
10
  */
9
11
  export interface StopDBClusterCommandInput extends StopDBClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopDBClusterCommand}.
13
17
  */
14
18
  export interface StopDBClusterCommandOutput extends StopDBClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops the running cluster that is specified by <code>DBClusterIdentifier</code>. The
18
23
  * cluster must be in the <i>available</i> state. For more information, see
19
24
  * <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
@@ -28,6 +33,8 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param StopDBClusterCommandInput - {@link StopDBClusterCommandInput}
37
+ * @returns {@link StopDBClusterCommandOutput}
31
38
  * @see {@link StopDBClusterCommandInput} for command's `input` shape.
32
39
  * @see {@link StopDBClusterCommandOutput} for command's `response` shape.
33
40
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -48,11 +55,20 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
48
55
  export declare class StopDBClusterCommand extends $Command<StopDBClusterCommandInput, StopDBClusterCommandOutput, DocDBClientResolvedConfig> {
49
56
  readonly input: StopDBClusterCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: StopDBClusterCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopDBClusterCommandInput, StopDBClusterCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from DocDB service.
4
6
  */
5
7
  export declare class DocDBServiceException extends __ServiceException {