@aws-sdk/client-kms 3.36.0 → 3.39.0

package/dist-cjs/commands/UpdateKeyDescriptionCommand.js

@@ -5,58 +5,11 @@ 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>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 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>
- *
- *          <p>
- *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
- *          <p>
- *             <b>Related operations</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateKey</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DescribeKey</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { KMSClient, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import
- * // const { KMSClient, UpdateKeyDescriptionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
- * const client = new KMSClient(config);
- * const command = new UpdateKeyDescriptionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateKeyDescriptionCommandInput} for command's `input` shape.
- * @see {@link UpdateKeyDescriptionCommandOutput} for command's `response` shape.
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
- *
- */
 class UpdateKeyDescriptionCommand extends smithy_client_1.Command {
-    // Start section: command_properties
-    // End section: command_properties
     constructor(input) {
-        // Start section: command_constructor
         super();
         this.input = input;
-        // End section: command_constructor
     }
-    /**
-     * @internal
-     */
     resolveMiddleware(clientStack, configuration, options) {
         this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
         const stack = clientStack.concat(this.middlewareStack);

package/dist-cjs/commands/UpdatePrimaryRegionCommand.js

@@ -5,100 +5,11 @@ 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>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
- *       in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
- *         <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
- *         <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
- *       key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update">Updating the primary Region</a> in the <i>Key Management Service Developer Guide</i>.</p>
- *          <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
- *       interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
- *       material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
- *       it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
- *          <p>The <i>primary key</i> of a multi-Region key is the source for properties
- *       that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
- *       origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
- *         key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
- *         key</a> until all replica keys are deleted.</p>
- *          <p>The key ID and primary Region that you specify uniquely identify the replica key that will
- *       become the primary key. The primary Region must already have a replica key. This operation
- *       does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
- *       key, use the <a>ReplicateKey</a> operation.</p>
- *          <p>You can run this operation while using the affected multi-Region keys in cryptographic
- *       operations. This operation should not delay, interrupt, or cause failures in cryptographic
- *       operations. </p>
- *          <p>Even after this operation completes, the process of updating the primary Region might
- *       still be in progress for a few more seconds. Operations such as <code>DescribeKey</code> might
- *       display both the old and new primary keys as replicas. The old and new primary keys have a
- *       transient key state of <code>Updating</code>. The original key state is restored when the
- *       update is complete. While the key state is <code>Updating</code>, you can use the keys in
- *       cryptographic operations, but you cannot replicate the new primary key or perform certain
- *       management operations, such as enabling or disabling these keys. For details about the
- *         <code>Updating</code> key state, see <a href="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>This operation does not return any output. To verify that primary key is changed, use the
- *         <a>DescribeKey</a> operation.</p>
- *          <p>
- *             <b>Cross-account use</b>: No. You cannot use this operation in a
- *       different Amazon Web Services account. </p>
- *          <p>
- *             <b>Required permissions</b>: </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
- *           Region). Include this permission primary key's key policy.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
- *           Region). Include this permission in the replica key's key policy.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>Related operations</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateKey</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ReplicateKey</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { KMSClient, UpdatePrimaryRegionCommand } from "@aws-sdk/client-kms"; // ES Modules import
- * // const { KMSClient, UpdatePrimaryRegionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
- * const client = new KMSClient(config);
- * const command = new UpdatePrimaryRegionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdatePrimaryRegionCommandInput} for command's `input` shape.
- * @see {@link UpdatePrimaryRegionCommandOutput} for command's `response` shape.
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
- *
- */
 class UpdatePrimaryRegionCommand extends smithy_client_1.Command {
-    // Start section: command_properties
-    // End section: command_properties
     constructor(input) {
-        // Start section: command_constructor
         super();
         this.input = input;
-        // End section: command_constructor
     }
-    /**
-     * @internal
-     */
     resolveMiddleware(clientStack, configuration, options) {
         this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
         const stack = clientStack.concat(this.middlewareStack);

package/dist-cjs/commands/VerifyCommand.js

@@ -5,65 +5,11 @@ 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>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
- *       key and signing algorithm, and the message hasn't changed since it was signed. If the
- *       signature is verified, the value of the <code>SignatureValid</code> field in the response is
- *         <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
- *       fails with an <code>KMSInvalidSignatureException</code> exception.</p>
- *          <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
- *       signature is verified by using the public key in the same asymmetric KMS key.
- *       For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
- *          <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
- *       same asymmetric KMS key, message, and signing algorithm that were used to produce the
- *       signature.</p>
- *          <p>You can also verify the digital signature by using the public key of the KMS key outside
- *       of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
- *       asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
- *       advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
- *       a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
- *       in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
- *       the KMS key to verify signatures.</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>: 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>
- *             <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Verify</a> (key policy)</p>
- *          <p>
- *             <b>Related operations</b>: <a>Sign</a>
- *          </p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { KMSClient, VerifyCommand } from "@aws-sdk/client-kms"; // ES Modules import
- * // const { KMSClient, VerifyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
- * const client = new KMSClient(config);
- * const command = new VerifyCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link VerifyCommandInput} for command's `input` shape.
- * @see {@link VerifyCommandOutput} for command's `response` shape.
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
- *
- */
 class VerifyCommand extends smithy_client_1.Command {
-    // Start section: command_properties
-    // End section: command_properties
     constructor(input) {
-        // Start section: command_constructor
         super();
         this.input = input;
-        // End section: command_constructor
     }
-    /**
-     * @internal
-     */
     resolveMiddleware(clientStack, configuration, options) {
         this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
         const stack = clientStack.concat(this.middlewareStack);

package/dist-cjs/commands/index.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./CancelKeyDeletionCommand"), exports);
+tslib_1.__exportStar(require("./ConnectCustomKeyStoreCommand"), exports);
+tslib_1.__exportStar(require("./CreateAliasCommand"), exports);
+tslib_1.__exportStar(require("./CreateCustomKeyStoreCommand"), exports);
+tslib_1.__exportStar(require("./CreateGrantCommand"), exports);
+tslib_1.__exportStar(require("./CreateKeyCommand"), exports);
+tslib_1.__exportStar(require("./DecryptCommand"), exports);
+tslib_1.__exportStar(require("./DeleteAliasCommand"), exports);
+tslib_1.__exportStar(require("./DeleteCustomKeyStoreCommand"), exports);
+tslib_1.__exportStar(require("./DeleteImportedKeyMaterialCommand"), exports);
+tslib_1.__exportStar(require("./DescribeCustomKeyStoresCommand"), exports);
+tslib_1.__exportStar(require("./DescribeKeyCommand"), exports);
+tslib_1.__exportStar(require("./DisableKeyCommand"), exports);
+tslib_1.__exportStar(require("./DisableKeyRotationCommand"), exports);
+tslib_1.__exportStar(require("./DisconnectCustomKeyStoreCommand"), exports);
+tslib_1.__exportStar(require("./EnableKeyCommand"), exports);
+tslib_1.__exportStar(require("./EnableKeyRotationCommand"), exports);
+tslib_1.__exportStar(require("./EncryptCommand"), exports);
+tslib_1.__exportStar(require("./GenerateDataKeyCommand"), exports);
+tslib_1.__exportStar(require("./GenerateDataKeyPairCommand"), exports);
+tslib_1.__exportStar(require("./GenerateDataKeyPairWithoutPlaintextCommand"), exports);
+tslib_1.__exportStar(require("./GenerateDataKeyWithoutPlaintextCommand"), exports);
+tslib_1.__exportStar(require("./GenerateRandomCommand"), exports);
+tslib_1.__exportStar(require("./GetKeyPolicyCommand"), exports);
+tslib_1.__exportStar(require("./GetKeyRotationStatusCommand"), exports);
+tslib_1.__exportStar(require("./GetParametersForImportCommand"), exports);
+tslib_1.__exportStar(require("./GetPublicKeyCommand"), exports);
+tslib_1.__exportStar(require("./ImportKeyMaterialCommand"), exports);
+tslib_1.__exportStar(require("./ListAliasesCommand"), exports);
+tslib_1.__exportStar(require("./ListGrantsCommand"), exports);
+tslib_1.__exportStar(require("./ListKeyPoliciesCommand"), exports);
+tslib_1.__exportStar(require("./ListKeysCommand"), exports);
+tslib_1.__exportStar(require("./ListResourceTagsCommand"), exports);
+tslib_1.__exportStar(require("./ListRetirableGrantsCommand"), exports);
+tslib_1.__exportStar(require("./PutKeyPolicyCommand"), exports);
+tslib_1.__exportStar(require("./ReEncryptCommand"), exports);
+tslib_1.__exportStar(require("./ReplicateKeyCommand"), exports);
+tslib_1.__exportStar(require("./RetireGrantCommand"), exports);
+tslib_1.__exportStar(require("./RevokeGrantCommand"), exports);
+tslib_1.__exportStar(require("./ScheduleKeyDeletionCommand"), exports);
+tslib_1.__exportStar(require("./SignCommand"), exports);
+tslib_1.__exportStar(require("./TagResourceCommand"), exports);
+tslib_1.__exportStar(require("./UntagResourceCommand"), exports);
+tslib_1.__exportStar(require("./UpdateAliasCommand"), exports);
+tslib_1.__exportStar(require("./UpdateCustomKeyStoreCommand"), exports);
+tslib_1.__exportStar(require("./UpdateKeyDescriptionCommand"), exports);
+tslib_1.__exportStar(require("./UpdatePrimaryRegionCommand"), exports);
+tslib_1.__exportStar(require("./VerifyCommand"), exports);

package/dist-cjs/endpoints.js

@@ -33,22 +33,27 @@ const partitionHash = {
             "us-west-1",
             "us-west-2",
         ],
+        regionRegex: "^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$",
         hostname: "kms.{region}.amazonaws.com",
     },
     "aws-cn": {
         regions: ["cn-north-1", "cn-northwest-1"],
+        regionRegex: "^cn\\-\\w+\\-\\d+$",
         hostname: "kms.{region}.amazonaws.com.cn",
     },
     "aws-iso": {
-        regions: ["ProdFips", "us-iso-east-1"],
+        regions: ["ProdFips", "us-iso-east-1", "us-iso-west-1"],
+        regionRegex: "^us\\-iso\\-\\w+\\-\\d+$",
         hostname: "kms.{region}.c2s.ic.gov",
     },
     "aws-iso-b": {
         regions: ["ProdFips", "us-isob-east-1"],
+        regionRegex: "^us\\-isob\\-\\w+\\-\\d+$",
         hostname: "kms.{region}.sc2s.sgov.gov",
     },
     "aws-us-gov": {
         regions: ["ProdFips", "us-gov-east-1", "us-gov-west-1"],
+        regionRegex: "^us\\-gov\\-\\w+\\-\\d+$",
         hostname: "kms.{region}.amazonaws.com",
     },
 };

package/dist-cjs/index.js

@@ -1,59 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./KMSClient"), exports);
 tslib_1.__exportStar(require("./KMS"), exports);
-tslib_1.__exportStar(require("./commands/CancelKeyDeletionCommand"), exports);
-tslib_1.__exportStar(require("./commands/ConnectCustomKeyStoreCommand"), exports);
-tslib_1.__exportStar(require("./commands/CreateAliasCommand"), exports);
-tslib_1.__exportStar(require("./commands/CreateCustomKeyStoreCommand"), exports);
-tslib_1.__exportStar(require("./commands/CreateGrantCommand"), exports);
-tslib_1.__exportStar(require("./commands/CreateKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/DecryptCommand"), exports);
-tslib_1.__exportStar(require("./commands/DeleteAliasCommand"), exports);
-tslib_1.__exportStar(require("./commands/DeleteCustomKeyStoreCommand"), exports);
-tslib_1.__exportStar(require("./commands/DeleteImportedKeyMaterialCommand"), exports);
-tslib_1.__exportStar(require("./commands/DescribeCustomKeyStoresCommand"), exports);
-tslib_1.__exportStar(require("./commands/DescribeKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/DisableKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/DisableKeyRotationCommand"), exports);
-tslib_1.__exportStar(require("./commands/DisconnectCustomKeyStoreCommand"), exports);
-tslib_1.__exportStar(require("./commands/EnableKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/EnableKeyRotationCommand"), exports);
-tslib_1.__exportStar(require("./commands/EncryptCommand"), exports);
-tslib_1.__exportStar(require("./commands/GenerateDataKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/GenerateDataKeyPairCommand"), exports);
-tslib_1.__exportStar(require("./commands/GenerateDataKeyPairWithoutPlaintextCommand"), exports);
-tslib_1.__exportStar(require("./commands/GenerateDataKeyWithoutPlaintextCommand"), exports);
-tslib_1.__exportStar(require("./commands/GenerateRandomCommand"), exports);
-tslib_1.__exportStar(require("./commands/GetKeyPolicyCommand"), exports);
-tslib_1.__exportStar(require("./commands/GetKeyRotationStatusCommand"), exports);
-tslib_1.__exportStar(require("./commands/GetParametersForImportCommand"), exports);
-tslib_1.__exportStar(require("./commands/GetPublicKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/ImportKeyMaterialCommand"), exports);
-tslib_1.__exportStar(require("./commands/ListAliasesCommand"), exports);
-tslib_1.__exportStar(require("./pagination/ListAliasesPaginator"), exports);
-tslib_1.__exportStar(require("./commands/ListGrantsCommand"), exports);
-tslib_1.__exportStar(require("./pagination/ListGrantsPaginator"), exports);
-tslib_1.__exportStar(require("./commands/ListKeyPoliciesCommand"), exports);
-tslib_1.__exportStar(require("./pagination/ListKeyPoliciesPaginator"), exports);
-tslib_1.__exportStar(require("./commands/ListKeysCommand"), exports);
-tslib_1.__exportStar(require("./pagination/ListKeysPaginator"), exports);
-tslib_1.__exportStar(require("./commands/ListResourceTagsCommand"), exports);
-tslib_1.__exportStar(require("./commands/ListRetirableGrantsCommand"), exports);
-tslib_1.__exportStar(require("./commands/PutKeyPolicyCommand"), exports);
-tslib_1.__exportStar(require("./commands/ReEncryptCommand"), exports);
-tslib_1.__exportStar(require("./commands/ReplicateKeyCommand"), exports);
-tslib_1.__exportStar(require("./commands/RetireGrantCommand"), exports);
-tslib_1.__exportStar(require("./commands/RevokeGrantCommand"), exports);
-tslib_1.__exportStar(require("./commands/ScheduleKeyDeletionCommand"), exports);
-tslib_1.__exportStar(require("./commands/SignCommand"), exports);
-tslib_1.__exportStar(require("./commands/TagResourceCommand"), exports);
-tslib_1.__exportStar(require("./commands/UntagResourceCommand"), exports);
-tslib_1.__exportStar(require("./commands/UpdateAliasCommand"), exports);
-tslib_1.__exportStar(require("./commands/UpdateCustomKeyStoreCommand"), exports);
-tslib_1.__exportStar(require("./commands/UpdateKeyDescriptionCommand"), exports);
-tslib_1.__exportStar(require("./commands/UpdatePrimaryRegionCommand"), exports);
-tslib_1.__exportStar(require("./commands/VerifyCommand"), exports);
-tslib_1.__exportStar(require("./pagination/Interfaces"), exports);
-tslib_1.__exportStar(require("./models/index"), exports);
+tslib_1.__exportStar(require("./KMSClient"), exports);
+tslib_1.__exportStar(require("./commands"), exports);
+tslib_1.__exportStar(require("./models"), exports);
+tslib_1.__exportStar(require("./pagination"), exports);