@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 { CopyDBClusterParameterGroupMessage, CopyDBClusterParameterGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CopyDBClusterParameterGroupCommand}.
8
10
  */
9
11
  export interface CopyDBClusterParameterGroupCommandInput extends CopyDBClusterParameterGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CopyDBClusterParameterGroupCommand}.
13
17
  */
14
18
  export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterParameterGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Copies 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 CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CopyDBClusterParameterGroupCommandInput - {@link CopyDBClusterParameterGroupCommandInput}
34
+ * @returns {@link CopyDBClusterParameterGroupCommandOutput}
28
35
  * @see {@link CopyDBClusterParameterGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -44,11 +51,20 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
44
51
  export declare class CopyDBClusterParameterGroupCommand extends $Command<CopyDBClusterParameterGroupCommandInput, CopyDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
45
52
  readonly input: CopyDBClusterParameterGroupCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: CopyDBClusterParameterGroupCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CopyDBClusterParameterGroupCommandInput, CopyDBClusterParameterGroupCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CopyDBClusterSnapshotMessage, CopyDBClusterSnapshotResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CopyDBClusterSnapshotCommand}.
8
10
  */
9
11
  export interface CopyDBClusterSnapshotCommandInput extends CopyDBClusterSnapshotMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CopyDBClusterSnapshotCommand}.
13
17
  */
14
18
  export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapshotResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Copies a snapshot of a cluster.</p>
18
23
  *
19
24
  * <p>To copy a cluster snapshot from a shared manual cluster snapshot,
@@ -36,6 +41,8 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CopyDBClusterSnapshotCommandInput - {@link CopyDBClusterSnapshotCommandInput}
45
+ * @returns {@link CopyDBClusterSnapshotCommandOutput}
39
46
  * @see {@link CopyDBClusterSnapshotCommandInput} for command's `input` shape.
40
47
  * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape.
41
48
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -64,11 +71,20 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
64
71
  export declare class CopyDBClusterSnapshotCommand extends $Command<CopyDBClusterSnapshotCommandInput, CopyDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {
65
72
  readonly input: CopyDBClusterSnapshotCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: CopyDBClusterSnapshotCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CopyDBClusterSnapshotCommandInput, CopyDBClusterSnapshotCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateDBClusterMessage, CreateDBClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDBClusterCommand}.
8
10
  */
9
11
  export interface CreateDBClusterCommandInput extends CreateDBClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDBClusterCommand}.
13
17
  */
14
18
  export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Amazon DocumentDB cluster.</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 CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDBClusterCommandInput - {@link CreateDBClusterCommandInput}
34
+ * @returns {@link CreateDBClusterCommandOutput}
28
35
  * @see {@link CreateDBClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDBClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -93,11 +100,20 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
93
100
  export declare class CreateDBClusterCommand extends $Command<CreateDBClusterCommandInput, CreateDBClusterCommandOutput, DocDBClientResolvedConfig> {
94
101
  readonly input: CreateDBClusterCommandInput;
95
102
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
103
+ /**
104
+ * @public
105
+ */
96
106
  constructor(input: CreateDBClusterCommandInput);
97
107
  /**
98
108
  * @internal
99
109
  */
100
110
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDBClusterCommandInput, CreateDBClusterCommandOutput>;
111
+ /**
112
+ * @internal
113
+ */
101
114
  private serialize;
115
+ /**
116
+ * @internal
117
+ */
102
118
  private deserialize;
103
119
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateDBClusterParameterGroupMessage, CreateDBClusterParameterGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDBClusterParameterGroupCommand}.
8
10
  */
9
11
  export interface CreateDBClusterParameterGroupCommandInput extends CreateDBClusterParameterGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDBClusterParameterGroupCommand}.
13
17
  */
14
18
  export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClusterParameterGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new cluster parameter group.</p>
18
23
  * <p>Parameters in a cluster parameter group apply to all of the
19
24
  * instances in a cluster.</p>
@@ -43,6 +48,8 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param CreateDBClusterParameterGroupCommandInput - {@link CreateDBClusterParameterGroupCommandInput}
52
+ * @returns {@link CreateDBClusterParameterGroupCommandOutput}
46
53
  * @see {@link CreateDBClusterParameterGroupCommandInput} for command's `input` shape.
47
54
  * @see {@link CreateDBClusterParameterGroupCommandOutput} for command's `response` shape.
48
55
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -58,11 +65,20 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
58
65
  export declare class CreateDBClusterParameterGroupCommand extends $Command<CreateDBClusterParameterGroupCommandInput, CreateDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
59
66
  readonly input: CreateDBClusterParameterGroupCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: CreateDBClusterParameterGroupCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDBClusterParameterGroupCommandInput, CreateDBClusterParameterGroupCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateDBClusterSnapshotMessage, CreateDBClusterSnapshotResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDBClusterSnapshotCommand}.
8
10
  */
9
11
  export interface CreateDBClusterSnapshotCommandInput extends CreateDBClusterSnapshotMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDBClusterSnapshotCommand}.
13
17
  */
14
18
  export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSnapshotResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a snapshot of a cluster. </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 CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDBClusterSnapshotCommandInput - {@link CreateDBClusterSnapshotCommandInput}
34
+ * @returns {@link CreateDBClusterSnapshotCommandOutput}
28
35
  * @see {@link CreateDBClusterSnapshotCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDBClusterSnapshotCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -50,11 +57,20 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
50
57
  export declare class CreateDBClusterSnapshotCommand extends $Command<CreateDBClusterSnapshotCommandInput, CreateDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {
51
58
  readonly input: CreateDBClusterSnapshotCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: CreateDBClusterSnapshotCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDBClusterSnapshotCommandInput, CreateDBClusterSnapshotCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateDBInstanceMessage, CreateDBInstanceResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDBInstanceCommand}.
8
10
  */
9
11
  export interface CreateDBInstanceCommandInput extends CreateDBInstanceMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDBInstanceCommand}.
13
17
  */
14
18
  export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new 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 CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDBInstanceCommandInput - {@link CreateDBInstanceCommandInput}
34
+ * @returns {@link CreateDBInstanceCommandOutput}
28
35
  * @see {@link CreateDBInstanceCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDBInstanceCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -88,11 +95,20 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
88
95
  export declare class CreateDBInstanceCommand extends $Command<CreateDBInstanceCommandInput, CreateDBInstanceCommandOutput, DocDBClientResolvedConfig> {
89
96
  readonly input: CreateDBInstanceCommandInput;
90
97
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
98
+ /**
99
+ * @public
100
+ */
91
101
  constructor(input: CreateDBInstanceCommandInput);
92
102
  /**
93
103
  * @internal
94
104
  */
95
105
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDBInstanceCommandInput, CreateDBInstanceCommandOutput>;
106
+ /**
107
+ * @internal
108
+ */
96
109
  private serialize;
110
+ /**
111
+ * @internal
112
+ */
97
113
  private deserialize;
98
114
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateDBSubnetGroupMessage, CreateDBSubnetGroupResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDBSubnetGroupCommand}.
8
10
  */
9
11
  export interface CreateDBSubnetGroupCommandInput extends CreateDBSubnetGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDBSubnetGroupCommand}.
13
17
  */
14
18
  export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new subnet group. subnet groups must contain at least one subnet in at
18
23
  * least two Availability Zones in the Amazon Web Services Region.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateDBSubnetGroupCommandInput - {@link CreateDBSubnetGroupCommandInput}
35
+ * @returns {@link CreateDBSubnetGroupCommandOutput}
29
36
  * @see {@link CreateDBSubnetGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateDBSubnetGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes
52
59
  export declare class CreateDBSubnetGroupCommand extends $Command<CreateDBSubnetGroupCommandInput, CreateDBSubnetGroupCommandOutput, DocDBClientResolvedConfig> {
53
60
  readonly input: CreateDBSubnetGroupCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateDBSubnetGroupCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDBSubnetGroupCommandInput, CreateDBSubnetGroupCommandOutput>;
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 { CreateEventSubscriptionMessage, CreateEventSubscriptionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateEventSubscriptionCommand}.
8
10
  */
9
11
  export interface CreateEventSubscriptionCommandInput extends CreateEventSubscriptionMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateEventSubscriptionCommand}.
13
17
  */
14
18
  export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscriptionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.</p>
18
23
  * <p>You can specify the type of source (<code>SourceType</code>) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (<code>SourceIds</code>) that trigger the events, and you can provide a list of event categories (<code>EventCategories</code>) for events that you want to be notified of. For example, you can specify <code>SourceType = db-instance</code>, <code>SourceIds = mydbinstance1, mydbinstance2</code> and <code>EventCategories = Availability, Backup</code>.</p>
19
24
  * <p>If you specify both the <code>SourceType</code> and <code>SourceIds</code> (such as <code>SourceType = db-instance</code> and <code>SourceIdentifier = myDBInstance1</code>), you are notified of all the <code>db-instance</code> events for the specified source. If you specify a <code>SourceType</code> but do not specify a <code>SourceIdentifier</code>, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the <code>SourceType</code> or the <code>SourceIdentifier</code>, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.</p>
@@ -27,6 +32,8 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateEventSubscriptionCommandInput - {@link CreateEventSubscriptionCommandInput}
36
+ * @returns {@link CreateEventSubscriptionCommandOutput}
30
37
  * @see {@link CreateEventSubscriptionCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape.
32
39
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
57
64
  export declare class CreateEventSubscriptionCommand extends $Command<CreateEventSubscriptionCommandInput, CreateEventSubscriptionCommandOutput, DocDBClientResolvedConfig> {
58
65
  readonly input: CreateEventSubscriptionCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateEventSubscriptionCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEventSubscriptionCommandInput, CreateEventSubscriptionCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { CreateGlobalClusterMessage, CreateGlobalClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGlobalClusterCommand}.
8
10
  */
9
11
  export interface CreateGlobalClusterCommandInput extends CreateGlobalClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGlobalClusterCommand}.
13
17
  */
14
18
  export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.</p>
18
23
  * <p></p>
19
24
  * <p>You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. </p>
@@ -30,6 +35,8 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CreateGlobalClusterCommandInput - {@link CreateGlobalClusterCommandInput}
39
+ * @returns {@link CreateGlobalClusterCommandOutput}
33
40
  * @see {@link CreateGlobalClusterCommandInput} for command's `input` shape.
34
41
  * @see {@link CreateGlobalClusterCommandOutput} for command's `response` shape.
35
42
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
52
59
  export declare class CreateGlobalClusterCommand extends $Command<CreateGlobalClusterCommandInput, CreateGlobalClusterCommandOutput, DocDBClientResolvedConfig> {
53
60
  readonly input: CreateGlobalClusterCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateGlobalClusterCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGlobalClusterCommandInput, CreateGlobalClusterCommandOutput>;
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 { DeleteDBClusterMessage, DeleteDBClusterResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDBClusterCommand}.
8
10
  */
9
11
  export interface DeleteDBClusterCommandInput extends DeleteDBClusterMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDBClusterCommand}.
13
17
  */
14
18
  export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.</p>
18
23
  * <p></p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteDBClusterCommandInput - {@link DeleteDBClusterCommandInput}
35
+ * @returns {@link DeleteDBClusterCommandOutput}
29
36
  * @see {@link DeleteDBClusterCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape.
31
38
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
51
58
  export declare class DeleteDBClusterCommand extends $Command<DeleteDBClusterCommandInput, DeleteDBClusterCommandOutput, DocDBClientResolvedConfig> {
52
59
  readonly input: DeleteDBClusterCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteDBClusterCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDBClusterCommandInput, DeleteDBClusterCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
5
5
  import { DeleteDBClusterParameterGroupMessage } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDBClusterParameterGroupCommand}.
8
10
  */
9
11
  export interface DeleteDBClusterParameterGroupCommandInput extends DeleteDBClusterParameterGroupMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDBClusterParameterGroupCommand}.
13
17
  */
14
18
  export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</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 DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDBClusterParameterGroupCommandInput - {@link DeleteDBClusterParameterGroupCommandInput}
34
+ * @returns {@link DeleteDBClusterParameterGroupCommandOutput}
28
35
  * @see {@link DeleteDBClusterParameterGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
41
48
  export declare class DeleteDBClusterParameterGroupCommand extends $Command<DeleteDBClusterParameterGroupCommandInput, DeleteDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
42
49
  readonly input: DeleteDBClusterParameterGroupCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DeleteDBClusterParameterGroupCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDBClusterParameterGroupCommandInput, DeleteDBClusterParameterGroupCommandOutput>;
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 { DeleteDBClusterSnapshotMessage, DeleteDBClusterSnapshotResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDBClusterSnapshotCommand}.
8
10
  */
9
11
  export interface DeleteDBClusterSnapshotCommandInput extends DeleteDBClusterSnapshotMessage {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDBClusterSnapshotCommand}.
13
17
  */
14
18
  export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSnapshotResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
18
23
  * <note>
19
24
  * <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p>
@@ -28,6 +33,8 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteDBClusterSnapshotCommandInput - {@link DeleteDBClusterSnapshotCommandInput}
37
+ * @returns {@link DeleteDBClusterSnapshotCommandOutput}
31
38
  * @see {@link DeleteDBClusterSnapshotCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape.
33
40
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
44
51
  export declare class DeleteDBClusterSnapshotCommand extends $Command<DeleteDBClusterSnapshotCommandInput, DeleteDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {
45
52
  readonly input: DeleteDBClusterSnapshotCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DeleteDBClusterSnapshotCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDBClusterSnapshotCommandInput, DeleteDBClusterSnapshotCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }