@aws-sdk/client-docdb-elastic 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.
@@ -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
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { ListClustersInput, ListClustersOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListClustersCommand}.
8
10
  */
9
11
  export interface ListClustersCommandInput extends ListClustersInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListClustersCommand}.
13
17
  */
14
18
  export interface ListClustersCommandOutput extends ListClustersOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about provisioned Elastic DocumentDB 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 ListClustersCommandOutput extends ListClustersOutput, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListClustersCommandInput - {@link ListClustersCommandInput}
34
+ * @returns {@link ListClustersCommandOutput}
28
35
  * @see {@link ListClustersCommandInput} for command's `input` shape.
29
36
  * @see {@link ListClustersCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListClustersCommandOutput extends ListClustersOutput, __Metadat
46
53
  export declare class ListClustersCommand extends $Command<ListClustersCommandInput, ListClustersCommandOutput, DocDBElasticClientResolvedConfig> {
47
54
  readonly input: ListClustersCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListClustersCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListClustersCommandInput, ListClustersCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all tags on a Elastic DocumentDB resource</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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
46
53
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DocDBElasticClientResolvedConfig> {
47
54
  readonly input: ListTagsForResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTagsForResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { RestoreClusterFromSnapshotInput, RestoreClusterFromSnapshotOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RestoreClusterFromSnapshotCommand}.
8
10
  */
9
11
  export interface RestoreClusterFromSnapshotCommandInput extends RestoreClusterFromSnapshotInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RestoreClusterFromSnapshotCommand}.
13
17
  */
14
18
  export interface RestoreClusterFromSnapshotCommandOutput extends RestoreClusterFromSnapshotOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Restores a Elastic DocumentDB cluster from a 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 RestoreClusterFromSnapshotCommandOutput extends RestoreClusterF
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RestoreClusterFromSnapshotCommandInput - {@link RestoreClusterFromSnapshotCommandInput}
34
+ * @returns {@link RestoreClusterFromSnapshotCommandOutput}
28
35
  * @see {@link RestoreClusterFromSnapshotCommandInput} for command's `input` shape.
29
36
  * @see {@link RestoreClusterFromSnapshotCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -55,11 +62,20 @@ export interface RestoreClusterFromSnapshotCommandOutput extends RestoreClusterF
55
62
  export declare class RestoreClusterFromSnapshotCommand extends $Command<RestoreClusterFromSnapshotCommandInput, RestoreClusterFromSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
56
63
  readonly input: RestoreClusterFromSnapshotCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: RestoreClusterFromSnapshotCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreClusterFromSnapshotCommandInput, RestoreClusterFromSnapshotCommandOutput>;
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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds metadata tags to a Elastic DocumentDB resource</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 TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -46,11 +53,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
46
53
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, DocDBElasticClientResolvedConfig> {
47
54
  readonly input: TagResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: TagResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes metadata tags to a Elastic DocumentDB resource</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 UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
46
53
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, DocDBElasticClientResolvedConfig> {
47
54
  readonly input: UntagResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UntagResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
5
5
  import { UpdateClusterInput, UpdateClusterOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateClusterCommand}.
8
10
  */
9
11
  export interface UpdateClusterCommandInput extends UpdateClusterInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateClusterCommand}.
13
17
  */
14
18
  export interface UpdateClusterCommandOutput extends UpdateClusterOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password,
18
23
  * upgrading API version setting up a backup window and maintenance window</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateClusterCommandOutput extends UpdateClusterOutput, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateClusterCommandInput - {@link UpdateClusterCommandInput}
35
+ * @returns {@link UpdateClusterCommandOutput}
29
36
  * @see {@link UpdateClusterCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateClusterCommandOutput} for command's `response` shape.
31
38
  * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateClusterCommandOutput extends UpdateClusterOutput, __Metad
53
60
  export declare class UpdateClusterCommand extends $Command<UpdateClusterCommandInput, UpdateClusterCommandOutput, DocDBElasticClientResolvedConfig> {
54
61
  readonly input: UpdateClusterCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateClusterCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBElasticClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateClusterCommandInput, UpdateClusterCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from DocDBElastic service.
4
6
  */
5
7
  export declare class DocDBElasticServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { DocDBElasticServiceException as __BaseException } from "./DocDBElasticServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -11,11 +12,15 @@ export declare class AccessDeniedException extends __BaseException {
11
12
  */
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
15
+ /**
16
+ * @public
17
+ */
14
18
  export declare enum Auth {
15
19
  PLAIN_TEXT = "PLAIN_TEXT",
16
20
  SECRET_ARN = "SECRET_ARN"
17
21
  }
18
22
  /**
23
+ * @public
19
24
  * <p>There was an access conflict.</p>
20
25
  */
21
26
  export declare class ConflictException extends __BaseException {
@@ -34,6 +39,9 @@ export declare class ConflictException extends __BaseException {
34
39
  */
35
40
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
36
41
  }
42
+ /**
43
+ * @public
44
+ */
37
45
  export interface CreateClusterInput {
38
46
  /**
39
47
  * <p>The name of the new Elastic DocumentDB cluster. This parameter is stored as
@@ -143,6 +151,9 @@ export interface CreateClusterInput {
143
151
  */
144
152
  tags?: Record<string, string>;
145
153
  }
154
+ /**
155
+ * @public
156
+ */
146
157
  export declare enum Status {
147
158
  ACTIVE = "ACTIVE",
148
159
  CREATING = "CREATING",
@@ -155,6 +166,7 @@ export declare enum Status {
155
166
  VPC_ENDPOINT_LIMIT_EXCEEDED = "VPC_ENDPOINT_LIMIT_EXCEEDED"
156
167
  }
157
168
  /**
169
+ * @public
158
170
  * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
159
171
  */
160
172
  export interface Cluster {
@@ -215,6 +227,9 @@ export interface Cluster {
215
227
  */
216
228
  kmsKeyId: string | undefined;
217
229
  }
230
+ /**
231
+ * @public
232
+ */
218
233
  export interface CreateClusterOutput {
219
234
  /**
220
235
  * <p>The new Elastic DocumentDB cluster that has been created.</p>
@@ -222,6 +237,7 @@ export interface CreateClusterOutput {
222
237
  cluster: Cluster | undefined;
223
238
  }
224
239
  /**
240
+ * @public
225
241
  * <p>There was an internal server error.</p>
226
242
  */
227
243
  export declare class InternalServerException extends __BaseException {
@@ -234,6 +250,7 @@ export declare class InternalServerException extends __BaseException {
234
250
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
235
251
  }
236
252
  /**
253
+ * @public
237
254
  * <p>The service quota for the action was exceeded.</p>
238
255
  */
239
256
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -245,6 +262,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
245
262
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
246
263
  }
247
264
  /**
265
+ * @public
248
266
  * <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
249
267
  */
250
268
  export declare class ThrottlingException extends __BaseException {
@@ -261,6 +279,7 @@ export declare class ThrottlingException extends __BaseException {
261
279
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
262
280
  }
263
281
  /**
282
+ * @public
264
283
  * <p>A specific field in which a given validation exception occurred.</p>
265
284
  */
266
285
  export interface ValidationExceptionField {
@@ -273,6 +292,9 @@ export interface ValidationExceptionField {
273
292
  */
274
293
  message: string | undefined;
275
294
  }
295
+ /**
296
+ * @public
297
+ */
276
298
  export declare enum ValidationExceptionReason {
277
299
  CANNOT_PARSE = "cannotParse",
278
300
  FIELD_VALIDATION_FAILED = "fieldValidationFailed",
@@ -280,6 +302,7 @@ export declare enum ValidationExceptionReason {
280
302
  UNKNOWN_OPERATION = "unknownOperation"
281
303
  }
282
304
  /**
305
+ * @public
283
306
  * <p>A structure defining a validation exception.</p>
284
307
  */
285
308
  export declare class ValidationException extends __BaseException {
@@ -299,6 +322,9 @@ export declare class ValidationException extends __BaseException {
299
322
  */
300
323
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
301
324
  }
325
+ /**
326
+ * @public
327
+ */
302
328
  export interface CreateClusterSnapshotInput {
303
329
  /**
304
330
  * <p>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</p>
@@ -314,6 +340,7 @@ export interface CreateClusterSnapshotInput {
314
340
  tags?: Record<string, string>;
315
341
  }
316
342
  /**
343
+ * @public
317
344
  * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
318
345
  */
319
346
  export interface ClusterSnapshot {
@@ -358,6 +385,9 @@ export interface ClusterSnapshot {
358
385
  */
359
386
  kmsKeyId: string | undefined;
360
387
  }
388
+ /**
389
+ * @public
390
+ */
361
391
  export interface CreateClusterSnapshotOutput {
362
392
  /**
363
393
  * <p>Returns information about the new Elastic DocumentDB snapshot.</p>
@@ -365,6 +395,7 @@ export interface CreateClusterSnapshotOutput {
365
395
  snapshot: ClusterSnapshot | undefined;
366
396
  }
367
397
  /**
398
+ * @public
368
399
  * <p>The specified resource could not be located.</p>
369
400
  */
370
401
  export declare class ResourceNotFoundException extends __BaseException {
@@ -383,54 +414,81 @@ export declare class ResourceNotFoundException extends __BaseException {
383
414
  */
384
415
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
385
416
  }
417
+ /**
418
+ * @public
419
+ */
386
420
  export interface DeleteClusterInput {
387
421
  /**
388
422
  * <p>The arn of the Elastic DocumentDB cluster that is to be deleted.</p>
389
423
  */
390
424
  clusterArn: string | undefined;
391
425
  }
426
+ /**
427
+ * @public
428
+ */
392
429
  export interface DeleteClusterOutput {
393
430
  /**
394
431
  * <p>Returns information about the newly deleted Elastic DocumentDB cluster.</p>
395
432
  */
396
433
  cluster: Cluster | undefined;
397
434
  }
435
+ /**
436
+ * @public
437
+ */
398
438
  export interface DeleteClusterSnapshotInput {
399
439
  /**
400
440
  * <p>The arn of the Elastic DocumentDB snapshot that is to be deleted.</p>
401
441
  */
402
442
  snapshotArn: string | undefined;
403
443
  }
444
+ /**
445
+ * @public
446
+ */
404
447
  export interface DeleteClusterSnapshotOutput {
405
448
  /**
406
449
  * <p>Returns information about the newly deleted Elastic DocumentDB snapshot.</p>
407
450
  */
408
451
  snapshot: ClusterSnapshot | undefined;
409
452
  }
453
+ /**
454
+ * @public
455
+ */
410
456
  export interface GetClusterInput {
411
457
  /**
412
458
  * <p>The arn of the Elastic DocumentDB cluster.</p>
413
459
  */
414
460
  clusterArn: string | undefined;
415
461
  }
462
+ /**
463
+ * @public
464
+ */
416
465
  export interface GetClusterOutput {
417
466
  /**
418
467
  * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
419
468
  */
420
469
  cluster: Cluster | undefined;
421
470
  }
471
+ /**
472
+ * @public
473
+ */
422
474
  export interface GetClusterSnapshotInput {
423
475
  /**
424
476
  * <p>The arn of the Elastic DocumentDB snapshot.</p>
425
477
  */
426
478
  snapshotArn: string | undefined;
427
479
  }
480
+ /**
481
+ * @public
482
+ */
428
483
  export interface GetClusterSnapshotOutput {
429
484
  /**
430
485
  * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
431
486
  */
432
487
  snapshot: ClusterSnapshot | undefined;
433
488
  }
489
+ /**
490
+ * @public
491
+ */
434
492
  export interface ListClustersInput {
435
493
  /**
436
494
  * <p>The nextToken which is used the get the next page of data.</p>
@@ -442,6 +500,7 @@ export interface ListClustersInput {
442
500
  maxResults?: number;
443
501
  }
444
502
  /**
503
+ * @public
445
504
  * <p>A list of Elastic DocumentDB cluster.</p>
446
505
  */
447
506
  export interface ClusterInList {
@@ -458,6 +517,9 @@ export interface ClusterInList {
458
517
  */
459
518
  status: Status | string | undefined;
460
519
  }
520
+ /**
521
+ * @public
522
+ */
461
523
  export interface ListClustersOutput {
462
524
  /**
463
525
  * <p>A list of Elastic DocumentDB cluster.</p>
@@ -469,6 +531,9 @@ export interface ListClustersOutput {
469
531
  */
470
532
  nextToken?: string;
471
533
  }
534
+ /**
535
+ * @public
536
+ */
472
537
  export interface ListClusterSnapshotsInput {
473
538
  /**
474
539
  * <p>The arn of the Elastic DocumentDB cluster.</p>
@@ -484,6 +549,7 @@ export interface ListClusterSnapshotsInput {
484
549
  maxResults?: number;
485
550
  }
486
551
  /**
552
+ * @public
487
553
  * <p>A list of Elastic DocumentDB snapshots.</p>
488
554
  */
489
555
  export interface ClusterSnapshotInList {
@@ -508,6 +574,9 @@ export interface ClusterSnapshotInList {
508
574
  */
509
575
  snapshotCreationTime: string | undefined;
510
576
  }
577
+ /**
578
+ * @public
579
+ */
511
580
  export interface ListClusterSnapshotsOutput {
512
581
  /**
513
582
  * <p>A list of Elastic DocumentDB snapshots for a specified cluster.</p>
@@ -519,18 +588,27 @@ export interface ListClusterSnapshotsOutput {
519
588
  */
520
589
  nextToken?: string;
521
590
  }
591
+ /**
592
+ * @public
593
+ */
522
594
  export interface ListTagsForResourceRequest {
523
595
  /**
524
596
  * <p>The arn of the Elastic DocumentDB resource.</p>
525
597
  */
526
598
  resourceArn: string | undefined;
527
599
  }
600
+ /**
601
+ * @public
602
+ */
528
603
  export interface ListTagsForResourceResponse {
529
604
  /**
530
605
  * <p>The list of tags for the specified Elastic DocumentDB resource.</p>
531
606
  */
532
607
  tags?: Record<string, string>;
533
608
  }
609
+ /**
610
+ * @public
611
+ */
534
612
  export interface RestoreClusterFromSnapshotInput {
535
613
  /**
536
614
  * <p>The name of the Elastic DocumentDB cluster.</p>
@@ -567,12 +645,18 @@ export interface RestoreClusterFromSnapshotInput {
567
645
  */
568
646
  tags?: Record<string, string>;
569
647
  }
648
+ /**
649
+ * @public
650
+ */
570
651
  export interface RestoreClusterFromSnapshotOutput {
571
652
  /**
572
653
  * <p>Returns information about a the restored Elastic DocumentDB cluster.</p>
573
654
  */
574
655
  cluster: Cluster | undefined;
575
656
  }
657
+ /**
658
+ * @public
659
+ */
576
660
  export interface TagResourceRequest {
577
661
  /**
578
662
  * <p>The arn of the Elastic DocumentDB resource.</p>
@@ -583,8 +667,14 @@ export interface TagResourceRequest {
583
667
  */
584
668
  tags: Record<string, string> | undefined;
585
669
  }
670
+ /**
671
+ * @public
672
+ */
586
673
  export interface TagResourceResponse {
587
674
  }
675
+ /**
676
+ * @public
677
+ */
588
678
  export interface UntagResourceRequest {
589
679
  /**
590
680
  * <p>The arn of the Elastic DocumentDB resource.</p>
@@ -595,8 +685,14 @@ export interface UntagResourceRequest {
595
685
  */
596
686
  tagKeys: string[] | undefined;
597
687
  }
688
+ /**
689
+ * @public
690
+ */
598
691
  export interface UntagResourceResponse {
599
692
  }
693
+ /**
694
+ * @public
695
+ */
600
696
  export interface UpdateClusterInput {
601
697
  /**
602
698
  * <p>The arn of the Elastic DocumentDB cluster.</p>
@@ -650,6 +746,9 @@ export interface UpdateClusterInput {
650
746
  */
651
747
  preferredMaintenanceWindow?: string;
652
748
  }
749
+ /**
750
+ * @public
751
+ */
653
752
  export interface UpdateClusterOutput {
654
753
  /**
655
754
  * <p>Returns information about the updated Elastic DocumentDB cluster.</p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { DocDBElasticClient } from "../DocDBElasticClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface DocDBElasticPaginationConfiguration extends PaginationConfiguration {
4
7
  client: DocDBElasticClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput } from "../commands/ListClusterSnapshotsCommand";
3
3
  import { DocDBElasticPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListClusterSnapshots(config: DocDBElasticPaginationConfiguration, input: ListClusterSnapshotsCommandInput, ...additionalArguments: any): Paginator<ListClusterSnapshotsCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand";
3
3
  import { DocDBElasticPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListClusters(config: DocDBElasticPaginationConfiguration, input: ListClustersCommandInput, ...additionalArguments: any): Paginator<ListClustersCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-docdb-elastic",
3
3
  "description": "AWS SDK for JavaScript Docdb Elastic Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",