@aws-sdk/client-docdb-elastic 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 (50) hide show
  1. package/dist-cjs/commands/CreateClusterCommand.js +1 -1
  2. package/dist-cjs/commands/CreateClusterSnapshotCommand.js +2 -3
  3. package/dist-cjs/commands/DeleteClusterCommand.js +2 -3
  4. package/dist-cjs/commands/DeleteClusterSnapshotCommand.js +2 -3
  5. package/dist-cjs/commands/GetClusterCommand.js +2 -3
  6. package/dist-cjs/commands/GetClusterSnapshotCommand.js +2 -3
  7. package/dist-cjs/commands/ListClusterSnapshotsCommand.js +2 -3
  8. package/dist-cjs/commands/ListClustersCommand.js +2 -3
  9. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  10. package/dist-cjs/commands/RestoreClusterFromSnapshotCommand.js +2 -3
  11. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  12. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  13. package/dist-cjs/commands/UpdateClusterCommand.js +1 -1
  14. package/dist-cjs/models/models_0.js +1 -117
  15. package/dist-es/commands/CreateClusterCommand.js +2 -2
  16. package/dist-es/commands/CreateClusterSnapshotCommand.js +2 -3
  17. package/dist-es/commands/DeleteClusterCommand.js +2 -3
  18. package/dist-es/commands/DeleteClusterSnapshotCommand.js +2 -3
  19. package/dist-es/commands/GetClusterCommand.js +2 -3
  20. package/dist-es/commands/GetClusterSnapshotCommand.js +2 -3
  21. package/dist-es/commands/ListClusterSnapshotsCommand.js +2 -3
  22. package/dist-es/commands/ListClustersCommand.js +2 -3
  23. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  24. package/dist-es/commands/RestoreClusterFromSnapshotCommand.js +2 -3
  25. package/dist-es/commands/TagResourceCommand.js +2 -3
  26. package/dist-es/commands/UntagResourceCommand.js +2 -3
  27. package/dist-es/commands/UpdateClusterCommand.js +2 -2
  28. package/dist-es/models/models_0.js +0 -87
  29. package/dist-types/DocDBElastic.d.ts +14 -0
  30. package/dist-types/DocDBElasticClient.d.ts +24 -4
  31. package/dist-types/commands/CreateClusterCommand.d.ts +16 -0
  32. package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +16 -0
  33. package/dist-types/commands/DeleteClusterCommand.d.ts +16 -0
  34. package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +16 -0
  35. package/dist-types/commands/GetClusterCommand.d.ts +16 -0
  36. package/dist-types/commands/GetClusterSnapshotCommand.d.ts +16 -0
  37. package/dist-types/commands/ListClusterSnapshotsCommand.d.ts +16 -0
  38. package/dist-types/commands/ListClustersCommand.d.ts +16 -0
  39. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  40. package/dist-types/commands/RestoreClusterFromSnapshotCommand.d.ts +16 -0
  41. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  42. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  43. package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
  44. package/dist-types/models/DocDBElasticServiceException.d.ts +2 -0
  45. package/dist-types/models/models_0.d.ts +99 -116
  46. package/dist-types/pagination/Interfaces.d.ts +3 -0
  47. package/dist-types/pagination/ListClusterSnapshotsPaginator.d.ts +3 -0
  48. package/dist-types/pagination/ListClustersPaginator.d.ts +3 -0
  49. package/dist-types/ts3.4/models/models_0.d.ts +0 -85
  50. package/package.json +4 -3
@@ -121,94 +121,7 @@ export const CreateClusterInputFilterSensitiveLog = (obj) => ({
121
121
  ...obj,
122
122
  ...(obj.adminUserPassword && { adminUserPassword: SENSITIVE_STRING }),
123
123
  });
124
- export const ClusterFilterSensitiveLog = (obj) => ({
125
- ...obj,
126
- });
127
- export const CreateClusterOutputFilterSensitiveLog = (obj) => ({
128
- ...obj,
129
- });
130
- export const ValidationExceptionFieldFilterSensitiveLog = (obj) => ({
131
- ...obj,
132
- });
133
- export const CreateClusterSnapshotInputFilterSensitiveLog = (obj) => ({
134
- ...obj,
135
- });
136
- export const ClusterSnapshotFilterSensitiveLog = (obj) => ({
137
- ...obj,
138
- });
139
- export const CreateClusterSnapshotOutputFilterSensitiveLog = (obj) => ({
140
- ...obj,
141
- });
142
- export const DeleteClusterInputFilterSensitiveLog = (obj) => ({
143
- ...obj,
144
- });
145
- export const DeleteClusterOutputFilterSensitiveLog = (obj) => ({
146
- ...obj,
147
- });
148
- export const DeleteClusterSnapshotInputFilterSensitiveLog = (obj) => ({
149
- ...obj,
150
- });
151
- export const DeleteClusterSnapshotOutputFilterSensitiveLog = (obj) => ({
152
- ...obj,
153
- });
154
- export const GetClusterInputFilterSensitiveLog = (obj) => ({
155
- ...obj,
156
- });
157
- export const GetClusterOutputFilterSensitiveLog = (obj) => ({
158
- ...obj,
159
- });
160
- export const GetClusterSnapshotInputFilterSensitiveLog = (obj) => ({
161
- ...obj,
162
- });
163
- export const GetClusterSnapshotOutputFilterSensitiveLog = (obj) => ({
164
- ...obj,
165
- });
166
- export const ListClustersInputFilterSensitiveLog = (obj) => ({
167
- ...obj,
168
- });
169
- export const ClusterInListFilterSensitiveLog = (obj) => ({
170
- ...obj,
171
- });
172
- export const ListClustersOutputFilterSensitiveLog = (obj) => ({
173
- ...obj,
174
- });
175
- export const ListClusterSnapshotsInputFilterSensitiveLog = (obj) => ({
176
- ...obj,
177
- });
178
- export const ClusterSnapshotInListFilterSensitiveLog = (obj) => ({
179
- ...obj,
180
- });
181
- export const ListClusterSnapshotsOutputFilterSensitiveLog = (obj) => ({
182
- ...obj,
183
- });
184
- export const ListTagsForResourceRequestFilterSensitiveLog = (obj) => ({
185
- ...obj,
186
- });
187
- export const ListTagsForResourceResponseFilterSensitiveLog = (obj) => ({
188
- ...obj,
189
- });
190
- export const RestoreClusterFromSnapshotInputFilterSensitiveLog = (obj) => ({
191
- ...obj,
192
- });
193
- export const RestoreClusterFromSnapshotOutputFilterSensitiveLog = (obj) => ({
194
- ...obj,
195
- });
196
- export const TagResourceRequestFilterSensitiveLog = (obj) => ({
197
- ...obj,
198
- });
199
- export const TagResourceResponseFilterSensitiveLog = (obj) => ({
200
- ...obj,
201
- });
202
- export const UntagResourceRequestFilterSensitiveLog = (obj) => ({
203
- ...obj,
204
- });
205
- export const UntagResourceResponseFilterSensitiveLog = (obj) => ({
206
- ...obj,
207
- });
208
124
  export const UpdateClusterInputFilterSensitiveLog = (obj) => ({
209
125
  ...obj,
210
126
  ...(obj.adminUserPassword && { adminUserPassword: SENSITIVE_STRING }),
211
127
  });
212
- export const UpdateClusterOutputFilterSensitiveLog = (obj) => ({
213
- ...obj,
214
- });
@@ -14,82 +14,96 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
14
14
  import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./commands/UpdateClusterCommand";
15
15
  import { DocDBElasticClient } from "./DocDBElasticClient";
16
16
  /**
17
+ * @public
17
18
  * <p>The new Amazon Elastic DocumentDB service endpoint.</p>
18
19
  */
19
20
  export declare class DocDBElastic extends DocDBElasticClient {
20
21
  /**
22
+ * @public
21
23
  * <p>Creates a new Elastic DocumentDB cluster and returns its Cluster structure.</p>
22
24
  */
23
25
  createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>;
24
26
  createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
25
27
  createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
26
28
  /**
29
+ * @public
27
30
  * <p>Creates a snapshot of a cluster.</p>
28
31
  */
29
32
  createClusterSnapshot(args: CreateClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterSnapshotCommandOutput>;
30
33
  createClusterSnapshot(args: CreateClusterSnapshotCommandInput, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void): void;
31
34
  createClusterSnapshot(args: CreateClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void): void;
32
35
  /**
36
+ * @public
33
37
  * <p>Delete a Elastic DocumentDB cluster.</p>
34
38
  */
35
39
  deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterCommandOutput>;
36
40
  deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
37
41
  deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
38
42
  /**
43
+ * @public
39
44
  * <p>Delete a Elastic DocumentDB snapshot.</p>
40
45
  */
41
46
  deleteClusterSnapshot(args: DeleteClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterSnapshotCommandOutput>;
42
47
  deleteClusterSnapshot(args: DeleteClusterSnapshotCommandInput, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void): void;
43
48
  deleteClusterSnapshot(args: DeleteClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void): void;
44
49
  /**
50
+ * @public
45
51
  * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
46
52
  */
47
53
  getCluster(args: GetClusterCommandInput, options?: __HttpHandlerOptions): Promise<GetClusterCommandOutput>;
48
54
  getCluster(args: GetClusterCommandInput, cb: (err: any, data?: GetClusterCommandOutput) => void): void;
49
55
  getCluster(args: GetClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterCommandOutput) => void): void;
50
56
  /**
57
+ * @public
51
58
  * <p>Returns information about a specific Elastic DocumentDB snapshot</p>
52
59
  */
53
60
  getClusterSnapshot(args: GetClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<GetClusterSnapshotCommandOutput>;
54
61
  getClusterSnapshot(args: GetClusterSnapshotCommandInput, cb: (err: any, data?: GetClusterSnapshotCommandOutput) => void): void;
55
62
  getClusterSnapshot(args: GetClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterSnapshotCommandOutput) => void): void;
56
63
  /**
64
+ * @public
57
65
  * <p>Returns information about provisioned Elastic DocumentDB clusters.</p>
58
66
  */
59
67
  listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise<ListClustersCommandOutput>;
60
68
  listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
61
69
  listClusters(args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
62
70
  /**
71
+ * @public
63
72
  * <p>Returns information about Elastic DocumentDB snapshots for a specified cluster.</p>
64
73
  */
65
74
  listClusterSnapshots(args: ListClusterSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<ListClusterSnapshotsCommandOutput>;
66
75
  listClusterSnapshots(args: ListClusterSnapshotsCommandInput, cb: (err: any, data?: ListClusterSnapshotsCommandOutput) => void): void;
67
76
  listClusterSnapshots(args: ListClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClusterSnapshotsCommandOutput) => void): void;
68
77
  /**
78
+ * @public
69
79
  * <p>Lists all tags on a Elastic DocumentDB resource</p>
70
80
  */
71
81
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
72
82
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
73
83
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
74
84
  /**
85
+ * @public
75
86
  * <p>Restores a Elastic DocumentDB cluster from a snapshot.</p>
76
87
  */
77
88
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<RestoreClusterFromSnapshotCommandOutput>;
78
89
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void): void;
79
90
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void): void;
80
91
  /**
92
+ * @public
81
93
  * <p>Adds metadata tags to a Elastic DocumentDB resource</p>
82
94
  */
83
95
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
84
96
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
85
97
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
86
98
  /**
99
+ * @public
87
100
  * <p>Removes metadata tags to a Elastic DocumentDB resource</p>
88
101
  */
89
102
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
90
103
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
91
104
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
92
105
  /**
106
+ * @public
93
107
  * <p>Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password,
94
108
  * upgrading API version setting up a backup window and maintenance window</p>
95
109
  */
@@ -21,15 +21,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
21
21
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
22
22
  import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./commands/UpdateClusterCommand";
23
23
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
24
+ /**
25
+ * @public
26
+ */
24
27
  export type ServiceInputTypes = CreateClusterCommandInput | CreateClusterSnapshotCommandInput | DeleteClusterCommandInput | DeleteClusterSnapshotCommandInput | GetClusterCommandInput | GetClusterSnapshotCommandInput | ListClusterSnapshotsCommandInput | ListClustersCommandInput | ListTagsForResourceCommandInput | RestoreClusterFromSnapshotCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateClusterCommandInput;
28
+ /**
29
+ * @public
30
+ */
25
31
  export type ServiceOutputTypes = CreateClusterCommandOutput | CreateClusterSnapshotCommandOutput | DeleteClusterCommandOutput | DeleteClusterSnapshotCommandOutput | GetClusterCommandOutput | GetClusterSnapshotCommandOutput | ListClusterSnapshotsCommandOutput | ListClustersCommandOutput | ListTagsForResourceCommandOutput | RestoreClusterFromSnapshotCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateClusterCommandOutput;
32
+ /**
33
+ * @public
34
+ */
26
35
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
27
36
  /**
28
37
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
29
38
  */
30
39
  requestHandler?: __HttpHandler;
31
40
  /**
32
- * A constructor for a class implementing the {@link __Checksum} interface
41
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
33
42
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
34
43
  * @internal
35
44
  */
@@ -119,23 +128,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
119
128
  */
120
129
  logger?: __Logger;
121
130
  /**
122
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
123
132
  */
124
133
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
125
134
  }
135
+ /**
136
+ * @public
137
+ */
126
138
  type DocDBElasticClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
127
139
  /**
128
- * The configuration interface of DocDBElasticClient class constructor that set the region, credentials and other options.
140
+ * @public
141
+ *
142
+ * The configuration interface of DocDBElasticClient class constructor that set the region, credentials and other options.
129
143
  */
130
144
  export interface DocDBElasticClientConfig extends DocDBElasticClientConfigType {
131
145
  }
146
+ /**
147
+ * @public
148
+ */
132
149
  type DocDBElasticClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
133
150
  /**
134
- * The resolved configuration interface of DocDBElasticClient class. This is resolved and normalized from the {@link DocDBElasticClientConfig | constructor configuration interface}.
151
+ * @public
152
+ *
153
+ * The resolved configuration interface of DocDBElasticClient class. This is resolved and normalized from the {@link DocDBElasticClientConfig | constructor configuration interface}.
135
154
  */
136
155
  export interface DocDBElasticClientResolvedConfig extends DocDBElasticClientResolvedConfigType {
137
156
  }
138
157
  /**
158
+ * @public
139
159
  * <p>The new Amazon Elastic DocumentDB service endpoint.</p>
140
160
  */
141
161
  export declare class DocDBElasticClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DocDBElasticClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { CreateClusterInput, CreateClusterOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterCommand}.
8
10
  */
9
11
  export interface CreateClusterCommandInput extends CreateClusterInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterCommand}.
13
17
  */
14
18
  export interface CreateClusterCommandOutput extends CreateClusterOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Elastic DocumentDB cluster and returns its Cluster structure.</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 CreateClusterCommandOutput extends CreateClusterOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
34
+ * @returns {@link CreateClusterCommandOutput}
28
35
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateClusterCommandOutput extends CreateClusterOutput, __Metad
52
59
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, DocDBElasticClientResolvedConfig> {
53
60
  readonly input: CreateClusterCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateClusterCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
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 { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { CreateClusterSnapshotInput, CreateClusterSnapshotOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterSnapshotCommand}.
8
10
  */
9
11
  export interface CreateClusterSnapshotCommandInput extends CreateClusterSnapshotInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterSnapshotCommand}.
13
17
  */
14
18
  export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapshotOutput, __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 CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateClusterSnapshotCommandInput - {@link CreateClusterSnapshotCommandInput}
34
+ * @returns {@link CreateClusterSnapshotCommandOutput}
28
35
  * @see {@link CreateClusterSnapshotCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateClusterSnapshotCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho
55
62
  export declare class CreateClusterSnapshotCommand extends $Command<CreateClusterSnapshotCommandInput, CreateClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
56
63
  readonly input: CreateClusterSnapshotCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateClusterSnapshotCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterSnapshotCommandInput, CreateClusterSnapshotCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { DeleteClusterInput, DeleteClusterOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteClusterCommand}.
8
10
  */
9
11
  export interface DeleteClusterCommandInput extends DeleteClusterInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteClusterCommand}.
13
17
  */
14
18
  export interface DeleteClusterCommandOutput extends DeleteClusterOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a Elastic 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 DeleteClusterCommandOutput extends DeleteClusterOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput}
34
+ * @returns {@link DeleteClusterCommandOutput}
28
35
  * @see {@link DeleteClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterOutput, __Metad
52
59
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, DocDBElasticClientResolvedConfig> {
53
60
  readonly input: DeleteClusterCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteClusterCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClusterCommandInput, DeleteClusterCommandOutput>;
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 { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { DeleteClusterSnapshotInput, DeleteClusterSnapshotOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteClusterSnapshotCommand}.
8
10
  */
9
11
  export interface DeleteClusterSnapshotCommandInput extends DeleteClusterSnapshotInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteClusterSnapshotCommand}.
13
17
  */
14
18
  export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapshotOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a Elastic DocumentDB snapshot.</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 DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteClusterSnapshotCommandInput - {@link DeleteClusterSnapshotCommandInput}
34
+ * @returns {@link DeleteClusterSnapshotCommandOutput}
28
35
  * @see {@link DeleteClusterSnapshotCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteClusterSnapshotCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho
52
59
  export declare class DeleteClusterSnapshotCommand extends $Command<DeleteClusterSnapshotCommandInput, DeleteClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
53
60
  readonly input: DeleteClusterSnapshotCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteClusterSnapshotCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClusterSnapshotCommandInput, DeleteClusterSnapshotCommandOutput>;
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 { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { GetClusterInput, GetClusterOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetClusterCommand}.
8
10
  */
9
11
  export interface GetClusterCommandInput extends GetClusterInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetClusterCommand}.
13
17
  */
14
18
  export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a specific Elastic 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 GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetClusterCommandInput - {@link GetClusterCommandInput}
34
+ * @returns {@link GetClusterCommandOutput}
28
35
  * @see {@link GetClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link GetClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
49
56
  export declare class GetClusterCommand extends $Command<GetClusterCommandInput, GetClusterCommandOutput, DocDBElasticClientResolvedConfig> {
50
57
  readonly input: GetClusterCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetClusterCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetClusterCommandInput, GetClusterCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { GetClusterSnapshotInput, GetClusterSnapshotOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetClusterSnapshotCommand}.
8
10
  */
9
11
  export interface GetClusterSnapshotCommandInput extends GetClusterSnapshotInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetClusterSnapshotCommand}.
13
17
  */
14
18
  export interface GetClusterSnapshotCommandOutput extends GetClusterSnapshotOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a specific Elastic DocumentDB snapshot</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 GetClusterSnapshotCommandOutput extends GetClusterSnapshotOutpu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetClusterSnapshotCommandInput - {@link GetClusterSnapshotCommandInput}
34
+ * @returns {@link GetClusterSnapshotCommandOutput}
28
35
  * @see {@link GetClusterSnapshotCommandInput} for command's `input` shape.
29
36
  * @see {@link GetClusterSnapshotCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetClusterSnapshotCommandOutput extends GetClusterSnapshotOutpu
49
56
  export declare class GetClusterSnapshotCommand extends $Command<GetClusterSnapshotCommandInput, GetClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
50
57
  readonly input: GetClusterSnapshotCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetClusterSnapshotCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetClusterSnapshotCommandInput, GetClusterSnapshotCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { ListClusterSnapshotsInput, ListClusterSnapshotsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListClusterSnapshotsCommand}.
8
10
  */
9
11
  export interface ListClusterSnapshotsCommandInput extends ListClusterSnapshotsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListClusterSnapshotsCommand}.
13
17
  */
14
18
  export interface ListClusterSnapshotsCommandOutput extends ListClusterSnapshotsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about Elastic DocumentDB snapshots for a specified 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 ListClusterSnapshotsCommandOutput extends ListClusterSnapshotsO
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListClusterSnapshotsCommandInput - {@link ListClusterSnapshotsCommandInput}
34
+ * @returns {@link ListClusterSnapshotsCommandOutput}
28
35
  * @see {@link ListClusterSnapshotsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListClusterSnapshotsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListClusterSnapshotsCommandOutput extends ListClusterSnapshotsO
46
53
  export declare class ListClusterSnapshotsCommand extends $Command<ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput, DocDBElasticClientResolvedConfig> {
47
54
  readonly input: ListClusterSnapshotsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListClusterSnapshotsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }