chore: change examples parameter from aws_kms_cmk_arn to aws_kms_cmk for consistency

Author: mattsb42-aws

examples/README.md

@@ -76,7 +76,7 @@ please make sure that it meets the following requirements:
 1. Each example file MUST contain a function called `run` that runs the example.
 1. If your `run` function needs any of the following inputs,
     the parameters MUST have the following names:
-    * `aws_kms_cmk_arn` (`str`) : A single AWS KMS CMK ARN.
+    * `aws_kms_cmk` (`str`) : A single AWS KMS CMK ARN.
         * NOTE: You can assume that automatically discovered credentials have
             `kms:GenerateDataKey`, `kms:Encrypt`, and `kms:Decrypt` permissions on this CMK.
     * `aws_kms_generator_cmk` (`str`) : A single AWS KMS CMK ARN to use as a generator key.

examples/src/file_streaming_defaults.py

@@ -14,11 +14,11 @@
 from aws_encryption_sdk.keyrings.aws_kms import KmsKeyring
 
 
-def run(aws_kms_cmk_arn, source_plaintext_filename):
+def run(aws_kms_cmk, source_plaintext_filename):
     # type: (str, str) -> None
     """Demonstrate an encrypt/decrypt cycle using the streaming encrypt/decrypt APIs to work with files.
 
-    :param str aws_kms_cmk_arn: AWS KMS CMK ARN to use to protect data keys
+    :param str aws_kms_cmk: AWS KMS CMK ARN to use to protect data keys
     :param str source_plaintext_filename: Path to plaintext file to encrypt
     """
     # We assume that you can also write in the directory containing the plaintext file,
@@ -36,7 +36,7 @@ def run(aws_kms_cmk_arn, source_plaintext_filename):
     }
 
     # Create the keyring that determines how your keys are protected.
-    keyring = KmsKeyring(generator_key_id=aws_kms_cmk_arn)
+    keyring = KmsKeyring(generator_key_id=aws_kms_cmk)
 
     # Open the files you want to work with.
     with open(source_plaintext_filename, "rb") as plaintext, open(ciphertext_filename, "wb") as ciphertext:

examples/src/in_memory_streaming_defaults.py

@@ -14,11 +14,11 @@
 from aws_encryption_sdk.keyrings.aws_kms import KmsKeyring
 
 
-def run(aws_kms_cmk_arn, source_plaintext):
+def run(aws_kms_cmk, source_plaintext):
     # type: (str, bytes) -> None
     """Demonstrate an encrypt/decrypt cycle using the streaming encrypt/decrypt APIs in-memory.
 
-    :param str aws_kms_cmk_arn: AWS KMS CMK ARN to use to protect data keys
+    :param str aws_kms_cmk: AWS KMS CMK ARN to use to protect data keys
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
@@ -31,7 +31,7 @@ def run(aws_kms_cmk_arn, source_plaintext):
     }
 
     # Create the keyring that determines how your keys are protected.
-    keyring = KmsKeyring(generator_key_id=aws_kms_cmk_arn)
+    keyring = KmsKeyring(generator_key_id=aws_kms_cmk)
 
     ciphertext = io.BytesIO()
 

examples/src/legacy/basic_encryption.py

@@ -4,16 +4,16 @@
 import aws_encryption_sdk
 
 
-def run(aws_kms_cmk_arn, source_plaintext, botocore_session=None):
+def run(aws_kms_cmk, source_plaintext, botocore_session=None):
     """Encrypts and then decrypts a string under a KMS customer master key (CMK).
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS CMK
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS CMK
     :param bytes source_plaintext: Data to encrypt
     :param botocore_session: existing botocore session instance
     :type botocore_session: botocore.session.Session
     """
     # Create a KMS master key provider
-    kms_kwargs = dict(key_ids=[aws_kms_cmk_arn])
+    kms_kwargs = dict(key_ids=[aws_kms_cmk])
     if botocore_session is not None:
         kms_kwargs["botocore_session"] = botocore_session
     master_key_provider = aws_encryption_sdk.KMSMasterKeyProvider(**kms_kwargs)

examples/src/legacy/basic_file_encryption_with_multiple_providers.py

@@ -50,12 +50,12 @@ def _get_raw_key(self, key_id):
         )
 
 
-def run(aws_kms_cmk_arn, source_plaintext_filename, botocore_session=None):
+def run(aws_kms_cmk, source_plaintext_filename, botocore_session=None):
     """Encrypts and then decrypts a file using a KMS master key provider and a custom static master
     key provider. Both master key providers are used to encrypt the plaintext file, so either one alone
     can decrypt it.
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS Customer Master Key (CMK)
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS Customer Master Key (CMK)
     (http://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html)
     :param str source_plaintext_filename: Filename of file to encrypt
     :param botocore_session: existing botocore session instance
@@ -67,7 +67,7 @@ def run(aws_kms_cmk_arn, source_plaintext_filename, botocore_session=None):
     cycled_static_plaintext_filename = source_plaintext_filename + ".static.decrypted"
 
     # Create a KMS master key provider
-    kms_kwargs = dict(key_ids=[aws_kms_cmk_arn])
+    kms_kwargs = dict(key_ids=[aws_kms_cmk])
     if botocore_session is not None:
         kms_kwargs["botocore_session"] = botocore_session
     kms_master_key_provider = aws_encryption_sdk.KMSMasterKeyProvider(**kms_kwargs)

examples/src/legacy/data_key_caching_basic.py

@@ -4,10 +4,10 @@
 import aws_encryption_sdk
 
 
-def run(aws_kms_cmk_arn, max_age_in_cache=10.0, cache_capacity=10):
+def run(aws_kms_cmk, max_age_in_cache=10.0, cache_capacity=10):
     """Encrypts a string using an AWS KMS customer master key (CMK) and data key caching.
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS customer master key
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS customer master key
     :param float max_age_in_cache: Maximum time in seconds that a cached entry can be used
     :param int cache_capacity: Maximum number of entries to retain in cache at once
     """
@@ -22,7 +22,7 @@ def run(aws_kms_cmk_arn, max_age_in_cache=10.0, cache_capacity=10):
     encryption_context = {"purpose": "test"}
 
     # Create a master key provider for the KMS customer master key (CMK)
-    key_provider = aws_encryption_sdk.KMSMasterKeyProvider(key_ids=[aws_kms_cmk_arn])
+    key_provider = aws_encryption_sdk.KMSMasterKeyProvider(key_ids=[aws_kms_cmk])
 
     # Create a local cache
     cache = aws_encryption_sdk.LocalCryptoMaterialsCache(cache_capacity)

examples/src/legacy/one_kms_cmk.py

@@ -4,15 +4,15 @@
 import aws_encryption_sdk
 
 
-def run(aws_kms_cmk_arn, source_plaintext, botocore_session=None):
+def run(aws_kms_cmk, source_plaintext, botocore_session=None):
     """Encrypts and then decrypts a string under one KMS customer master key (CMK).
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS CMK
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS CMK
     :param bytes source_plaintext: Data to encrypt
     :param botocore_session: existing botocore session instance
     :type botocore_session: botocore.session.Session
     """
-    kwargs = dict(key_ids=[aws_kms_cmk_arn])
+    kwargs = dict(key_ids=[aws_kms_cmk])
 
     if botocore_session is not None:
         kwargs["botocore_session"] = botocore_session

examples/src/legacy/one_kms_cmk_streaming_data.py

@@ -6,17 +6,17 @@
 import aws_encryption_sdk
 
 
-def run(aws_kms_cmk_arn, source_plaintext_filename, botocore_session=None):
+def run(aws_kms_cmk, source_plaintext_filename, botocore_session=None):
     """Encrypts and then decrypts streaming data under one KMS customer master key (CMK).
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS CMK
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS CMK
     :param str source_plaintext_filename: Filename of file to encrypt
     :param botocore_session: existing botocore session instance
     :type botocore_session: botocore.session.Session
     """
     kwargs = dict()
 
-    kwargs["key_ids"] = [aws_kms_cmk_arn]
+    kwargs["key_ids"] = [aws_kms_cmk]
 
     if botocore_session is not None:
         kwargs["botocore_session"] = botocore_session

examples/src/legacy/one_kms_cmk_unsigned.py

@@ -7,15 +7,15 @@
 from aws_encryption_sdk.identifiers import Algorithm
 
 
-def run(aws_kms_cmk_arn, source_plaintext, botocore_session=None):
+def run(aws_kms_cmk, source_plaintext, botocore_session=None):
     """Encrypts and then decrypts a string under one KMS customer master key (CMK) with an unsigned algorithm.
 
-    :param str aws_kms_cmk_arn: Amazon Resource Name (ARN) of the KMS CMK
+    :param str aws_kms_cmk: Amazon Resource Name (ARN) of the KMS CMK
     :param bytes source_plaintext: Data to encrypt
     :param botocore_session: existing botocore session instance
     :type botocore_session: botocore.session.Session
     """
-    kwargs = dict(key_ids=[aws_kms_cmk_arn])
+    kwargs = dict(key_ids=[aws_kms_cmk])
 
     if botocore_session is not None:
         kwargs["botocore_session"] = botocore_session

examples/src/oneshot_defaults.py

@@ -12,11 +12,11 @@
 from aws_encryption_sdk.keyrings.aws_kms import KmsKeyring
 
 
-def run(aws_kms_cmk_arn, source_plaintext):
+def run(aws_kms_cmk, source_plaintext):
     # type: (str, bytes) -> None
     """Demonstrate an encrypt/decrypt cycle using the one-shot encrypt/decrypt APIs.
 
-    :param str aws_kms_cmk_arn: AWS KMS CMK ARN to use to protect data keys
+    :param str aws_kms_cmk: AWS KMS CMK ARN to use to protect data keys
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
@@ -29,7 +29,7 @@ def run(aws_kms_cmk_arn, source_plaintext):
     }
 
     # Create the keyring that determines how your keys are protected.
-    keyring = KmsKeyring(generator_key_id=aws_kms_cmk_arn)
+    keyring = KmsKeyring(generator_key_id=aws_kms_cmk)
 
     # Encrypt your plaintext data.
     ciphertext, _encrypt_header = aws_encryption_sdk.encrypt(

examples/src/oneshot_unsigned.py

@@ -25,11 +25,11 @@
 from aws_encryption_sdk.keyrings.aws_kms import KmsKeyring
 
 
-def run(aws_kms_cmk_arn, source_plaintext):
+def run(aws_kms_cmk, source_plaintext):
     # type: (str, bytes) -> None
     """Demonstrate requesting a specific algorithm suite through the one-shot encrypt/decrypt APIs.
 
-    :param str aws_kms_cmk_arn: AWS KMS CMK ARN to use to protect data keys
+    :param str aws_kms_cmk: AWS KMS CMK ARN to use to protect data keys
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
@@ -42,7 +42,7 @@ def run(aws_kms_cmk_arn, source_plaintext):
     }
 
     # Create the keyring that determines how your keys are protected.
-    keyring = KmsKeyring(generator_key_id=aws_kms_cmk_arn)
+    keyring = KmsKeyring(generator_key_id=aws_kms_cmk)
 
     # Encrypt your plaintext data.
     ciphertext, _encrypt_header = aws_encryption_sdk.encrypt(

examples/test/examples_test_utils.py

@@ -19,7 +19,7 @@
 
 HERE = os.path.abspath(os.path.dirname(__file__))
 EXAMPLES_SOURCE = os.path.join(HERE, "..", "src")
-SINGLE_CMK_ARG = "aws_kms_cmk_arn"
+SINGLE_CMK_ARG = "aws_kms_cmk"
 GENERATOR_CMK_ARG = "aws_kms_generator_cmk"
 CHILD_CMK_ARG = "aws_kms_child_cmks"
 PLAINTEXT_ARG = "source_plaintext"