@aws-sdk/client-kms 3.529.1 → 3.535.0

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

@@ -22,10 +22,10 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
 }
 declare const UpdateCustomKeyStoreCommand_base: {
     new (input: UpdateCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Changes the properties of a custom key store. You can use this operation to change the
  *       properties of an CloudHSM key store or an external key store.</p>
  *          <p>Use the required <code>CustomKeyStoreId</code> parameter to identify the custom key store.
@@ -313,6 +313,7 @@ declare const UpdateCustomKeyStoreCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
+ * @public
  * @example To edit the friendly name of a custom key store
  * ```javascript
  * // This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.

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

@@ -22,10 +22,10 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
 }
 declare const UpdateKeyDescriptionCommand_base: {
     new (input: UpdateKeyDescriptionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateKeyDescriptionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
  *          <p>The KMS key that you use for this operation must be in a compatible key state. For
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -112,6 +112,7 @@ declare const UpdateKeyDescriptionCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
+ * @public
  * @example To update the description of a KMS key
  * ```javascript
  * // The following example updates the description of the specified KMS key.

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

@@ -22,10 +22,10 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
 }
 declare const UpdatePrimaryRegionCommand_base: {
     new (input: UpdatePrimaryRegionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdatePrimaryRegionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Changes the primary key of a multi-Region key. </p>
  *          <p>This operation changes the replica key in the specified Region to a primary key and
  *       changes the former primary key to a replica key. For example, suppose you have a primary key
@@ -158,6 +158,7 @@ declare const UpdatePrimaryRegionCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
+ * @public
  * @example To update the primary Region of a multi-Region KMS key
  * ```javascript
  * // The following UpdatePrimaryRegion example changes the multi-Region replica key in the eu-central-1 Region to the primary key. The current primary key in the us-west-1 Region becomes a replica key.

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

@@ -22,10 +22,10 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
 }
 declare const VerifyCommand_base: {
     new (input: VerifyCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyCommandInput, VerifyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: VerifyCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyCommandInput, VerifyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
  *          <p></p>
  *          <p>Verification confirms that an authorized user signed the message with the specified KMS
@@ -72,9 +72,9 @@ declare const VerifyCommand_base: {
  * const client = new KMSClient(config);
  * const input = { // VerifyRequest
  *   KeyId: "STRING_VALUE", // required
- *   Message: "BLOB_VALUE", // required
+ *   Message: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   MessageType: "RAW" || "DIGEST",
- *   Signature: "BLOB_VALUE", // required
+ *   Signature: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   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", // required
  *   GrantTokens: [ // GrantTokenList
  *     "STRING_VALUE",
@@ -171,6 +171,7 @@ declare const VerifyCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
+ * @public
  * @example To use an asymmetric KMS key to verify a digital signature
  * ```javascript
  * // This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.

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

@@ -22,10 +22,10 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
 }
 declare const VerifyMacCommand_base: {
     new (input: VerifyMacCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyMacCommandInput, VerifyMacCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: VerifyMacCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyMacCommandInput, VerifyMacCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * @public
  * <p>Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC
  *       KMS key, and MAC algorithm. To verify the HMAC, <code>VerifyMac</code> computes an HMAC using
  *       the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC
@@ -57,10 +57,10 @@ declare const VerifyMacCommand_base: {
  * // const { KMSClient, VerifyMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
  * const client = new KMSClient(config);
  * const input = { // VerifyMacRequest
- *   Message: "BLOB_VALUE", // required
+ *   Message: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   KeyId: "STRING_VALUE", // required
  *   MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required
- *   Mac: "BLOB_VALUE", // required
+ *   Mac: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
  *   GrantTokens: [ // GrantTokenList
  *     "STRING_VALUE",
  *   ],
@@ -152,6 +152,7 @@ declare const VerifyMacCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
+ * @public
  * @example To verify an HMAC
  * ```javascript
  * // This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the MacValid value in the response indicates that the HMAC is valid.