@aws-sdk/client-kms 3.346.0 → 3.347.1

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

@@ -186,6 +186,90 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
  * // example id: to-retrieve-the-public-key-and-import-token-for-a-cmk-1480626483211
  * ```
  *
+ * @example To download the public key and import token for a symmetric encryption KMS key
+ * ```javascript
+ * // The following example downloads a public key and import token to import symmetric encryption key material. It uses the default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "WrappingAlgorithm": "RSAES_OAEP_SHA_1",
+ *   "WrappingKeySpec": "RSA_2048"
+ * };
+ * const command = new GetParametersForImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ParametersValidTo": "2023-02-01T14:52:17-08:00",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-download-the-public-key-and-import-token-1
+ * ```
+ *
+ * @example To download the public key and import token for an RSA asymmetric KMS key
+ * ```javascript
+ * // The following example downloads a public key and import token to import an RSA private key. It uses a required RSA_AES wrapping algorithm and the largest supported private key.
+ * const input = {
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab",
+ *   "WrappingAlgorithm": "RSA_AES_KEY_WRAP_SHA_256",
+ *   "WrappingKeySpec": "RSA_4096"
+ * };
+ * const command = new GetParametersForImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ParametersValidTo": "2023-03-08T13:02:02-07:00",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-download-the-public-key-and-import-token-2
+ * ```
+ *
+ * @example To download the public key and import token for an elliptic curve (ECC) asymmetric KMS key
+ * ```javascript
+ * // The following example downloads a public key and import token to import an ECC_NIST_P521 (secp521r1) private key. You cannot directly wrap this ECC key under an RSA_2048 public key, although you can use an RSA_2048 public key with an RSA_AES wrapping algorithm to wrap any supported key material. This example requests an RSA_3072 public key for use with the RSAES_OAEP_SHA_256.
+ * const input = {
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab",
+ *   "WrappingAlgorithm": "RSAES_OAEP_SHA_256",
+ *   "WrappingKeySpec": "RSA_3072"
+ * };
+ * const command = new GetParametersForImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ParametersValidTo": "2023-09-12T03:15:01-20:00",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-download-the-public-key-and-import-token-3
+ * ```
+ *
+ * @example To download the public key and import token for an HMAC KMS key
+ * ```javascript
+ * // The following example downloads a public key and import token to import an HMAC key. It uses the RSAES_OAEP_SHA_256 wrapping algorithm and an RSA_4096 private key.
+ * const input = {
+ *   "KeyId": "2468abcd-12ab-34cd-56ef-1234567890ab",
+ *   "WrappingAlgorithm": "RSAES_OAEP_SHA_256",
+ *   "WrappingKeySpec": "RSA_4096"
+ * };
+ * const command = new GetParametersForImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/2468abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ParametersValidTo": "2023-04-02T13:02:02-07:00",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-download-the-public-key-and-import-token-4
+ * ```
+ *
  */
 export declare class GetParametersForImportCommand extends $Command<GetParametersForImportCommandInput, GetParametersForImportCommandOutput, KMSClientResolvedConfig> {
     readonly input: GetParametersForImportCommandInput;

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

@@ -226,6 +226,35 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
  * // example id: to-import-key-material-into-a-cmk-1480630551969
  * ```
  *
+ * @example To import key material into a KMS key
+ * ```javascript
+ * // The following example imports key material into the specified KMS key.
+ * const input = {
+ *   "EncryptedKeyMaterial": "<binary data>",
+ *   "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new ImportKeyMaterialCommand(input);
+ * await client.send(command);
+ * // example id: to-import-key-material-into-a-kms-key-1
+ * ```
+ *
+ * @example To import key material into a KMS key
+ * ```javascript
+ * // The following example imports key material that expires in 3 days. It might be part of an application that frequently reimports the same key material to comply with business rules or regulations.
+ * const input = {
+ *   "EncryptedKeyMaterial": "<binary data>",
+ *   "ExpirationModel": "KEY_MATERIAL_EXPIRES",
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ValidTo": "2023-09-30T00:00:00-00:00"
+ * };
+ * const command = new ImportKeyMaterialCommand(input);
+ * await client.send(command);
+ * // example id: to-import-key-material-into-a-kms-key-2
+ * ```
+ *
  */
 export declare class ImportKeyMaterialCommand extends $Command<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput, KMSClientResolvedConfig> {
     readonly input: ImportKeyMaterialCommandInput;

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.346.0",
+  "version": "3.347.1",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,36 +21,36 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.345.0",
-    "@aws-sdk/config-resolver": "3.342.0",
-    "@aws-sdk/credential-provider-node": "3.345.0",
-    "@aws-sdk/fetch-http-handler": "3.342.0",
-    "@aws-sdk/hash-node": "3.344.0",
-    "@aws-sdk/invalid-dependency": "3.342.0",
-    "@aws-sdk/middleware-content-length": "3.342.0",
-    "@aws-sdk/middleware-endpoint": "3.344.0",
-    "@aws-sdk/middleware-host-header": "3.342.0",
-    "@aws-sdk/middleware-logger": "3.342.0",
-    "@aws-sdk/middleware-recursion-detection": "3.342.0",
-    "@aws-sdk/middleware-retry": "3.342.0",
-    "@aws-sdk/middleware-serde": "3.342.0",
-    "@aws-sdk/middleware-signing": "3.342.0",
-    "@aws-sdk/middleware-stack": "3.342.0",
-    "@aws-sdk/middleware-user-agent": "3.345.0",
-    "@aws-sdk/node-config-provider": "3.342.0",
-    "@aws-sdk/node-http-handler": "3.344.0",
-    "@aws-sdk/smithy-client": "3.342.0",
-    "@aws-sdk/types": "3.342.0",
-    "@aws-sdk/url-parser": "3.342.0",
+    "@aws-sdk/client-sts": "3.347.1",
+    "@aws-sdk/config-resolver": "3.347.0",
+    "@aws-sdk/credential-provider-node": "3.347.0",
+    "@aws-sdk/fetch-http-handler": "3.347.0",
+    "@aws-sdk/hash-node": "3.347.0",
+    "@aws-sdk/invalid-dependency": "3.347.0",
+    "@aws-sdk/middleware-content-length": "3.347.0",
+    "@aws-sdk/middleware-endpoint": "3.347.0",
+    "@aws-sdk/middleware-host-header": "3.347.0",
+    "@aws-sdk/middleware-logger": "3.347.0",
+    "@aws-sdk/middleware-recursion-detection": "3.347.0",
+    "@aws-sdk/middleware-retry": "3.347.0",
+    "@aws-sdk/middleware-serde": "3.347.0",
+    "@aws-sdk/middleware-signing": "3.347.0",
+    "@aws-sdk/middleware-stack": "3.347.0",
+    "@aws-sdk/middleware-user-agent": "3.347.0",
+    "@aws-sdk/node-config-provider": "3.347.0",
+    "@aws-sdk/node-http-handler": "3.347.0",
+    "@aws-sdk/smithy-client": "3.347.0",
+    "@aws-sdk/types": "3.347.0",
+    "@aws-sdk/url-parser": "3.347.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.342.0",
-    "@aws-sdk/util-defaults-mode-node": "3.342.0",
-    "@aws-sdk/util-endpoints": "3.342.0",
-    "@aws-sdk/util-retry": "3.342.0",
-    "@aws-sdk/util-user-agent-browser": "3.345.0",
-    "@aws-sdk/util-user-agent-node": "3.345.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.347.0",
+    "@aws-sdk/util-defaults-mode-node": "3.347.0",
+    "@aws-sdk/util-endpoints": "3.347.0",
+    "@aws-sdk/util-retry": "3.347.0",
+    "@aws-sdk/util-user-agent-browser": "3.347.0",
+    "@aws-sdk/util-user-agent-node": "3.347.0",
     "@aws-sdk/util-utf8": "3.310.0",
     "@smithy/protocol-http": "^1.0.1",
     "@smithy/types": "^1.0.0",