Skip to content

Commit 915892a

Browse files
author
awstools
committed
docs(client-kms): Documentation only updates for KMS.
1 parent ec12264 commit 915892a

File tree

10 files changed

+115
-108
lines changed

10 files changed

+115
-108
lines changed

clients/client-kms/src/commands/DecryptCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,12 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
8383
* particular trusted accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM
8484
* policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
8585
* <p>
86-
* <code>Decrypt</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
87-
* isolated compute environment in Amazon EC2. To call <code>Decrypt</code> for a Nitro enclave, use
86+
* <code>Decrypt</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a> and NitroTPM, which provide
87+
* attested environments in Amazon EC2. To call <code>Decrypt</code> for a Nitro enclave or NitroTPM, use
8888
* the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the
89-
* attestation document for the enclave. Instead of the plaintext data, the response includes the
90-
* plaintext data encrypted with the public key from the attestation document
91-
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
89+
* attestation document for the attested environment. Instead of the plaintext data, the response
90+
* includes the plaintext data encrypted with the public key from the attestation document
91+
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html">Cryptographic attestation support in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
9292
* <p>The KMS key that you use for this operation must be in a compatible key state. For
9393
* 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>
9494
* <p>

clients/client-kms/src/commands/DeriveSharedSecretCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export interface DeriveSharedSecretCommandOutput extends DeriveSharedSecretRespo
3535
* <p>Derives a shared secret using a key agreement algorithm.</p>
3636
* <note>
3737
* <p>You must use an asymmetric NIST-recommended elliptic curve (ECC) or SM2 (China Regions
38-
* only) KMS key pair with a <code>KeyUsage</code> value of <code>KEY_AGREEMENT</code> to call
39-
* DeriveSharedSecret.</p>
38+
* only) KMS key pair with a <code>KeyUsage</code>
39+
* value of <code>KEY_AGREEMENT</code> to call DeriveSharedSecret.</p>
4040
* </note>
4141
* <p>DeriveSharedSecret uses the <a href="https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar3.pdf#page=60">Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive</a> (ECDH) to establish a
4242
* key agreement between two peers by deriving a shared secret from their elliptic curve

clients/client-kms/src/commands/DescribeKeyCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
2929

3030
/**
3131
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
32-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed
33-
* key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a>.</p>
32+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer
33+
* managed key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a>.</p>
3434
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
3535
* applicable), the key state, and the origin and expiration date (if any) of the key material.
3636
* It includes fields, like <code>KeySpec</code>, that help you distinguish different types of

clients/client-kms/src/commands/GenerateDataKeyCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
5858
* <p>
5959
* <code>GenerateDataKey</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
6060
* isolated compute environment in Amazon EC2. To call <code>GenerateDataKey</code> for an Amazon Web Services Nitro
61-
* enclave, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter
62-
* to provide the attestation document for the enclave. <code>GenerateDataKey</code> returns a
61+
* enclave or NitroTPM, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter
62+
* to provide the attestation document for the attested environment. <code>GenerateDataKey</code> returns a
6363
* copy of the data key encrypted under the specified KMS key, as usual. But instead of a
6464
* plaintext copy of the data key, the response includes a copy of the data key encrypted under
6565
* the public key from the attestation document (<code>CiphertextForRecipient</code>).
66-
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p>
66+
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html">Cryptographic attestation support in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
6767
* <p>The KMS key that you use for this operation must be in a compatible key state. For
6868
* 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>
6969
* <p>

clients/client-kms/src/commands/GenerateDataKeyPairCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,13 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
6565
* <p>
6666
* <code>GenerateDataKeyPair</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
6767
* isolated compute environment in Amazon EC2. To call <code>GenerateDataKeyPair</code> for an Amazon Web Services
68-
* Nitro enclave, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code>
69-
* parameter to provide the attestation document for the enclave.
68+
* Nitro enclave or NitroTPM, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code>
69+
* parameter to provide the attestation document for the attested environment.
7070
* <code>GenerateDataKeyPair</code> returns the public data key and a copy of the private data
7171
* key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the
7272
* private data key (<code>PrivateKeyPlaintext</code>), the response includes a copy of the
7373
* private data key encrypted under the public key from the attestation document
74-
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p>
74+
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html">Cryptographic attestation support in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
7575
* <p>You can use an optional encryption context to add additional security to the encryption
7676
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
7777
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.

clients/client-kms/src/commands/GenerateRandomCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
4141
* <p>
4242
* <code>GenerateRandom</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
4343
* isolated compute environment in Amazon EC2. To call <code>GenerateRandom</code> for a Nitro
44-
* enclave, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter
45-
* to provide the attestation document for the enclave. Instead of plaintext bytes, the response
44+
* enclave or NitroTPM, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter
45+
* to provide the attestation document for the attested environment. Instead of plaintext bytes, the response
4646
* includes the plaintext bytes encrypted under the public key from the attestation document
47-
* (<code>CiphertextForRecipient</code>).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
47+
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html">Cryptographic attestation support in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
4848
* <p>For more information about entropy and random number generation, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#entropy-and-random-numbers">Entropy and random number generation</a> in the <i>Key Management Service Developer Guide</i>.</p>
4949
* <p>
5050
* <b>Cross-account use</b>: Not applicable.

clients/client-kms/src/commands/TagResourceCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
3535
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
3636
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
3737
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
38-
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>, but you cannot
39-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services
40-
* managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-key">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>,
38+
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>, but you
39+
* cannot tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-key">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>,
4140
* or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">alias</a>.</p>
4241
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
4342
* replicating it (<a>ReplicateKey</a>).</p>

clients/client-kms/src/commands/UntagResourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
2828
export interface UntagResourceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>. To delete a tag,
32-
* specify the tag key and the KMS key.</p>
31+
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>. To delete a
32+
* tag, specify the tag key and the KMS key.</p>
3333
* <note>
3434
* <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 for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
3535
* </note>

0 commit comments

Comments
 (0)