AWS Security ChangesHomeSearch

AWS kms: KMS encrypt CLI examples: placeholder key ID and formatting updates

Service: kms · 2026-10-31 · Documentation low

File: kms/latest/developerguide/example_kms_Encrypt_section.md

Summary

Editorial updates to the AWS KMS `encrypt` CLI examples: replaced the sample key ID with a generic placeholder (a1b2c3d4-5678-90ab-cdef-EXAMPLE11111), reworded example headings, reformatted the base64 pipe and Windows certutil commands, and removed a stale blog link. No substantive security guidance changed.

Security assessment

The diff only swaps a sample key ID for a placeholder, adjusts example titles/wording, and reformats CLI commands. It does not document a new security feature, fix a vulnerability, or change any security-relevant behavior; the encryption examples themselves are unchanged in substance.

Evidence

-        --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \

Diff

diff --git a/kms/latest/developerguide/example_kms_Encrypt_section.md b/kms/latest/developerguide/example_kms_Encrypt_section.md
index 51149ad..913417e 100644
--- a//kms/latest/developerguide/example_kms_Encrypt_section.md
+++ b//kms/latest/developerguide/example_kms_Encrypt_section.md
@@ -24 +24 @@ CLI
-**Example 1: To encrypt the contents of a file on Linux or MacOS**
+**Example 1: To encrypt the contents of a file (Linux and macOS)**
@@ -26 +26 @@ CLI
-The following `encrypt` command demonstrates the recommended way to encrypt data with the AWS CLI.
+The following `encrypt` example demonstrates the recommended way to encrypt data with the AWS CLI.
@@ -30 +30 @@ The following `encrypt` command demonstrates the recommended way to encrypt data
-        --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
+        --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
@@ -33,2 +33 @@ The following `encrypt` command demonstrates the recommended way to encrypt data
-        --query CiphertextBlob | base64 \
-        --decode > ExampleEncryptedFile
+        --query CiphertextBlob | base64 --decode > ExampleEncryptedFile
@@ -39 +38 @@ The command does several things:
-Uses the `--plaintext` parameter to indicate the data to encrypt. This parameter value must be base64-encoded.The value of the `plaintext` parameter must be base64-encoded, or you must use the `fileb://` prefix, which tells the AWS CLI to read binary data from the file.If the file is not in the current directory, type the full path to file. For example: `fileb:///var/tmp/ExamplePlaintextFile` or `fileb://C:\Temp\ExamplePlaintextFile`. For more information about reading AWS CLI parameter values from a file, see [Loading Parameters from a File](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-file) in the _AWS Command Line Interface User Guide_ and [Best Practices for Local File Parameters](https://blogs.aws.amazon.com/cli/post/TxLWWN1O25V1HE/Best-Practices-for-Local-File-Parameters) on the AWS Command Line Tool Blog.Uses the `--output` and `--query` parameters to control the command's output.These parameters extract the encrypted data, called the _ciphertext_ , from the command's output.For more information about controlling output, see [Controlling Command Output](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) in the _AWS Command Line Interface User Guide_.Uses the `base64` utility to decode the extracted output into binary data.The ciphertext that is returned by a successful `encrypt` command is base64-encoded text. You must decode this text before you can use the AWS CLI to decrypt it.Saves the binary ciphertext to a file.The final part of the command (`> ExampleEncryptedFile`) saves the binary ciphertext to a file to make decryption easier. For an example command that uses the AWS CLI to decrypt data, see the decrypt examples.
+Uses the `--plaintext` parameter to indicate the data to encrypt. This parameter value must be base64-encoded.The value of the `plaintext` parameter must be base64-encoded, or you must use the `fileb://` prefix, which tells the AWS CLI to read binary data from the file.If the file is not in the current directory, type the full path to file. For example: `fileb:///var/tmp/ExamplePlaintextFile` or `fileb://C:\Temp\ExamplePlaintextFile`. For more information about reading AWS CLI parameter values from a file, see [Loading Parameters from a File](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html) in the _AWS Command Line Interface User Guide_.Uses the `--output` and `--query` parameters to control the command's output.These parameters extract the encrypted data, called the _ciphertext_ , from the command's output.For more information about controlling output, see [Controlling Command Output](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) in the _AWS Command Line Interface User Guide_.Uses the `base64` utility to decode the extracted output into binary data.The ciphertext that is returned by a successful `encrypt` command is base64-encoded text. You must decode this text before you can use the AWS CLI to decrypt it.Saves the binary ciphertext to a file.The final part of the command (`> ExampleEncryptedFile`) saves the binary ciphertext to a file to make decryption easier. For an example command that uses the AWS CLI to decrypt data, see the decrypt examples.
@@ -41 +40 @@ Uses the `--plaintext` parameter to indicate the data to encrypt. This parameter
-**Example 2: Using the AWS CLI to encrypt data on Windows**
+This command produces no output.
@@ -43 +42 @@ Uses the `--plaintext` parameter to indicate the data to encrypt. This parameter
-This example is the same as the previous one, except that it uses the `certutil` tool instead of `base64`. This procedure requires two commands, as shown in the following example.
+**Example 2: To encrypt the contents of a file (Windows)**
@@ -44,0 +44 @@ This example is the same as the previous one, except that it uses the `certutil`
+The following `encrypt` example is the same as the previous one, except that it uses the `certutil` tool instead of `base64`. This procedure requires two commands, as shown in the following example.
@@ -46,4 +46,5 @@ This example is the same as the previous one, except that it uses the `certutil`
-    aws kms encrypt \
-        --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
-        --plaintext fileb://ExamplePlaintextFile \
-        --output text \
+    
+    aws kms encrypt ^
+        --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ^
+        --plaintext fileb://ExamplePlaintextFile ^
+        --output text ^
@@ -51,0 +53,6 @@ This example is the same as the previous one, except that it uses the `certutil`
+
+This command produces no output. The base64-encoded ciphertext is saved to `C:\Temp\ExampleEncryptedFile.base64`.
+
+Run the `certutil` command.
+    
+    
@@ -53,0 +61 @@ This example is the same as the previous one, except that it uses the `certutil`
+The ciphertext is saved to `C:\Temp\ExampleEncryptedFile`.
@@ -55 +63 @@ This example is the same as the previous one, except that it uses the `certutil`
-**Example 3: Encrypting with an asymmetric KMS key**
+**Example 3: To encrypt the contents of a file with an asymmetric KMS key**
@@ -57 +65 @@ This example is the same as the previous one, except that it uses the `certutil`
-The following `encrypt` command shows how to encrypt plaintext with an asymmetric KMS key. The `--encryption-algorithm` parameter is required. As in all `encrypt` CLI commands, the `plaintext` parameter must be base64-encoded, or you must use the `fileb://` prefix, which tells the AWS CLI to read binary data from the file.
+The following `encrypt` example shows how to encrypt plaintext with an asymmetric KMS key. The `--encryption-algorithm` parameter is required. As in all `encrypt` CLI commands, the `plaintext` parameter must be base64-encoded, or you must use the `fileb://` prefix, which tells the AWS CLI to read binary data from the file.
@@ -61 +69 @@ The following `encrypt` command shows how to encrypt plaintext with an asymmetri
-        --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
+        --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
@@ -65,2 +73 @@ The following `encrypt` command shows how to encrypt plaintext with an asymmetri
-        --query CiphertextBlob | base64 \
-        --decode > ExampleEncryptedFile
+        --query CiphertextBlob | base64 --decode > ExampleEncryptedFile