@aws-sdk/client-docdb-elastic 3.325.0 → 3.326.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.
@@ -48,6 +48,28 @@ export interface CreateClusterCommandOutput extends CreateClusterOutput, __Metad
48
48
  * };
49
49
  * const command = new CreateClusterCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // CreateClusterOutput
52
+ * // cluster: { // Cluster
53
+ * // clusterName: "STRING_VALUE", // required
54
+ * // clusterArn: "STRING_VALUE", // required
55
+ * // status: "STRING_VALUE", // required
56
+ * // clusterEndpoint: "STRING_VALUE", // required
57
+ * // createTime: "STRING_VALUE", // required
58
+ * // adminUserName: "STRING_VALUE", // required
59
+ * // authType: "STRING_VALUE", // required
60
+ * // shardCapacity: Number("int"), // required
61
+ * // shardCount: Number("int"), // required
62
+ * // vpcSecurityGroupIds: [ // StringList // required
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // subnetIds: [ // required
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
69
+ * // kmsKeyId: "STRING_VALUE", // required
70
+ * // },
71
+ * // };
72
+ *
51
73
  * ```
52
74
  *
53
75
  * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
@@ -74,6 +96,8 @@ export interface CreateClusterCommandOutput extends CreateClusterOutput, __Metad
74
96
  * @throws {@link ValidationException} (client fault)
75
97
  * <p>A structure defining a validation exception.</p>
76
98
  *
99
+ * @throws {@link DocDBElasticServiceException}
100
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
77
101
  *
78
102
  */
79
103
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -35,6 +35,25 @@ export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho
35
35
  * };
36
36
  * const command = new CreateClusterSnapshotCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreateClusterSnapshotOutput
39
+ * // snapshot: { // ClusterSnapshot
40
+ * // subnetIds: [ // StringList // required
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // snapshotName: "STRING_VALUE", // required
44
+ * // snapshotArn: "STRING_VALUE", // required
45
+ * // snapshotCreationTime: "STRING_VALUE", // required
46
+ * // clusterArn: "STRING_VALUE", // required
47
+ * // clusterCreationTime: "STRING_VALUE", // required
48
+ * // status: "STRING_VALUE", // required
49
+ * // vpcSecurityGroupIds: [ // required
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // adminUserName: "STRING_VALUE", // required
53
+ * // kmsKeyId: "STRING_VALUE", // required
54
+ * // },
55
+ * // };
56
+ *
38
57
  * ```
39
58
  *
40
59
  * @param CreateClusterSnapshotCommandInput - {@link CreateClusterSnapshotCommandInput}
@@ -64,6 +83,8 @@ export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho
64
83
  * @throws {@link ValidationException} (client fault)
65
84
  * <p>A structure defining a validation exception.</p>
66
85
  *
86
+ * @throws {@link DocDBElasticServiceException}
87
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
67
88
  *
68
89
  */
69
90
  export declare class CreateClusterSnapshotCommand extends $Command<CreateClusterSnapshotCommandInput, CreateClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -31,6 +31,28 @@ export interface DeleteClusterCommandOutput extends DeleteClusterOutput, __Metad
31
31
  * };
32
32
  * const command = new DeleteClusterCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteClusterOutput
35
+ * // cluster: { // Cluster
36
+ * // clusterName: "STRING_VALUE", // required
37
+ * // clusterArn: "STRING_VALUE", // required
38
+ * // status: "STRING_VALUE", // required
39
+ * // clusterEndpoint: "STRING_VALUE", // required
40
+ * // createTime: "STRING_VALUE", // required
41
+ * // adminUserName: "STRING_VALUE", // required
42
+ * // authType: "STRING_VALUE", // required
43
+ * // shardCapacity: Number("int"), // required
44
+ * // shardCount: Number("int"), // required
45
+ * // vpcSecurityGroupIds: [ // StringList // required
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // subnetIds: [ // required
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
52
+ * // kmsKeyId: "STRING_VALUE", // required
53
+ * // },
54
+ * // };
55
+ *
34
56
  * ```
35
57
  *
36
58
  * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput}
@@ -57,6 +79,8 @@ export interface DeleteClusterCommandOutput extends DeleteClusterOutput, __Metad
57
79
  * @throws {@link ValidationException} (client fault)
58
80
  * <p>A structure defining a validation exception.</p>
59
81
  *
82
+ * @throws {@link DocDBElasticServiceException}
83
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
60
84
  *
61
85
  */
62
86
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -31,6 +31,25 @@ export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho
31
31
  * };
32
32
  * const command = new DeleteClusterSnapshotCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteClusterSnapshotOutput
35
+ * // snapshot: { // ClusterSnapshot
36
+ * // subnetIds: [ // StringList // required
37
+ * // "STRING_VALUE",
38
+ * // ],
39
+ * // snapshotName: "STRING_VALUE", // required
40
+ * // snapshotArn: "STRING_VALUE", // required
41
+ * // snapshotCreationTime: "STRING_VALUE", // required
42
+ * // clusterArn: "STRING_VALUE", // required
43
+ * // clusterCreationTime: "STRING_VALUE", // required
44
+ * // status: "STRING_VALUE", // required
45
+ * // vpcSecurityGroupIds: [ // required
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // adminUserName: "STRING_VALUE", // required
49
+ * // kmsKeyId: "STRING_VALUE", // required
50
+ * // },
51
+ * // };
52
+ *
34
53
  * ```
35
54
  *
36
55
  * @param DeleteClusterSnapshotCommandInput - {@link DeleteClusterSnapshotCommandInput}
@@ -57,6 +76,8 @@ export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho
57
76
  * @throws {@link ValidationException} (client fault)
58
77
  * <p>A structure defining a validation exception.</p>
59
78
  *
79
+ * @throws {@link DocDBElasticServiceException}
80
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
60
81
  *
61
82
  */
62
83
  export declare class DeleteClusterSnapshotCommand extends $Command<DeleteClusterSnapshotCommandInput, DeleteClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -31,6 +31,28 @@ export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
31
31
  * };
32
32
  * const command = new GetClusterCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetClusterOutput
35
+ * // cluster: { // Cluster
36
+ * // clusterName: "STRING_VALUE", // required
37
+ * // clusterArn: "STRING_VALUE", // required
38
+ * // status: "STRING_VALUE", // required
39
+ * // clusterEndpoint: "STRING_VALUE", // required
40
+ * // createTime: "STRING_VALUE", // required
41
+ * // adminUserName: "STRING_VALUE", // required
42
+ * // authType: "STRING_VALUE", // required
43
+ * // shardCapacity: Number("int"), // required
44
+ * // shardCount: Number("int"), // required
45
+ * // vpcSecurityGroupIds: [ // StringList // required
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // subnetIds: [ // required
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
52
+ * // kmsKeyId: "STRING_VALUE", // required
53
+ * // },
54
+ * // };
55
+ *
34
56
  * ```
35
57
  *
36
58
  * @param GetClusterCommandInput - {@link GetClusterCommandInput}
@@ -54,6 +76,8 @@ export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
54
76
  * @throws {@link ValidationException} (client fault)
55
77
  * <p>A structure defining a validation exception.</p>
56
78
  *
79
+ * @throws {@link DocDBElasticServiceException}
80
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
57
81
  *
58
82
  */
59
83
  export declare class GetClusterCommand extends $Command<GetClusterCommandInput, GetClusterCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -31,6 +31,25 @@ export interface GetClusterSnapshotCommandOutput extends GetClusterSnapshotOutpu
31
31
  * };
32
32
  * const command = new GetClusterSnapshotCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetClusterSnapshotOutput
35
+ * // snapshot: { // ClusterSnapshot
36
+ * // subnetIds: [ // StringList // required
37
+ * // "STRING_VALUE",
38
+ * // ],
39
+ * // snapshotName: "STRING_VALUE", // required
40
+ * // snapshotArn: "STRING_VALUE", // required
41
+ * // snapshotCreationTime: "STRING_VALUE", // required
42
+ * // clusterArn: "STRING_VALUE", // required
43
+ * // clusterCreationTime: "STRING_VALUE", // required
44
+ * // status: "STRING_VALUE", // required
45
+ * // vpcSecurityGroupIds: [ // required
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // adminUserName: "STRING_VALUE", // required
49
+ * // kmsKeyId: "STRING_VALUE", // required
50
+ * // },
51
+ * // };
52
+ *
34
53
  * ```
35
54
  *
36
55
  * @param GetClusterSnapshotCommandInput - {@link GetClusterSnapshotCommandInput}
@@ -54,6 +73,8 @@ export interface GetClusterSnapshotCommandOutput extends GetClusterSnapshotOutpu
54
73
  * @throws {@link ValidationException} (client fault)
55
74
  * <p>A structure defining a validation exception.</p>
56
75
  *
76
+ * @throws {@link DocDBElasticServiceException}
77
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
57
78
  *
58
79
  */
59
80
  export declare class GetClusterSnapshotCommand extends $Command<GetClusterSnapshotCommandInput, GetClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListClusterSnapshotsCommandOutput extends ListClusterSnapshotsO
33
33
  * };
34
34
  * const command = new ListClusterSnapshotsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListClusterSnapshotsOutput
37
+ * // snapshots: [ // ClusterSnapshotList
38
+ * // { // ClusterSnapshotInList
39
+ * // snapshotName: "STRING_VALUE", // required
40
+ * // snapshotArn: "STRING_VALUE", // required
41
+ * // clusterArn: "STRING_VALUE", // required
42
+ * // status: "STRING_VALUE", // required
43
+ * // snapshotCreationTime: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListClusterSnapshotsCommandInput - {@link ListClusterSnapshotsCommandInput}
@@ -53,6 +66,8 @@ export interface ListClusterSnapshotsCommandOutput extends ListClusterSnapshotsO
53
66
  * @throws {@link ValidationException} (client fault)
54
67
  * <p>A structure defining a validation exception.</p>
55
68
  *
69
+ * @throws {@link DocDBElasticServiceException}
70
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
56
71
  *
57
72
  */
58
73
  export declare class ListClusterSnapshotsCommand extends $Command<ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface ListClustersCommandOutput extends ListClustersOutput, __Metadat
32
32
  * };
33
33
  * const command = new ListClustersCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListClustersOutput
36
+ * // clusters: [ // ClusterList
37
+ * // { // ClusterInList
38
+ * // clusterName: "STRING_VALUE", // required
39
+ * // clusterArn: "STRING_VALUE", // required
40
+ * // status: "STRING_VALUE", // required
41
+ * // },
42
+ * // ],
43
+ * // nextToken: "STRING_VALUE",
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param ListClustersCommandInput - {@link ListClustersCommandInput}
@@ -52,6 +63,8 @@ export interface ListClustersCommandOutput extends ListClustersOutput, __Metadat
52
63
  * @throws {@link ValidationException} (client fault)
53
64
  * <p>A structure defining a validation exception.</p>
54
65
  *
66
+ * @throws {@link DocDBElasticServiceException}
67
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
55
68
  *
56
69
  */
57
70
  export declare class ListClustersCommand extends $Command<ListClustersCommandInput, ListClustersCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // TagMap
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -51,6 +57,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
51
57
  * @throws {@link ValidationException} (client fault)
52
58
  * <p>A structure defining a validation exception.</p>
53
59
  *
60
+ * @throws {@link DocDBElasticServiceException}
61
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
54
62
  *
55
63
  */
56
64
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -42,6 +42,28 @@ export interface RestoreClusterFromSnapshotCommandOutput extends RestoreClusterF
42
42
  * };
43
43
  * const command = new RestoreClusterFromSnapshotCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // RestoreClusterFromSnapshotOutput
46
+ * // cluster: { // Cluster
47
+ * // clusterName: "STRING_VALUE", // required
48
+ * // clusterArn: "STRING_VALUE", // required
49
+ * // status: "STRING_VALUE", // required
50
+ * // clusterEndpoint: "STRING_VALUE", // required
51
+ * // createTime: "STRING_VALUE", // required
52
+ * // adminUserName: "STRING_VALUE", // required
53
+ * // authType: "STRING_VALUE", // required
54
+ * // shardCapacity: Number("int"), // required
55
+ * // shardCount: Number("int"), // required
56
+ * // vpcSecurityGroupIds: [ // StringList // required
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // subnetIds: [ // required
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
63
+ * // kmsKeyId: "STRING_VALUE", // required
64
+ * // },
65
+ * // };
66
+ *
45
67
  * ```
46
68
  *
47
69
  * @param RestoreClusterFromSnapshotCommandInput - {@link RestoreClusterFromSnapshotCommandInput}
@@ -71,6 +93,8 @@ export interface RestoreClusterFromSnapshotCommandOutput extends RestoreClusterF
71
93
  * @throws {@link ValidationException} (client fault)
72
94
  * <p>A structure defining a validation exception.</p>
73
95
  *
96
+ * @throws {@link DocDBElasticServiceException}
97
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
74
98
  *
75
99
  */
76
100
  export declare class RestoreClusterFromSnapshotCommand extends $Command<RestoreClusterFromSnapshotCommandInput, RestoreClusterFromSnapshotCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -54,6 +56,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
54
56
  * @throws {@link ValidationException} (client fault)
55
57
  * <p>A structure defining a validation exception.</p>
56
58
  *
59
+ * @throws {@link DocDBElasticServiceException}
60
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
57
61
  *
58
62
  */
59
63
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -54,6 +56,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
54
56
  * @throws {@link ValidationException} (client fault)
55
57
  * <p>A structure defining a validation exception.</p>
56
58
  *
59
+ * @throws {@link DocDBElasticServiceException}
60
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
57
61
  *
58
62
  */
59
63
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, DocDBElasticClientResolvedConfig> {
@@ -44,6 +44,28 @@ export interface UpdateClusterCommandOutput extends UpdateClusterOutput, __Metad
44
44
  * };
45
45
  * const command = new UpdateClusterCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // UpdateClusterOutput
48
+ * // cluster: { // Cluster
49
+ * // clusterName: "STRING_VALUE", // required
50
+ * // clusterArn: "STRING_VALUE", // required
51
+ * // status: "STRING_VALUE", // required
52
+ * // clusterEndpoint: "STRING_VALUE", // required
53
+ * // createTime: "STRING_VALUE", // required
54
+ * // adminUserName: "STRING_VALUE", // required
55
+ * // authType: "STRING_VALUE", // required
56
+ * // shardCapacity: Number("int"), // required
57
+ * // shardCount: Number("int"), // required
58
+ * // vpcSecurityGroupIds: [ // StringList // required
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // subnetIds: [ // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
65
+ * // kmsKeyId: "STRING_VALUE", // required
66
+ * // },
67
+ * // };
68
+ *
47
69
  * ```
48
70
  *
49
71
  * @param UpdateClusterCommandInput - {@link UpdateClusterCommandInput}
@@ -70,6 +92,8 @@ export interface UpdateClusterCommandOutput extends UpdateClusterOutput, __Metad
70
92
  * @throws {@link ValidationException} (client fault)
71
93
  * <p>A structure defining a validation exception.</p>
72
94
  *
95
+ * @throws {@link DocDBElasticServiceException}
96
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
73
97
  *
74
98
  */
75
99
  export declare class UpdateClusterCommand extends $Command<UpdateClusterCommandInput, UpdateClusterCommandOutput, DocDBElasticClientResolvedConfig> {
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.325.0",
4
+ "version": "3.326.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",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",