@aws-sdk/client-dsql 3.705.0 → 3.706.0

package/dist-types/commands/CreateClusterCommand.d.ts

@@ -82,6 +82,20 @@ declare const CreateClusterCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Create Cluster
+ * ```javascript
+ * //
+ * const input = {
+ *   "deletionProtectionEnabled": false,
+ *   "tags": {
+ *     "MyKey": "MyValue"
+ *   }
+ * };
+ * const command = new CreateClusterCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreateClusterCommand extends CreateClusterCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateMultiRegionClustersCommand.d.ts

@@ -91,6 +91,29 @@ declare const CreateMultiRegionClustersCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Create Multi Region Clusters
+ * ```javascript
+ * //
+ * const input = {
+ *   "linkedRegionList": [
+ *     "us-east-1",
+ *     "us-east-2"
+ *   ],
+ *   "witnessRegion": "us-west-2"
+ * };
+ * const command = new CreateMultiRegionClustersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "linkedClusterArns": [
+ *     "arn:aws:xanadu:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345",
+ *     "arn:aws:xanadu:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321"
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreateMultiRegionClustersCommand extends CreateMultiRegionClustersCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteClusterCommand.d.ts

@@ -79,6 +79,17 @@ declare const DeleteClusterCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Delete Cluster
+ * ```javascript
+ * //
+ * const input = {
+ *   "identifier": "kiqenqglxyl2snyvkvnj2c3s2e"
+ * };
+ * const command = new DeleteClusterCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteClusterCommand extends DeleteClusterCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteMultiRegionClustersCommand.d.ts

@@ -75,6 +75,20 @@ declare const DeleteMultiRegionClustersCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Delete Multi Region Clusters
+ * ```javascript
+ * //
+ * const input = {
+ *   "linkedClusterArns": [
+ *     "arn:aws:xanadu:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345",
+ *     "arn:aws:xanadu:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321"
+ *   ]
+ * };
+ * const command = new DeleteMultiRegionClustersCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteMultiRegionClustersCommand extends DeleteMultiRegionClustersCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetClusterCommand.d.ts

@@ -79,6 +79,17 @@ declare const GetClusterCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Get Cluster
+ * ```javascript
+ * //
+ * const input = {
+ *   "identifier": "kiqenqglxyl2snyvkvnj2c3s2e"
+ * };
+ * const command = new GetClusterCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetClusterCommand extends GetClusterCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListClustersCommand.d.ts

@@ -78,6 +78,17 @@ declare const ListClustersCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example List Clusters
+ * ```javascript
+ * //
+ * const input = {
+ *   "maxResults": 20
+ * };
+ * const command = new ListClustersCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class ListClustersCommand extends ListClustersCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -73,6 +73,17 @@ declare const ListTagsForResourceCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example List Tags For Resource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/TagResourceCommand.d.ts

@@ -75,6 +75,20 @@ declare const TagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Tag Resource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e",
+ *   "tags": {
+ *     "MyKey": "MyValue"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -72,6 +72,21 @@ declare const UntagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Untag Resource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e",
+ *   "tagKeys": [
+ *     "MyKeyA",
+ *     "MyKeyB"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/UpdateClusterCommand.d.ts

@@ -84,6 +84,18 @@ declare const UpdateClusterCommand_base: {
  * <p>Base exception class for all service exceptions from DSQL service.</p>
  *
  * @public
+ * @example Update Cluster
+ * ```javascript
+ * //
+ * const input = {
+ *   "deletionProtectionEnabled": false,
+ *   "identifier": "kiqenqglxyl2snyvkvnj2c3s2e"
+ * };
+ * const command = new UpdateClusterCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class UpdateClusterCommand extends UpdateClusterCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-dsql",
   "description": "AWS SDK for JavaScript Dsql Client for Node.js, Browser and React Native",
-  "version": "3.705.0",
+  "version": "3.706.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",