@aws-sdk/client-kms 3.67.0 → 3.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +4 -1
- package/dist-cjs/KMS.js +30 -0
- package/dist-cjs/commands/GenerateMacCommand.js +36 -0
- package/dist-cjs/commands/VerifyMacCommand.js +36 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +60 -3
- package/dist-cjs/protocols/Aws_json1_1.js +194 -2
- package/dist-es/KMS.js +30 -0
- package/dist-es/commands/GenerateMacCommand.js +39 -0
- package/dist-es/commands/VerifyMacCommand.js +39 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +46 -0
- package/dist-es/protocols/Aws_json1_1.js +225 -1
- package/dist-types/KMS.d.ts +256 -219
- package/dist-types/KMSClient.d.ts +8 -3
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAliasCommand.d.ts +2 -2
- package/dist-types/commands/CreateGrantCommand.d.ts +2 -2
- package/dist-types/commands/CreateKeyCommand.d.ts +44 -40
- package/dist-types/commands/DecryptCommand.d.ts +7 -7
- package/dist-types/commands/DeleteAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyCommand.d.ts +6 -8
- package/dist-types/commands/DisableKeyCommand.d.ts +2 -3
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +3 -3
- package/dist-types/commands/EnableKeyCommand.d.ts +1 -1
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +3 -3
- package/dist-types/commands/EncryptCommand.d.ts +8 -26
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +13 -15
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +12 -11
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +10 -11
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +21 -24
- package/dist-types/commands/GenerateMacCommand.d.ts +55 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +2 -2
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -7
- package/dist-types/commands/GetPublicKeyCommand.d.ts +2 -2
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +8 -8
- package/dist-types/commands/ListGrantsCommand.d.ts +1 -1
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +1 -1
- package/dist-types/commands/ReEncryptCommand.d.ts +8 -9
- package/dist-types/commands/ReplicateKeyCommand.d.ts +8 -4
- package/dist-types/commands/RetireGrantCommand.d.ts +4 -5
- package/dist-types/commands/RevokeGrantCommand.d.ts +1 -1
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +1 -1
- package/dist-types/commands/SignCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAliasCommand.d.ts +2 -2
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -3
- package/dist-types/commands/VerifyCommand.d.ts +2 -2
- package/dist-types/commands/VerifyMacCommand.d.ts +56 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +323 -114
- package/dist-types/protocols/Aws_json1_1.d.ts +6 -0
- package/dist-types/ts3.4/KMS.d.ts +10 -0
- package/dist-types/ts3.4/KMSClient.d.ts +4 -2
- package/dist-types/ts3.4/commands/GenerateMacCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/VerifyMacCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +81 -1
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +6 -0
- package/package.json +7 -7
|
@@ -7,18 +7,17 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandInput extends Generat
|
|
|
7
7
|
export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends GenerateDataKeyPairWithoutPlaintextResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* private key. </p>
|
|
10
|
+
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
11
|
+
* a plaintext public key and a copy of the private key that is encrypted under the symmetric
|
|
12
|
+
* encryption KMS key you specify. Unlike <a>GenerateDataKeyPair</a>, this operation
|
|
13
|
+
* does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller
|
|
14
|
+
* or to the KMS key that is used to encrypt the private key. </p>
|
|
15
15
|
* <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
|
|
16
16
|
* to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
|
|
17
17
|
* 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>
|
|
18
|
-
* <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt
|
|
19
|
-
* key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
20
|
-
* store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
|
|
21
|
-
* operation. </p>
|
|
18
|
+
* <p>To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt
|
|
19
|
+
* the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
20
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
22
21
|
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
23
22
|
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
|
|
24
23
|
* either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
|
|
@@ -29,13 +28,13 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
29
28
|
* the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
30
29
|
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
31
30
|
*
|
|
32
|
-
* <p>You can use
|
|
31
|
+
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
33
32
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
34
33
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
35
34
|
* 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
|
|
36
35
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
37
36
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
38
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
37
|
+
* 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>
|
|
39
38
|
* <p>
|
|
40
39
|
* <b>Cross-account
|
|
41
40
|
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
@@ -7,40 +7,37 @@ export interface GenerateDataKeyWithoutPlaintextCommandInput extends GenerateDat
|
|
|
7
7
|
export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDataKeyWithoutPlaintextResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
11
|
+
* data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in
|
|
12
|
+
* the key are random; they are not related to the caller or to the KMS key.</p>
|
|
13
13
|
* <p>
|
|
14
|
-
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that
|
|
15
|
-
* data key.
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* might store encrypted data in containers. One
|
|
20
|
-
* and stores an encrypted data key with each
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* plaintext data key. In this system, the component
|
|
24
|
-
* plaintext data key.</p>
|
|
25
|
-
* <p>
|
|
26
|
-
*
|
|
27
|
-
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the
|
|
28
|
-
* private key.</p>
|
|
29
|
-
*
|
|
30
|
-
* <p>To generate a data key, you must specify the symmetric KMS key that is used to encrypt the
|
|
31
|
-
* data key. You cannot use an asymmetric KMS key to generate a data key. To get the type of your
|
|
32
|
-
* KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
14
|
+
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that it does not return a plaintext copy of the
|
|
15
|
+
* data key. </p>
|
|
16
|
+
* <p>This operation is useful for systems that need to encrypt data at some point, but not
|
|
17
|
+
* immediately. When you need to encrypt the data, you call the <a>Decrypt</a>
|
|
18
|
+
* operation on the encrypted copy of the key. It's also useful in distributed systems with
|
|
19
|
+
* different levels of trust. For example, you might store encrypted data in containers. One
|
|
20
|
+
* component of your system creates new containers and stores an encrypted data key with each
|
|
21
|
+
* container. Then, a different component puts the data into the containers. That component first
|
|
22
|
+
* decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data
|
|
23
|
+
* into the container, and then destroys the plaintext data key. In this system, the component
|
|
24
|
+
* that creates the containers never sees the plaintext data key.</p>
|
|
25
|
+
* <p>To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or
|
|
26
|
+
* <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
33
27
|
*
|
|
28
|
+
* <p>To generate a data key, you must specify the symmetric encryption KMS key that is used to
|
|
29
|
+
* encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the
|
|
30
|
+
* type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
34
31
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
35
32
|
* <code>CiphertextBlob</code> field.</p>
|
|
36
33
|
*
|
|
37
|
-
* <p>You can use
|
|
34
|
+
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
38
35
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
39
36
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
40
37
|
* 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
|
|
41
38
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
42
39
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
43
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
40
|
+
* 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>
|
|
44
41
|
* <p>
|
|
45
42
|
* <b>Cross-account
|
|
46
43
|
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
4
|
+
import { GenerateMacRequest, GenerateMacResponse } from "../models/models_0";
|
|
5
|
+
export interface GenerateMacCommandInput extends GenerateMacRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface GenerateMacCommandOutput extends GenerateMacResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS
|
|
11
|
+
* key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the
|
|
12
|
+
* message and the key as described in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
13
|
+
* <p>You can use the HMAC that this operation generates with the <a>VerifyMac</a>
|
|
14
|
+
* operation to demonstrate that the original message has not changed. Also, because a secret key
|
|
15
|
+
* is used to create the hash, you can verify that the party that generated the hash has the
|
|
16
|
+
* required secret key. This operation is part of KMS support for HMAC KMS keys.
|
|
17
|
+
* For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC keys in KMS</a> in the <i>
|
|
18
|
+
* <i>Key Management Service Developer Guide</i>
|
|
19
|
+
* </i>.</p>
|
|
20
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
21
|
+
* 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>
|
|
22
|
+
* <p>
|
|
23
|
+
* <b>Cross-account
|
|
24
|
+
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
25
|
+
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
26
|
+
* <p>
|
|
27
|
+
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateMac</a> (key policy)</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Related operations</b>: <a>VerifyMac</a>
|
|
30
|
+
* </p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { KMSClient, GenerateMacCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
35
|
+
* // const { KMSClient, GenerateMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
36
|
+
* const client = new KMSClient(config);
|
|
37
|
+
* const command = new GenerateMacCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @see {@link GenerateMacCommandInput} for command's `input` shape.
|
|
42
|
+
* @see {@link GenerateMacCommandOutput} for command's `response` shape.
|
|
43
|
+
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
44
|
+
*
|
|
45
|
+
*/
|
|
46
|
+
export declare class GenerateMacCommand extends $Command<GenerateMacCommandInput, GenerateMacCommandOutput, KMSClientResolvedConfig> {
|
|
47
|
+
readonly input: GenerateMacCommandInput;
|
|
48
|
+
constructor(input: GenerateMacCommandInput);
|
|
49
|
+
/**
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateMacCommandInput, GenerateMacCommandOutput>;
|
|
53
|
+
private serialize;
|
|
54
|
+
private deserialize;
|
|
55
|
+
}
|
|
@@ -9,10 +9,10 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is
|
|
11
11
|
* enabled for the specified KMS key.</p>
|
|
12
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
12
|
+
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key. The key rotation status for these KMS keys is always
|
|
13
13
|
* <code>false</code>.</p>
|
|
14
14
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
15
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
15
|
+
* 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>
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
18
|
* <p>Disabled: The key rotation status does not change when you disable a KMS key. However,
|
|
@@ -7,21 +7,21 @@ export interface GetParametersForImportCommandInput extends GetParametersForImpo
|
|
|
7
7
|
export interface GetParametersForImportCommandOutput extends GetParametersForImportResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the items you need to import key material into a symmetric
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Returns the items you need to import key material into a symmetric encryption KMS key. For
|
|
11
|
+
* 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
|
|
12
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
13
13
|
* <p>This operation returns a public key and an import token. Use the public key to encrypt the
|
|
14
14
|
* symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
|
|
15
|
-
* <p>You must specify the key ID of the symmetric KMS key into which you will import
|
|
16
|
-
* material. This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also
|
|
15
|
+
* <p>You must specify the key ID of the symmetric encryption KMS key into which you will import
|
|
16
|
+
* key material. This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also
|
|
17
17
|
* specify the wrapping algorithm and type of wrapping key (public key) that you will use to
|
|
18
|
-
* encrypt the key material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
18
|
+
* encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.</p>
|
|
19
19
|
* <p>To import key material, you must use the public key and import token from the same
|
|
20
20
|
* response. These items are valid for 24 hours. The expiration date and time appear in the
|
|
21
21
|
* <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
|
|
22
22
|
* <code>GetParametersForImport</code> request.</p>
|
|
23
23
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
24
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
24
|
+
* 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>
|
|
25
25
|
* <p>
|
|
26
26
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
27
27
|
*
|
|
@@ -11,7 +11,7 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
|
|
|
11
11
|
* KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
|
|
12
12
|
* permission can download the public key of an asymmetric KMS key. You can share the public key
|
|
13
13
|
* to allow others to encrypt messages and verify signatures outside of KMS.
|
|
14
|
-
* For information about
|
|
14
|
+
* For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
15
15
|
* <p>You do not need to download the public key. Instead, you can use the public key within
|
|
16
16
|
* KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the
|
|
17
17
|
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
@@ -43,7 +43,7 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
|
|
|
43
43
|
* can also avoid errors, such as using the wrong signing algorithm in a verification
|
|
44
44
|
* operation.</p>
|
|
45
45
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
46
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
46
|
+
* 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>
|
|
47
47
|
* <p>
|
|
48
48
|
* <b>Cross-account use</b>:
|
|
49
49
|
* Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
@@ -7,13 +7,13 @@ export interface ImportKeyMaterialCommandInput extends ImportKeyMaterialRequest
|
|
|
7
7
|
export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Imports key material into an existing symmetric
|
|
11
|
-
* material. After you successfully import key material into a KMS key, you can
|
|
12
|
-
* the same key material</a> into that KMS key, but you cannot import different
|
|
13
|
-
* material. </p>
|
|
14
|
-
* <p>You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about
|
|
15
|
-
* and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
|
|
16
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
10
|
+
* <p>Imports key material into an existing symmetric encryption KMS key that was created
|
|
11
|
+
* without key material. After you successfully import key material into a KMS key, you can
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that KMS key, but you cannot import different
|
|
13
|
+
* key material. </p>
|
|
14
|
+
* <p>You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about
|
|
15
|
+
* creating KMS keys with no key material and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
|
|
16
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
17
17
|
* <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
|
|
18
18
|
* includes a public key and an import token. Use the public key to encrypt the key material.
|
|
19
19
|
* Then, submit the import token from the same <code>GetParametersForImport</code>
|
|
@@ -50,7 +50,7 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
|
|
|
50
50
|
* and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key
|
|
51
51
|
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
52
52
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
53
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
53
|
+
* 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>
|
|
54
54
|
* <p>
|
|
55
55
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
56
56
|
*
|
|
@@ -10,7 +10,7 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
|
|
|
10
10
|
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
11
11
|
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
|
|
12
12
|
* grantee principal.</p>
|
|
13
|
-
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">
|
|
13
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
14
14
|
* <i>
|
|
15
15
|
* <i>Key Management Service Developer Guide</i>
|
|
16
16
|
* </i>. For examples of working with grants in several
|
|
@@ -12,7 +12,7 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
|
|
|
12
12
|
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
13
13
|
* grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this
|
|
14
14
|
* operation to determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
|
|
15
|
-
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">
|
|
15
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
16
16
|
* <i>
|
|
17
17
|
* <i>Key Management Service Developer Guide</i>
|
|
18
18
|
* </i>. For examples of working with grants in several
|
|
@@ -12,8 +12,8 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
12
12
|
* rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
|
|
13
13
|
* it to reencrypt ciphertext under the same KMS key, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
|
|
14
14
|
* context</a> of a ciphertext.</p>
|
|
15
|
-
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using
|
|
16
|
-
* KMS
|
|
15
|
+
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using a
|
|
16
|
+
* KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the
|
|
17
17
|
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS key</a>
|
|
18
18
|
* outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as
|
|
19
19
|
* the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a> or
|
|
@@ -30,7 +30,7 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
30
30
|
* is required to decrypt the data.</p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
* <p>If your ciphertext was encrypted under a symmetric KMS key, the
|
|
33
|
+
* <p>If your ciphertext was encrypted under a symmetric encryption KMS key, the
|
|
34
34
|
* <code>SourceKeyId</code> parameter is optional. KMS can get this information from
|
|
35
35
|
* metadata that it adds to the symmetric ciphertext blob. This feature adds durability to
|
|
36
36
|
* your implementation by ensuring that authorized users can decrypt ciphertext decades after
|
|
@@ -43,19 +43,18 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
45
|
* <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter
|
|
46
|
-
* specify the KMS key that re-encrypts the data after it is decrypted.
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* compatible with the KMS key.</p>
|
|
46
|
+
* specify the KMS key that re-encrypts the data after it is decrypted. If the destination
|
|
47
|
+
* KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The
|
|
48
|
+
* algorithm that you choose must be compatible with the KMS key.</p>
|
|
50
49
|
*
|
|
51
50
|
* <important>
|
|
52
51
|
* <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
|
|
53
|
-
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
52
|
+
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
54
53
|
* </important>
|
|
55
54
|
* </li>
|
|
56
55
|
* </ul>
|
|
57
56
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
58
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
57
|
+
* 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>
|
|
59
58
|
* <p>
|
|
60
59
|
* <b>Cross-account use</b>: Yes.
|
|
61
60
|
* The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both
|
|
@@ -15,7 +15,7 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
15
15
|
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
16
16
|
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
17
17
|
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
18
|
-
* 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">
|
|
18
|
+
* 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">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
19
19
|
* <p>A <i>replica key</i> is a fully-functional KMS key that can be used
|
|
20
20
|
* independently of its primary and peer replica keys. A primary key and its replica keys share
|
|
21
21
|
* properties that make them interoperable. They have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a> and key material. They also
|
|
@@ -25,8 +25,7 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
25
25
|
* material origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation status</a>. KMS automatically synchronizes these shared
|
|
26
26
|
* properties among related multi-Region keys. All other properties of a replica key can differ,
|
|
27
27
|
* including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key
|
|
28
|
-
* policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key
|
|
29
|
-
* state</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica
|
|
28
|
+
* policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica
|
|
30
29
|
* key.</p>
|
|
31
30
|
* <p>When this operation completes, the new replica key has a transient key state of
|
|
32
31
|
* <code>Creating</code>. This key state changes to <code>Enabled</code> (or
|
|
@@ -35,8 +34,13 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
35
34
|
* cannot yet use it in cryptographic operations. If you are creating and using the replica key
|
|
36
35
|
* programmatically, retry on <code>KMSInvalidStateException</code> or call
|
|
37
36
|
* <code>DescribeKey</code> to check its <code>KeyState</code> value before using it. For
|
|
38
|
-
* details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key
|
|
37
|
+
* details about the <code>Creating</code> key state, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the
|
|
39
38
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
39
|
+
* <p>You cannot create more than one replica of a primary key in any Region. If the Region
|
|
40
|
+
* already includes a replica of the key you're trying to replicate, <code>ReplicateKey</code>
|
|
41
|
+
* returns an <code>AlreadyExistsException</code> error. If the key state of the existing replica
|
|
42
|
+
* is <code>PendingDeletion</code>, you can cancel the scheduled key deletion (<a>CancelKeyDeletion</a>) or wait for the key to be deleted. The new replica key you create
|
|
43
|
+
* will have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties">shared properties</a> as the original replica key.</p>
|
|
40
44
|
* <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a
|
|
41
45
|
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
|
|
42
46
|
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
|
|
@@ -13,11 +13,10 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
|
|
|
13
13
|
* returns both values.</p>
|
|
14
14
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
15
15
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
16
|
-
* operation, and by the Amazon Web Services account
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
16
|
+
* operation, and by the Amazon Web Services account in which the grant is created. It can also be called by
|
|
17
|
+
* principals to whom permission for retiring a grant is delegated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking
|
|
18
|
+
* grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
19
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
21
20
|
* <i>
|
|
22
21
|
* <i>Key Management Service Developer Guide</i>
|
|
23
22
|
* </i>. For examples of working with grants in several
|
|
@@ -16,7 +16,7 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
|
|
|
16
16
|
* the <i>
|
|
17
17
|
* <i>Key Management Service Developer Guide</i>
|
|
18
18
|
* </i>. </p>
|
|
19
|
-
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">
|
|
19
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
20
20
|
* <i>
|
|
21
21
|
* <i>Key Management Service Developer Guide</i>
|
|
22
22
|
* </i>. For examples of working with grants in several
|
|
@@ -38,7 +38,7 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
|
|
|
38
38
|
* <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
39
39
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
40
40
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
41
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
41
|
+
* 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>
|
|
42
42
|
* <p>
|
|
43
43
|
* <b>Cross-account
|
|
44
44
|
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -9,8 +9,8 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
11
11
|
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
12
|
-
* KMS key. To verify the signature, use the <a>Verify</a> operation, or use
|
|
13
|
-
* public key in the same asymmetric KMS key outside of KMS. For information about
|
|
12
|
+
* signing KMS key. To verify the signature, use the <a>Verify</a> operation, or use
|
|
13
|
+
* the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
14
14
|
* <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
|
|
15
15
|
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized
|
|
16
16
|
* user) uses their private key to sign a message. Anyone with the public key can verify that the
|
|
@@ -43,7 +43,7 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
|
|
|
43
43
|
* operation. Or use the <a>GetPublicKey</a> operation to download the public key and
|
|
44
44
|
* then use the public key to verify the signature outside of KMS. </p>
|
|
45
45
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
46
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
46
|
+
* 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>
|
|
47
47
|
* <p>
|
|
48
48
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
49
49
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
@@ -9,7 +9,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">
|
|
12
|
+
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
13
13
|
* </note>
|
|
14
14
|
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
|
|
15
15
|
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
@@ -24,7 +24,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
25
25
|
* Web Services General Reference</i>. </p>
|
|
26
26
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
27
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
27
|
+
* 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>
|
|
28
28
|
* <p>
|
|
29
29
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
30
30
|
*
|
|
@@ -10,7 +10,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
11
11
|
* specify the tag key and the KMS key.</p>
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">
|
|
13
|
+
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
14
14
|
* </note>
|
|
15
15
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
16
16
|
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
|
|
@@ -20,7 +20,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
21
21
|
* Web Services General Reference</i>. </p>
|
|
22
22
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
23
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
23
|
+
* 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>
|
|
24
24
|
* <p>
|
|
25
25
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
26
26
|
*
|
|
@@ -11,7 +11,7 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
|
|
12
12
|
* KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
13
13
|
* <note>
|
|
14
|
-
* <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">
|
|
14
|
+
* <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">ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
|
|
17
17
|
* they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
|
|
@@ -25,7 +25,7 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
* response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys
|
|
26
26
|
* in the account, use the <a>ListAliases</a> operation. </p>
|
|
27
27
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
28
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
28
|
+
* 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>
|
|
29
29
|
* <p>
|
|
30
30
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
31
31
|
* <p>
|
|
@@ -9,7 +9,7 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
|
|
11
11
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
12
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
12
|
+
* 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>
|
|
13
13
|
* <p>
|
|
14
14
|
* <b>Cross-account
|
|
15
15
|
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
@@ -17,7 +17,7 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
|
|
|
17
17
|
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
18
18
|
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
19
19
|
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
20
|
-
* 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">
|
|
20
|
+
* 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">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
21
21
|
* <p>The <i>primary key</i> of a multi-Region key is the source for properties
|
|
22
22
|
* 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
|
|
23
23
|
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
@@ -37,8 +37,7 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
|
|
|
37
37
|
* update is complete. While the key state is <code>Updating</code>, you can use the keys in
|
|
38
38
|
* cryptographic operations, but you cannot replicate the new primary key or perform certain
|
|
39
39
|
* management operations, such as enabling or disabling these keys. For details about the
|
|
40
|
-
* <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key
|
|
41
|
-
* Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
40
|
+
* <code>Updating</code> key state, 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>
|
|
42
41
|
* <p>This operation does not return any output. To verify that primary key is changed, use the
|
|
43
42
|
* <a>DescribeKey</a> operation.</p>
|
|
44
43
|
* <p>
|
|
@@ -16,7 +16,7 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
|
|
|
16
16
|
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
17
17
|
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
18
18
|
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
19
|
-
* For information about
|
|
19
|
+
* For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
20
20
|
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
21
21
|
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
22
22
|
* signature.</p>
|
|
@@ -28,7 +28,7 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
|
|
|
28
28
|
* in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
|
|
29
29
|
* the KMS key to verify signatures.</p>
|
|
30
30
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
31
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key
|
|
31
|
+
* 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>
|
|
32
32
|
* <p>
|
|
33
33
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
34
34
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|