@aws-sdk/client-kms 3.555.0 → 3.563.0

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

@@ -171,6 +171,18 @@ declare const EnableKeyRotationCommand_base: {
  * // example id: to-enable-automatic-rotation-of-key-material-1478629109677
  * ```
  *
+ * @example To enable automatic rotation of key material
+ * ```javascript
+ * // The following example enables automatic rotation with a rotation period of 365 days for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "RotationPeriodInDays": 365
+ * };
+ * const command = new EnableKeyRotationCommand(input);
+ * await client.send(command);
+ * // example id: to-enable-automatic-rotation-of-key-material-1712499675853
+ * ```
+ *
  */
 export declare class EnableKeyRotationCommand extends EnableKeyRotationCommand_base {
 }

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

@@ -181,6 +181,26 @@ declare const GetKeyRotationStatusCommand_base: {
  * // example id: to-retrieve-the-rotation-status-for-a-cmk-1479172287408
  * ```
  *
+ * @example To retrieve the rotation status for a KMS key
+ * ```javascript
+ * // The following example retrieves detailed information about the rotation status for a KMS key, including whether automatic key rotation is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new GetKeyRotationStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "KeyRotationEnabled": true,
+ *   "NextRotationDate": "2024-04-05T15:14:47.757000+00:00",
+ *   "OnDemandRotationStartDate": "2024-03-02T10:11:36.564000+00:00",
+ *   "RotationPeriodInDays": 365
+ * }
+ * *\/
+ * // example id: to-retrieve-the-rotation-status-for-a-kms-key-1712500357701
+ * ```
+ *
  */
 export declare class GetKeyRotationStatusCommand extends GetKeyRotationStatusCommand_base {
 }

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

@@ -141,6 +141,34 @@ declare const ListKeyRotationsCommand_base: {
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @public
+ * @example To retrieve information about all completed key material rotations
+ * ```javascript
+ * // The following example returns information about all completed key material rotations for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new ListKeyRotationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Rotations": [
+ *     {
+ *       "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "RotationDate": "2024-03-02T10:11:36.564000+00:00",
+ *       "RotationType": "AUTOMATIC"
+ *     },
+ *     {
+ *       "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "RotationDate": "2024-04-05T15:14:47.757000+00:00",
+ *       "RotationType": "ON_DEMAND"
+ *     }
+ *   ],
+ *   "Truncated": false
+ * }
+ * *\/
+ * // example id: to-retrieve-information-about-all-completed-key-material-rotations-1712585167775
+ * ```
+ *
  */
 export declare class ListKeyRotationsCommand extends ListKeyRotationsCommand_base {
 }

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

@@ -165,6 +165,22 @@ declare const RotateKeyOnDemandCommand_base: {
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @public
+ * @example To perform on-demand rotation of key material
+ * ```javascript
+ * // The following example immediately initiates rotation of the key material for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new RotateKeyOnDemandCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * }
+ * *\/
+ * // example id: to-perform-on-demand-rotation-of-key-material-1712499025700
+ * ```
+ *
  */
 export declare class RotateKeyOnDemandCommand extends RotateKeyOnDemandCommand_base {
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kms",
   "description": "AWS SDK for JavaScript Kms Client for Node.js, Browser and React Native",
-  "version": "3.555.0",
+  "version": "3.563.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-kms",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.554.0",
-    "@aws-sdk/core": "3.554.0",
-    "@aws-sdk/credential-provider-node": "3.554.0",
+    "@aws-sdk/client-sts": "3.556.0",
+    "@aws-sdk/core": "3.556.0",
+    "@aws-sdk/credential-provider-node": "3.563.0",
     "@aws-sdk/middleware-host-header": "3.535.0",
     "@aws-sdk/middleware-logger": "3.535.0",
     "@aws-sdk/middleware-recursion-detection": "3.535.0",