@aws-sdk/client-docdb 3.296.0 → 3.297.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 (74) hide show
  1. package/dist-cjs/protocols/Aws_query.js +135 -592
  2. package/dist-es/protocols/Aws_query.js +135 -592
  3. package/dist-types/DocDB.d.ts +54 -0
  4. package/dist-types/DocDBClient.d.ts +24 -4
  5. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +16 -0
  6. package/dist-types/commands/AddTagsToResourceCommand.d.ts +16 -0
  7. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +16 -0
  8. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateDBClusterCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateDBInstanceCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteDBClusterCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeCertificatesCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeDBClustersCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +16 -0
  40. package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -0
  41. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  42. package/dist-types/commands/ModifyDBClusterCommand.d.ts +16 -0
  43. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +16 -0
  44. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
  45. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +16 -0
  46. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +16 -0
  47. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +16 -0
  48. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +16 -0
  49. package/dist-types/commands/RebootDBInstanceCommand.d.ts +16 -0
  50. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +16 -0
  51. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +16 -0
  52. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  53. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +16 -0
  54. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +16 -0
  55. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +16 -0
  56. package/dist-types/commands/StartDBClusterCommand.d.ts +16 -0
  57. package/dist-types/commands/StopDBClusterCommand.d.ts +16 -0
  58. package/dist-types/models/DocDBServiceException.d.ts +2 -0
  59. package/dist-types/models/models_0.d.ts +274 -2
  60. package/dist-types/pagination/DescribeCertificatesPaginator.d.ts +3 -0
  61. package/dist-types/pagination/DescribeDBClusterParameterGroupsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/DescribeDBClusterParametersPaginator.d.ts +3 -0
  63. package/dist-types/pagination/DescribeDBClusterSnapshotsPaginator.d.ts +3 -0
  64. package/dist-types/pagination/DescribeDBClustersPaginator.d.ts +3 -0
  65. package/dist-types/pagination/DescribeDBEngineVersionsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/DescribeDBInstancesPaginator.d.ts +3 -0
  67. package/dist-types/pagination/DescribeDBSubnetGroupsPaginator.d.ts +3 -0
  68. package/dist-types/pagination/DescribeEventSubscriptionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/DescribeGlobalClustersPaginator.d.ts +3 -0
  71. package/dist-types/pagination/DescribeOrderableDBInstanceOptionsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/DescribePendingMaintenanceActionsPaginator.d.ts +3 -0
  73. package/dist-types/pagination/Interfaces.d.ts +3 -0
  74. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DeleteDBInstanceMessage, DeleteDBInstanceResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDBInstanceCommand}.
8
10
  */
9
11
  export interface DeleteDBInstanceCommandInput extends DeleteDBInstanceMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDBInstanceCommand}.
13
17
  */
14
18
  export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a previously provisioned instance.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDBInstanceCommandInput - {@link DeleteDBInstanceCommandInput}
34
+ * @returns {@link DeleteDBInstanceCommandOutput}
28
35
  * @see {@link DeleteDBInstanceCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
52
59
  export declare class DeleteDBInstanceCommand extends $Command<DeleteDBInstanceCommandInput, DeleteDBInstanceCommandOutput, DocDBClientResolvedConfig> {
53
60
  readonly input: DeleteDBInstanceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteDBInstanceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDBInstanceCommandInput, DeleteDBInstanceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DeleteDBSubnetGroupMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDBSubnetGroupCommand}.
8
10
  */
9
11
  export interface DeleteDBSubnetGroupCommandInput extends DeleteDBSubnetGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDBSubnetGroupCommand}.
13
17
  */
14
18
  export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a subnet group.</p>
18
23
  * <note>
19
24
  * <p>The specified database subnet group must not be associated with any DB
@@ -29,6 +34,8 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteDBSubnetGroupCommandInput - {@link DeleteDBSubnetGroupCommandInput}
38
+ * @returns {@link DeleteDBSubnetGroupCommandOutput}
32
39
  * @see {@link DeleteDBSubnetGroupCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape.
34
41
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
48
55
  export declare class DeleteDBSubnetGroupCommand extends $Command<DeleteDBSubnetGroupCommandInput, DeleteDBSubnetGroupCommandOutput, DocDBClientResolvedConfig> {
49
56
  readonly input: DeleteDBSubnetGroupCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteDBSubnetGroupCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDBSubnetGroupCommandInput, DeleteDBSubnetGroupCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DeleteEventSubscriptionMessage, DeleteEventSubscriptionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEventSubscriptionCommand}.
8
10
  */
9
11
  export interface DeleteEventSubscriptionCommandInput extends DeleteEventSubscriptionMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEventSubscriptionCommand}.
13
17
  */
14
18
  export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscriptionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Amazon DocumentDB event notification subscription.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteEventSubscriptionCommandInput - {@link DeleteEventSubscriptionCommandInput}
34
+ * @returns {@link DeleteEventSubscriptionCommandOutput}
28
35
  * @see {@link DeleteEventSubscriptionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
41
48
  export declare class DeleteEventSubscriptionCommand extends $Command<DeleteEventSubscriptionCommandInput, DeleteEventSubscriptionCommandOutput, DocDBClientResolvedConfig> {
42
49
  readonly input: DeleteEventSubscriptionCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DeleteEventSubscriptionCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEventSubscriptionCommandInput, DeleteEventSubscriptionCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DeleteGlobalClusterMessage, DeleteGlobalClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteGlobalClusterCommand}.
8
10
  */
9
11
  export interface DeleteGlobalClusterCommandInput extends DeleteGlobalClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteGlobalClusterCommand}.
13
17
  */
14
18
  export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p>
18
23
  * <note>
19
24
  * <p>This action only applies to Amazon DocumentDB clusters.</p>
@@ -28,6 +33,8 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteGlobalClusterCommandInput - {@link DeleteGlobalClusterCommandInput}
37
+ * @returns {@link DeleteGlobalClusterCommandOutput}
31
38
  * @see {@link DeleteGlobalClusterCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteGlobalClusterCommandOutput} for command's `response` shape.
33
40
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
43
50
  export declare class DeleteGlobalClusterCommand extends $Command<DeleteGlobalClusterCommandInput, DeleteGlobalClusterCommandOutput, DocDBClientResolvedConfig> {
44
51
  readonly input: DeleteGlobalClusterCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteGlobalClusterCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteGlobalClusterCommandInput, DeleteGlobalClusterCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CertificateMessage, DescribeCertificatesMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCertificatesCommand}.
8
10
  */
9
11
  export interface DescribeCertificatesCommandInput extends DescribeCertificatesMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCertificatesCommand}.
13
17
  */
14
18
  export interface DescribeCertificatesCommandOutput extends CertificateMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeCertificatesCommandInput - {@link DescribeCertificatesCommandInput}
34
+ * @returns {@link DescribeCertificatesCommandOutput}
28
35
  * @see {@link DescribeCertificatesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
38
45
  export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, DocDBClientResolvedConfig> {
39
46
  readonly input: DescribeCertificatesCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeCertificatesCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBClusterParameterGroupsMessage, DescribeDBClusterParameterGroupsMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBClusterParameterGroupsCommand}.
8
10
  */
9
11
  export interface DescribeDBClusterParameterGroupsCommandInput extends DescribeDBClusterParameterGroupsMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBClusterParameterGroupsCommand}.
13
17
  */
14
18
  export interface DescribeDBClusterParameterGroupsCommandOutput extends DBClusterParameterGroupsMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains only the description of the specified cluster parameter group. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDBClusterParameterGroupsCommandInput - {@link DescribeDBClusterParameterGroupsCommandInput}
34
+ * @returns {@link DescribeDBClusterParameterGroupsCommandOutput}
28
35
  * @see {@link DescribeDBClusterParameterGroupsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
38
45
  export declare class DescribeDBClusterParameterGroupsCommand extends $Command<DescribeDBClusterParameterGroupsCommandInput, DescribeDBClusterParameterGroupsCommandOutput, DocDBClientResolvedConfig> {
39
46
  readonly input: DescribeDBClusterParameterGroupsCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeDBClusterParameterGroupsCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBClusterParameterGroupsCommandInput, DescribeDBClusterParameterGroupsCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBClusterParameterGroupDetails, DescribeDBClusterParametersMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBClusterParametersCommand}.
8
10
  */
9
11
  export interface DescribeDBClusterParametersCommandInput extends DescribeDBClusterParametersMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBClusterParametersCommand}.
13
17
  */
14
18
  export interface DescribeDBClusterParametersCommandOutput extends DBClusterParameterGroupDetails, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the detailed parameter list for a particular cluster parameter
18
23
  * group.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeDBClusterParametersCommandInput - {@link DescribeDBClusterParametersCommandInput}
35
+ * @returns {@link DescribeDBClusterParametersCommandOutput}
29
36
  * @see {@link DescribeDBClusterParametersCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape.
31
38
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -39,11 +46,20 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
39
46
  export declare class DescribeDBClusterParametersCommand extends $Command<DescribeDBClusterParametersCommandInput, DescribeDBClusterParametersCommandOutput, DocDBClientResolvedConfig> {
40
47
  readonly input: DescribeDBClusterParametersCommandInput;
41
48
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
49
+ /**
50
+ * @public
51
+ */
42
52
  constructor(input: DescribeDBClusterParametersCommandInput);
43
53
  /**
44
54
  * @internal
45
55
  */
46
56
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBClusterParametersCommandInput, DescribeDBClusterParametersCommandOutput>;
57
+ /**
58
+ * @internal
59
+ */
47
60
  private serialize;
61
+ /**
62
+ * @internal
63
+ */
48
64
  private deserialize;
49
65
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DescribeDBClusterSnapshotAttributesMessage, DescribeDBClusterSnapshotAttributesResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBClusterSnapshotAttributesCommand}.
8
10
  */
9
11
  export interface DescribeDBClusterSnapshotAttributesCommandInput extends DescribeDBClusterSnapshotAttributesMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBClusterSnapshotAttributesCommand}.
13
17
  */
14
18
  export interface DescribeDBClusterSnapshotAttributesCommandOutput extends DescribeDBClusterSnapshotAttributesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of cluster snapshot attribute names and values for a manual DB
18
23
  * cluster snapshot.</p>
19
24
  * <p>When you share snapshots with other Amazon Web Services accounts,
@@ -28,6 +33,8 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeDBClusterSnapshotAttributesCommandInput - {@link DescribeDBClusterSnapshotAttributesCommandInput}
37
+ * @returns {@link DescribeDBClusterSnapshotAttributesCommandOutput}
31
38
  * @see {@link DescribeDBClusterSnapshotAttributesCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape.
33
40
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
41
48
  export declare class DescribeDBClusterSnapshotAttributesCommand extends $Command<DescribeDBClusterSnapshotAttributesCommandInput, DescribeDBClusterSnapshotAttributesCommandOutput, DocDBClientResolvedConfig> {
42
49
  readonly input: DescribeDBClusterSnapshotAttributesCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DescribeDBClusterSnapshotAttributesCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBClusterSnapshotAttributesCommandInput, DescribeDBClusterSnapshotAttributesCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBClusterSnapshotMessage, DescribeDBClusterSnapshotsMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBClusterSnapshotsCommand}.
8
10
  */
9
11
  export interface DescribeDBClusterSnapshotsCommandInput extends DescribeDBClusterSnapshotsMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBClusterSnapshotsCommand}.
13
17
  */
14
18
  export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapshotMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about cluster snapshots. This API operation supports pagination.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDBClusterSnapshotsCommandInput - {@link DescribeDBClusterSnapshotsCommandInput}
34
+ * @returns {@link DescribeDBClusterSnapshotsCommandOutput}
28
35
  * @see {@link DescribeDBClusterSnapshotsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
38
45
  export declare class DescribeDBClusterSnapshotsCommand extends $Command<DescribeDBClusterSnapshotsCommandInput, DescribeDBClusterSnapshotsCommandOutput, DocDBClientResolvedConfig> {
39
46
  readonly input: DescribeDBClusterSnapshotsCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeDBClusterSnapshotsCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBClusterSnapshotsCommandInput, DescribeDBClusterSnapshotsCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBClusterMessage, DescribeDBClustersMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBClustersCommand}.
8
10
  */
9
11
  export interface DescribeDBClustersCommandInput extends DescribeDBClustersMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBClustersCommand}.
13
17
  */
14
18
  export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about provisioned Amazon DocumentDB clusters. This API
18
23
  * operation supports pagination. For certain management features
19
24
  * such as cluster and instance lifecycle management, Amazon DocumentDB leverages
@@ -30,6 +35,8 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeDBClustersCommandInput - {@link DescribeDBClustersCommandInput}
39
+ * @returns {@link DescribeDBClustersCommandOutput}
33
40
  * @see {@link DescribeDBClustersCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape.
35
42
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
43
50
  export declare class DescribeDBClustersCommand extends $Command<DescribeDBClustersCommandInput, DescribeDBClustersCommandOutput, DocDBClientResolvedConfig> {
44
51
  readonly input: DescribeDBClustersCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeDBClustersCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBClustersCommandInput, DescribeDBClustersCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBEngineVersionMessage, DescribeDBEngineVersionsMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBEngineVersionsCommand}.
8
10
  */
9
11
  export interface DescribeDBEngineVersionsCommandInput extends DescribeDBEngineVersionsMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBEngineVersionsCommand}.
13
17
  */
14
18
  export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the available engines.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDBEngineVersionsCommandInput - {@link DescribeDBEngineVersionsCommandInput}
34
+ * @returns {@link DescribeDBEngineVersionsCommandOutput}
28
35
  * @see {@link DescribeDBEngineVersionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -34,11 +41,20 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
34
41
  export declare class DescribeDBEngineVersionsCommand extends $Command<DescribeDBEngineVersionsCommandInput, DescribeDBEngineVersionsCommandOutput, DocDBClientResolvedConfig> {
35
42
  readonly input: DescribeDBEngineVersionsCommandInput;
36
43
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
44
+ /**
45
+ * @public
46
+ */
37
47
  constructor(input: DescribeDBEngineVersionsCommandInput);
38
48
  /**
39
49
  * @internal
40
50
  */
41
51
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBEngineVersionsCommandInput, DescribeDBEngineVersionsCommandOutput>;
52
+ /**
53
+ * @internal
54
+ */
42
55
  private serialize;
56
+ /**
57
+ * @internal
58
+ */
43
59
  private deserialize;
44
60
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DBInstanceMessage, DescribeDBInstancesMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDBInstancesCommand}.
8
10
  */
9
11
  export interface DescribeDBInstancesCommandInput extends DescribeDBInstancesMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDBInstancesCommand}.
13
17
  */
14
18
  export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDBInstancesCommandInput - {@link DescribeDBInstancesCommandInput}
34
+ * @returns {@link DescribeDBInstancesCommandOutput}
28
35
  * @see {@link DescribeDBInstancesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M
38
45
  export declare class DescribeDBInstancesCommand extends $Command<DescribeDBInstancesCommandInput, DescribeDBInstancesCommandOutput, DocDBClientResolvedConfig> {
39
46
  readonly input: DescribeDBInstancesCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeDBInstancesCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDBInstancesCommandInput, DescribeDBInstancesCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }