@aws-sdk/client-kms 3.325.0 → 3.326.0

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

@@ -78,6 +78,8 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
  * };
  * const command = new RetireGrantCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RetireGrantCommandInput - {@link RetireGrantCommandInput}
@@ -126,6 +128,8 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To retire a grant
  * ```javascript

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

@@ -75,6 +75,8 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
  * };
  * const command = new RevokeGrantCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RevokeGrantCommandInput - {@link RevokeGrantCommandInput}
@@ -120,6 +122,8 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To revoke a grant
  * ```javascript

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

@@ -87,6 +87,13 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
  * };
  * const command = new ScheduleKeyDeletionCommand(input);
  * const response = await client.send(command);
+ * // { // ScheduleKeyDeletionResponse
+ * //   KeyId: "STRING_VALUE",
+ * //   DeletionDate: new Date("TIMESTAMP"),
+ * //   KeyState: "Creating" || "Enabled" || "Disabled" || "PendingDeletion" || "PendingImport" || "PendingReplicaDeletion" || "Unavailable" || "Updating",
+ * //   PendingWindowInDays: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param ScheduleKeyDeletionCommandInput - {@link ScheduleKeyDeletionCommandInput}
@@ -129,6 +136,8 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To schedule a KMS key for deletion
  * ```javascript

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

@@ -88,6 +88,12 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
  * };
  * const command = new SignCommand(input);
  * const response = await client.send(command);
+ * // { // SignResponse
+ * //   KeyId: "STRING_VALUE",
+ * //   Signature: "BLOB_VALUE",
+ * //   SigningAlgorithm: "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
+ * // };
+ *
  * ```
  *
  * @param SignCommandInput - {@link SignCommandInput}
@@ -157,6 +163,8 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To digitally sign a message with an asymmetric KMS key.
  * ```javascript

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

@@ -83,6 +83,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -128,6 +130,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * @throws {@link TagException} (client fault)
  *  <p>The request was rejected because one or more tags are not valid.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To tag a KMS key
  * ```javascript

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

@@ -75,6 +75,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -116,6 +118,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * @throws {@link TagException} (client fault)
  *  <p>The request was rejected because one or more tags are not valid.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To remove tags from a KMS key
  * ```javascript

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

@@ -94,6 +94,8 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateAliasCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateAliasCommandInput - {@link UpdateAliasCommandInput}
@@ -136,6 +138,8 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To update an alias
  * ```javascript

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

@@ -134,6 +134,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  * };
  * const command = new UpdateCustomKeyStoreCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateCustomKeyStoreCommandInput - {@link UpdateCustomKeyStoreCommandInput}
@@ -298,6 +300,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  *       endpoint service includes the KMS service principal for the Region, such as
  *         <code>cks.kms.us-east-1.amazonaws.com</code>.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To edit the friendly name of a custom key store
  * ```javascript
@@ -327,7 +331,7 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  * ```javascript
  * // This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.
  * const input = {
- *   "CloudHsmClusterId": "cluster-1a23b4cdefg",
+ *   "CloudHsmClusterId": "cluster-234abcdefABC",
  *   "CustomKeyStoreId": "cks-1234567890abcdef0"
  * };
  * const command = new UpdateCustomKeyStoreCommand(input);

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

@@ -53,6 +53,8 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateKeyDescriptionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateKeyDescriptionCommandInput - {@link UpdateKeyDescriptionCommandInput}
@@ -95,6 +97,8 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To update the description of a KMS key
  * ```javascript

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

@@ -96,6 +96,8 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdatePrimaryRegionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdatePrimaryRegionCommandInput - {@link UpdatePrimaryRegionCommandInput}
@@ -141,6 +143,8 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
  *  <p>The request was rejected because a specified parameter is not supported or a specified
  *       resource is not valid for this operation.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To update the primary Region of a multi-Region KMS key
  * ```javascript

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

@@ -73,6 +73,12 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
  * };
  * const command = new VerifyCommand(input);
  * const response = await client.send(command);
+ * // { // VerifyResponse
+ * //   KeyId: "STRING_VALUE",
+ * //   SignatureValid: true || false,
+ * //   SigningAlgorithm: "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
+ * // };
+ *
  * ```
  *
  * @param VerifyCommandInput - {@link VerifyCommandInput}
@@ -147,6 +153,8 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To use an asymmetric KMS key to verify a digital signature
  * ```javascript

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

@@ -57,6 +57,12 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
  * };
  * const command = new VerifyMacCommand(input);
  * const response = await client.send(command);
+ * // { // VerifyMacResponse
+ * //   KeyId: "STRING_VALUE",
+ * //   MacValid: true || false,
+ * //   MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512",
+ * // };
+ *
  * ```
  *
  * @param VerifyMacCommandInput - {@link VerifyMacCommandInput}
@@ -127,6 +133,8 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
  *  <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  *
+ * @throws {@link KMSServiceException}
+ * <p>Base exception class for all service exceptions from KMS service.</p>
  *
  * @example To verify an HMAC
  * ```javascript

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.325.0",
+  "version": "3.326.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.325.0",
+    "@aws-sdk/client-sts": "3.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.325.0",
+    "@aws-sdk/credential-provider-node": "3.326.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",