@aws-sdk/client-kms 3.32.0 → 3.36.0

package/{dist/cjs → dist-cjs}/commands/DeleteAliasCommand.js

@@ -1,19 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeleteAliasCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Deletes the specified alias.  </p>
+ * <p>Deletes the specified alias. </p>
  *          <note>
  *             <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          </note>
- *          <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
+ *          <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of
+ *       a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the
+ *         <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
  *          <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to
- *       create a new alias. To associate an existing alias with a different KMS key,
- *       call <a>UpdateAlias</a>.</p>
+ *       create a new alias. To associate an existing alias with a different KMS key, call <a>UpdateAlias</a>.</p>
  *          <p>
  *             <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
  *          <p>
@@ -22,14 +23,17 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the alias (IAM policy).</p>
+ *                   <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
+ *           the alias (IAM policy).</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the KMS key (key policy).</p>
+ *                   <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
+ *           the KMS key (key policy).</p>
  *             </li>
  *          </ul>
- *          <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
+ *          <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
+ *       <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
  *             <b>Related operations:</b>
  *          </p>
@@ -101,4 +105,3 @@ class DeleteAliasCommand extends smithy_client_1.Command {
     }
 }
 exports.DeleteAliasCommand = DeleteAliasCommand;
-//# sourceMappingURL=DeleteAliasCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DeleteCustomKeyStoreCommand.js

@@ -1,23 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeleteCustomKeyStoreCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the CloudHSM cluster that is
  *       associated with the custom key store, or affect any users or keys in the cluster.</p>
- *          <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before
- *       deleting the key store, verify that you will never need to use any of the KMS keys in the key
- *       store for any <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the
- *       KMS keys from the key store. When the scheduled waiting period
- *       expires, the <code>ScheduleKeyDeletion</code> operation deletes the KMS keys. Then it makes a best
- *       effort to delete the key material from the associated cluster. However, you might need to
- *       manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
+ *          <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before deleting the key store,
+ *       verify that you will never need to use any of the KMS keys in the key store for any
+ *       <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the KMS keys from the
+ *       key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code>
+ *       operation deletes the KMS keys. Then it makes a best effort to delete the key material from
+ *       the associated cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
  *         material</a> from the cluster and its backups.</p>
- *          <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a> to
- *       disconnect the key store from KMS. Then, you can delete the custom key store.</p>
+ *          <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a>
+ *       to disconnect the key store from KMS. Then, you can delete the custom key store.</p>
  *          <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
  *       disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
  *       delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
@@ -26,9 +25,9 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
  * combines the convenience and extensive integration of KMS with the isolation and control of a
  * single-tenant key store.</p>
- *
  *          <p>
- *             <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
+ *             <b>Cross-account use</b>: No.
+ *       You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
  *
  *          <p>
  *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteCustomKeyStore</a> (IAM policy)</p>
@@ -113,4 +112,3 @@ class DeleteCustomKeyStoreCommand extends smithy_client_1.Command {
     }
 }
 exports.DeleteCustomKeyStoreCommand = DeleteCustomKeyStoreCommand;
-//# sourceMappingURL=DeleteCustomKeyStoreCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DeleteImportedKeyMaterialCommand.js

@@ -1,17 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeleteImportedKeyMaterialCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Deletes key material that you previously imported. This operation makes the specified
- *       KMS key unusable. For more information about importing key material into
- *       KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
- *         Material</a> in the <i>Key Management Service Developer Guide</i>. </p>
- *          <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does
- *       not change the KMS key's state. Otherwise, it changes the KMS key's state to
+ * <p>Deletes key material that you previously imported. This operation makes the specified KMS
+ *       key unusable. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
+ *       in the <i>Key Management Service Developer Guide</i>. </p>
+ *          <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation
+ *       does not change the KMS key's state. Otherwise, it changes the KMS key's state to
  *         <code>PendingImport</code>.</p>
  *          <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
  *       the same key material into the KMS key.</p>
@@ -88,4 +87,3 @@ class DeleteImportedKeyMaterialCommand extends smithy_client_1.Command {
     }
 }
 exports.DeleteImportedKeyMaterialCommand = DeleteImportedKeyMaterialCommand;
-//# sourceMappingURL=DeleteImportedKeyMaterialCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DescribeCustomKeyStoresCommand.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DescribeCustomKeyStoresCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and Region.</p>
  *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
  * combines the convenience and extensive integration of KMS with the isolation and control of a
  * single-tenant key store.</p>
- *          <p>By default, this operation returns information about all custom key stores in the account and
- *       Region. To get only information about a particular custom key store, use either the
- *         <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not
- *       both).</p>
+ *          <p>By default, this operation returns information about all custom key
+ *       stores in the account and Region. To get only information about a particular custom key store,
+ *       use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but
+ *       not both).</p>
  *          <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
  *         <code>ConnectionState</code> element in the response. If an attempt to connect the custom
  *       key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
@@ -111,4 +111,3 @@ class DescribeCustomKeyStoresCommand extends smithy_client_1.Command {
     }
 }
 exports.DescribeCustomKeyStoresCommand = DescribeCustomKeyStoresCommand;
-//# sourceMappingURL=DescribeCustomKeyStoresCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DescribeKeyCommand.js

@@ -1,21 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DescribeKeyCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Provides detailed information about a KMS key. You can run
- *         <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
+ * <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
+ *         <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
+ *         key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
  *          <p>This detailed information includes the key ARN, creation date (and deletion date, if
  *       applicable), the key state, and the origin and expiration date (if any) of the key material.
  *       It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
  *       asymmetric KMS keys. It also provides information that is particularly important to asymmetric
  *       keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
- *       algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about
- *       the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region
- *       keys, it displays the primary key and all related replica keys. </p>
+ *       algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
+ *       information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For
+ *       multi-Region keys, it displays the primary key and all related replica keys. </p>
  *          <p>
  *             <code>DescribeKey</code> does not return the following information:</p>
  *          <ul>
@@ -24,8 +25,8 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *             </li>
  *             <li>
  *                <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
- *             <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from being
- *           automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation
+ *             <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
+ *           being automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation
  *             Works</a> in <i>Key Management Service Developer Guide</i>.</p>
  *             </li>
  *             <li>
@@ -35,9 +36,10 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *                <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
  *             </li>
  *          </ul>
- *          <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services alias</i>, that is, an Amazon Web Services alias with no key ID, KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.
- *       Then, it associates the alias with the new KMS key, and returns the <code>KeyId</code> and
- *         <code>Arn</code> of the new KMS key in the response.</p>
+ *          <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
+ *         alias</i>, that is, an Amazon Web Services alias with no key ID, KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
+ *         key</a>. Then, it associates the alias with the new KMS key, and returns the
+ *         <code>KeyId</code> and <code>Arn</code> of the new KMS key in the response.</p>
  *          <p>
  *             <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
  *   the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
@@ -135,4 +137,3 @@ class DescribeKeyCommand extends smithy_client_1.Command {
     }
 }
 exports.DescribeKeyCommand = DescribeKeyCommand;
-//# sourceMappingURL=DescribeKeyCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DisableKeyCommand.js

@@ -1,19 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DisableKeyCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Sets the state of a KMS key to disabled. This change temporarily
- *       prevents use of the KMS key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
- *          <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>
+ * <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
+ *       key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
+ *          <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS
+ *         key</a> in the <i>
  *                <i>Key Management Service Developer Guide</i>
  *             </i>.</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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
- *          <p>
+ *         <p>
  *             <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
  *
  *          <p>
@@ -72,4 +73,3 @@ class DisableKeyCommand extends smithy_client_1.Command {
     }
 }
 exports.DisableKeyCommand = DisableKeyCommand;
-//# sourceMappingURL=DisableKeyCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DisableKeyRotationCommand.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DisableKeyRotationCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
  *         rotation of the key material</a> for the specified symmetric KMS key.</p>
@@ -12,7 +12,8 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
+ *             <b>Cross-account
+ *         use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
  *
  *          <p>
  *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKeyRotation</a> (key policy)</p>
@@ -82,4 +83,3 @@ class DisableKeyRotationCommand extends smithy_client_1.Command {
     }
 }
 exports.DisableKeyRotationCommand = DisableKeyRotationCommand;
-//# sourceMappingURL=DisableKeyRotationCommand.js.map

package/{dist/cjs → dist-cjs}/commands/DisconnectCustomKeyStoreCommand.js

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DisconnectCustomKeyStoreCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated CloudHSM cluster. While a custom key
- *       store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use KMS keys in the custom key store. You can reconnect the
- *       custom key store at any time.</p>
+ *       store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
+ *       create or use KMS keys in the custom key store. You can reconnect the custom key store at any
+ *       time.</p>
  *          <note>
  *             <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will
  *         fail. This action can prevent users from storing and accessing sensitive data.</p>
@@ -22,8 +23,9 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  * combines the convenience and extensive integration of KMS with the isolation and control of a
  * single-tenant key store.</p>
  *
- *          <p>
- *             <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
+ *         <p>
+ *             <b>Cross-account use</b>: No.
+ *       You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
  *
  *          <p>
  *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisconnectCustomKeyStore</a> (IAM policy)</p>
@@ -108,4 +110,3 @@ class DisconnectCustomKeyStoreCommand extends smithy_client_1.Command {
     }
 }
 exports.DisconnectCustomKeyStoreCommand = DisconnectCustomKeyStoreCommand;
-//# sourceMappingURL=DisconnectCustomKeyStoreCommand.js.map

package/{dist/cjs → dist-cjs}/commands/EnableKeyCommand.js

@@ -1,16 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnableKeyCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
+ * <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
+ *       <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
+ *             <b>Cross-account
+ *       use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
  *
  *          <p>
  *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKey</a> (key policy)</p>
@@ -68,4 +70,3 @@ class EnableKeyCommand extends smithy_client_1.Command {
     }
 }
 exports.EnableKeyCommand = EnableKeyCommand;
-//# sourceMappingURL=EnableKeyCommand.js.map

package/{dist/cjs → dist-cjs}/commands/EnableKeyRotationCommand.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnableKeyRotationCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
  *         of the key material</a> for the specified symmetric KMS key.</p>
@@ -12,7 +12,8 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
+ *             <b>Cross-account
+ *         use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
  *
  *          <p>
  *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKeyRotation</a> (key policy)</p>
@@ -82,4 +83,3 @@ class EnableKeyRotationCommand extends smithy_client_1.Command {
     }
 }
 exports.EnableKeyRotationCommand = EnableKeyRotationCommand;
-//# sourceMappingURL=EnableKeyRotationCommand.js.map

package/{dist/cjs → dist-cjs}/commands/EncryptCommand.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncryptCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
- * <p>Encrypts plaintext into ciphertext by using a KMS key. The
- *         <code>Encrypt</code> operation has two primary use cases:</p>
+ * <p>Encrypts plaintext into ciphertext by using a KMS key. The <code>Encrypt</code> operation
+ *       has two primary use cases:</p>
  *          <ul>
  *             <li>
  *                <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or
  *           database password, or other sensitive information. </p>
  *             </li>
  *             <li>
- *                <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt
- *           your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the
- *           plaintext data key under a KMS key in Region B. Now, you can move the encrypted data and the
- *           encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and
- *           the encrypted data entirely within in Region B.</p>
+ *                <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services
+ *           Region to another. For example, in Region A, generate a data key and use the plaintext key
+ *           to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt
+ *           the plaintext data key under a KMS key in Region B. Now, you can move the encrypted data
+ *           and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data
+ *           key and the encrypted data entirely within in Region B.</p>
  *             </li>
  *          </ul>
  *
@@ -29,10 +30,10 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *       encryption operation. The KMS key must have a <code>KeyUsage</code> value of
  *         <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
  *
- *          <p>If you use a symmetric KMS key, you can use an encryption context to add additional security
- *       to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting
- *       data, you must specify the same encryption context (a case-sensitive exact match) when
- *       decrypting the data. Otherwise, the request to decrypt fails with an
+ *          <p>If you use a symmetric KMS key, you can use an encryption context to add additional
+ *       security to your encryption operation. If you specify an <code>EncryptionContext</code> when
+ *       encrypting data, you must specify the same encryption context (a case-sensitive exact match)
+ *       when decrypting the data. Otherwise, the request to decrypt fails with an
  *         <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
  *         Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
@@ -104,7 +105,8 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
+ *             <b>Cross-account use</b>: Yes.
+ *       To perform this operation with a KMS key in a different Amazon Web Services account, specify
  *   the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
  *
  *          <p>
@@ -180,4 +182,3 @@ class EncryptCommand extends smithy_client_1.Command {
     }
 }
 exports.EncryptCommand = EncryptCommand;
-//# sourceMappingURL=EncryptCommand.js.map

package/{dist/cjs → dist-cjs}/commands/GenerateDataKeyCommand.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateDataKeyCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
- *       plaintext copy of the data key and a copy that is encrypted under a KMS key
- *       that you specify. You can use the plaintext key to encrypt your data outside of KMS and
- *       store the encrypted data key with the encrypted data.</p>
+ *       plaintext copy of the data key and a copy that is encrypted under a KMS key that you specify.
+ *       You can use the plaintext key to encrypt your data outside of KMS and store the encrypted
+ *       data key with the encrypted data.</p>
  *
  *          <p>
  *             <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
  *       plaintext key are not related to the caller or the KMS key.</p>
  *
- *          <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the data
- *       key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use
- *       the <a>DescribeKey</a> operation. You must also specify the length of the data key.
- *       Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both).
- *       For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
+ *          <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the
+ *       data key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your
+ *       KMS key, use the <a>DescribeKey</a> operation. You must also specify the length of
+ *       the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters
+ *       (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
  *
  *          <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use
  *       the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure
@@ -34,11 +34,14 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>How to use your data key</b>
+ *             <b>How to use your data
+ *         key</b>
  *          </p>
- *          <p>We recommend that you use the following pattern to encrypt data locally in your application.
- *       You can write your own code or use a client-side encryption library, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a>, the <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>, or
- *         <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
+ *          <p>We recommend that you use the following pattern to encrypt data locally in your
+ *       application. You can write your own code or use a client-side encryption library, such as the
+ *         <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a>, the
+ *         <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>,
+ *       or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
  *         client-side encryption</a> to do these tasks for you.</p>
  *          <p>To encrypt data outside of KMS:</p>
  *          <ol>
@@ -152,4 +155,3 @@ class GenerateDataKeyCommand extends smithy_client_1.Command {
     }
 }
 exports.GenerateDataKeyCommand = GenerateDataKeyCommand;
-//# sourceMappingURL=GenerateDataKeyCommand.js.map

package/{dist/cjs → dist-cjs}/commands/GenerateDataKeyPairCommand.js

@@ -1,27 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateDataKeyPairCommand = void 0;
-const models_0_1 = require("../models/models_0");
-const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 const middleware_serde_1 = require("@aws-sdk/middleware-serde");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
 /**
  * <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
  *       operation returns a plaintext public key, a plaintext private key, and a copy of the private
- *       key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to
- *       perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
+ *       key that is encrypted under the symmetric KMS key you specify. You can use the data key pair
+ *       to perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
  *
  *          <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
  *       or verify a signature outside of KMS. Then, store the encrypted private key with the data.
  *       When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
  *
- *          <p>To generate a data key pair, you must specify a symmetric KMS key to
- *       encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
- *       custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
+ *          <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt the private
+ *       key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key
+ *       store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
+ *       operation. </p>
  *          <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
- *       key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
- *       for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
- *       on the use of data key pairs outside of KMS.</p>
+ *       key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
+ *       either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
+ *       the use of data key pairs outside of KMS.</p>
  *
  *          <p>If you are using the data key pair to encrypt data, or for any operation where you don't
  *       immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
@@ -33,10 +34,10 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *
  *          <p>
  *             <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
- *       bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private
- *       key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The
- *       private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC
- *         5958</a>.</p>
+ *       bytes in the keys are not related to the caller or the KMS key that is used to encrypt the
+ *       private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
+ *         <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The private key is a
+ *       DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</p>
  *
  *          <p>You can use the optional encryption context to add additional security to the encryption
  *       operation. If you specify an <code>EncryptionContext</code>, you must specify the same
@@ -46,7 +47,8 @@ const smithy_client_1 = require("@aws-sdk/smithy-client");
  *          <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 state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
  *          <p>
- *             <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
+ *             <b>Cross-account
+ *         use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
  *   the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
  *
  *          <p>
@@ -132,4 +134,3 @@ class GenerateDataKeyPairCommand extends smithy_client_1.Command {
     }
 }
 exports.GenerateDataKeyPairCommand = GenerateDataKeyPairCommand;
-//# sourceMappingURL=GenerateDataKeyPairCommand.js.map