auto commit

Author: rishav-karanjit

Examples/runtimes/go/searchableencryption/complexexample/beaconConfig.go

@@ -33,7 +33,12 @@ import (
  * our workshop using the encryption client.
  */
 
-func SetupBeaconConfig(ctx context.Context, ddbTableName, branchKeyId, branchKeyWrappingKmsKeyArn, branchKeyDdbTableName string) (*dynamodb.Client, error) {
+func SetupBeaconConfig(
+	ctx context.Context,
+	ddbTableName,
+	branchKeyId,
+	branchKeyWrappingKmsKeyArn,
+	branchKeyDdbTableName string) (*dynamodb.Client, error) {
 	// 1. Create Keystore and branch key.
 	//    These are the same constructions as in the Basic examples, which describe this in more detail.
 	cfg, err := config.LoadDefaultConfig(ctx)
@@ -64,7 +69,7 @@ func SetupBeaconConfig(ctx context.Context, ddbTableName, branchKeyId, branchKey
 	//    For this example, we use a standard beacon length of 4.
 	//    The BasicSearchableEncryptionExample gives a more thorough consideration of beacon length.
 	//    For production applications, one should always exercise rigor when deciding beacon length, including
-	//        examining population size and considering performance.
+	//    examining population size and considering performance.
 	standardBeaconList := []dbesdkdynamodbencryptiontypes.StandardBeacon{
 		{Name: "EmployeeID", Length: 4},
 		{Name: "TicketNumber", Length: 4},
@@ -109,7 +114,7 @@ func SetupBeaconConfig(ctx context.Context, ddbTableName, branchKeyId, branchKey
 	//    These are unencrypted attributes we would like to use in beacon queries.
 	//    In this example, all of these represent dates or times.
 	//    Keeping these attributes unencrypted allows us to use them in comparison-based queries. If a signed
-	//        part is the first part in a compound beacon, then that part can be used in comparison for sorting.
+	//    part is the first part in a compound beacon, then that part can be used in comparison for sorting.
 	signedPartList := []dbesdkdynamodbencryptiontypes.SignedPart{
 		{Name: "TicketModTime", Prefix: "M-"},
 		{Name: "MeetingStart", Prefix: "MS-"},

Examples/runtimes/go/searchableencryption/complexexample/complexsearchableencryptionexample.go

@@ -10,6 +10,16 @@ import (
 	"github.com/aws/aws-database-encryption-sdk-dynamodb/examples/utils"
 )
 
+/*
+ * This file is used in an example to demonstrate complex queries
+ * you can perform using beacons.
+ * The example data used is for demonstrative purposes only,
+ * and might not meet the distribution and correlation uniqueness
+ * recommendations for beacons.
+ * See our documentation for whether beacons are
+ * right for your particular data set:
+ * https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/searchable-encryption.html#are-beacons-right-for-me
+ */
 func ComplexSearchableEncryptionExample(
 	ddbTableName,
 	branchKeyId,

Examples/runtimes/go/searchableencryption/complexexample/putRequests.go

@@ -20,9 +20,9 @@ import (
  * right for your particular data set:
  * https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/searchable-encryption.html#are-beacons-right-for-me
  *
- * This class implements PutItem calls to populate a DDB table with items from our workshop.
+ * This file implements PutItem calls to populate a DDB table with items from our workshop.
  * By providing a DynamoDbClient that is configured to use searchable encryption,
- *   this class will encrypt the data client side and add beacon attributes to the items.
+ *   this file will encrypt the data client side and add beacon attributes to the items.
  * This only implements a single item of each of the 6 record types from Demo.md. Adding the remaining
  *   items would extend the test and example coverage.
  */
@@ -65,7 +65,7 @@ func listAttr(l []types.AttributeValue) types.AttributeValue {
 	return &types.AttributeValueMemberL{Value: l}
 }
 
-// emeeting.json
+// meeting.json
 // PutAllMeetingItemsToTable puts all meeting items to the table
 func PutAllMeetingItemsToTable(ctx context.Context, ddbTableName string, ddb *dynamodb.Client) error {
 	// Meeting 1