Amplitude recommend personalize workshop

aws/cloudformation-templates/base/_template.yaml

@@ -43,6 +43,16 @@ Parameters:
     Description: Amplitude API key for product analytics and A/B testing results (optional).
     NoEcho: true
 
+  AmplitudeSecretApiKey:
+    Type: String
+    Description: Amplitude secret API key from you project - this is used for the Profile API
+    NoEcho: true
+
+  AmplitudeRecommendationID:
+    Type: String
+    Description: Amplitude Receommender ID from the Recommender Details page
+    NoEcho: false
+
   ParentStackName:
     Type: String
     Description: Parent stack name
@@ -269,6 +279,8 @@ Resources:
         StackBucketName: !GetAtt Buckets.Outputs.StackBucketName
         ExperimentStrategyTableName: !GetAtt Tables.Outputs.ExperimentStrategyTable
         AmplitudeApiKey: !Ref AmplitudeApiKey
+        AmplitudeSecretApiKey: !Ref AmplitudeSecretApiKey
+        AmplitudeRecommendationID: !Ref AmplitudeRecommendationID
         OptimizelySdkKey: !Ref OptimizelySdkKey
         SegmentWriteKey: !Ref SegmentWriteKey
         mParticleOrgId: !Ref mParticleOrgId

aws/cloudformation-templates/base/ssm.yaml

@@ -16,6 +16,16 @@ Parameters:
     Description: Amplitude API key for product analytics and A/B testing results (optional).
     NoEcho: true
 
+  AmplitudeSecretApiKey:
+    Type: String
+    Description: Amplitude secret API key from you project - this is used for the Profile API
+    NoEcho: true
+
+  AmplitudeRecommendationID:
+    Type: String
+    Description: Amplitude Receommender ID from the Recommender Details page
+    NoEcho: false
+
   OptimizelySdkKey:
     Type: String
     Description: Optimizely SDK key for experimentation (optional).
@@ -61,6 +71,10 @@ Parameters:
 Conditions:
   HasAmplitudeApiKey:
     !Not [!Equals [!Ref AmplitudeApiKey, ""]]
+  HasAmplitudeSecretApiKey:
+    !Not [!Equals [!Ref AmplitudeSecretApiKey, ""]]
+  HasAmplitudeRecommendationID:
+    !Not [!Equals [!Ref AmplitudeRecommendationID, ""]]
   HasOptimizelySdkKey:
     !Not [!Equals [!Ref OptimizelySdkKey, ""]]
   HasSegmentWriteKey:
@@ -180,11 +194,27 @@ Resources:
   ParameterAmplitudeApiKey:
     Type: "AWS::SSM::Parameter"
     Properties:
-      Name: "retaildemostore-amplitude-api-key"
+      Name: "/retaildemostore/webui/amplitude_api_key"
       Type: "String"
       Value: !If [HasAmplitudeApiKey, !Ref AmplitudeApiKey, "NONE"]
       Description: "Retail Demo Store Amplitude API key"
 
+  ParameterAmplitudeSecretApiKey:
+    Type: "AWS::SSM::Parameter"
+    Properties:
+      Name: "/retaildemostore/webui/amplitude_secret_api_key"
+      Type: "String"
+      Value: !If [HasAmplitudeSecretApiKey, !Ref AmplitudeSecretApiKey, "NONE"]
+      Description: "Retail Demo Store Amplitude secret API key"
+
+  ParameterAmplitudeRecommendationID:
+    Type: "AWS::SSM::Parameter"
+    Properties:
+      Name: "/retaildemostore/webui/amplitude_recommendation_id"
+      Type: "String"
+      Value: !If [HasAmplitudeRecommendationID, !Ref AmplitudeRecommendationID, "NONE"]
+      Description: "Retail Demo Store Amplitude Recommender ID (see Recommender Details page)"
+
   ParameterOptimizelySdkKey:
     Type: "AWS::SSM::Parameter"
     Properties:

aws/cloudformation-templates/services/_template.yaml

@@ -100,10 +100,6 @@ Parameters:
     Type: String
     Description: SSM parameter name for the Personalize event tracking ID
 
-  ParameterAmplitudeApiKey:
-    Type: String
-    Description: SSM parameter name for the Amplitude API key
-
   ParameterOptimizelySdkKey:
     Type: String
     Description: SSM parameter name for the Optimizely SDK key
@@ -160,7 +156,6 @@ Resources:
         CategoriesTable: !Ref CategoriesTable
         ExperimentStrategyTable: !Ref ExperimentStrategyTable
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -193,7 +188,6 @@ Resources:
         ClusterName: !Ref ClusterName
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         PinpointAppId: !Ref PinpointAppId
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
@@ -227,7 +221,6 @@ Resources:
         ClusterName: !Ref ClusterName
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -260,7 +253,6 @@ Resources:
         ClusterName: !Ref ClusterName
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -294,7 +286,6 @@ Resources:
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         EnvOpenSearchDomainEndpoint: !Ref EnvOpenSearchDomainEndpoint
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -328,7 +319,6 @@ Resources:
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         EnvOpenSearchDomainEndpoint: !Ref EnvOpenSearchDomainEndpoint
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -362,7 +352,6 @@ Resources:
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         EnvOpenSearchDomainEndpoint: !Ref EnvOpenSearchDomainEndpoint
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -398,7 +387,6 @@ Resources:
         CategoriesTable: !Ref CategoriesTable
         ExperimentStrategyTable: !Ref ExperimentStrategyTable
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !GetAtt DeleteRepositoryLambdaFunction.Arn
@@ -431,7 +419,6 @@ Resources:
         ClusterName: !Ref ClusterName
         ServiceDiscoveryNamespace: !Ref ServiceDiscoveryNamespace
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         ParameterIVSVideoChannelMap: !Ref ParameterIVSVideoChannelMap
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn

aws/cloudformation-templates/services/service/_template.yaml

@@ -257,7 +257,6 @@ Resources:
         SearchServiceExternalUrl: !Ref SearchServiceExternalUrl
         PinpointAppId: !Ref PinpointAppId
         ParameterPersonalizeEventTrackerId: !Ref ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !Ref ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !Ref ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !Ref CleanupBucketLambdaArn
         DeleteRepositoryLambdaArn: !Ref DeleteRepositoryLambdaArn

aws/cloudformation-templates/services/service/pipeline.yaml

@@ -86,10 +86,6 @@ Parameters:
   ParameterPersonalizeEventTrackerId:
     Type: String
 
-  ParameterAmplitudeApiKey:
-    Type: String
-    Description: SSM parameter name for the Amplitude API key
-
   ParameterOptimizelySdkKey:
     Type: String
     Description: SSM parameter name for the Optimizely SDK key
@@ -320,9 +316,6 @@ Resources:
           - Name: PERSONALIZE_TRACKING_ID
             Type: PARAMETER_STORE
             Value: !Ref ParameterPersonalizeEventTrackerId
-          - Name: AMPLITUDE_API_KEY
-            Type: PARAMETER_STORE
-            Value: !Ref ParameterAmplitudeApiKey
           - Name: OPTIMIZELY_SDK_KEY
             Type: PARAMETER_STORE
             Value: !Ref ParameterOptimizelySdkKey

aws/cloudformation-templates/services/service/service.yaml

@@ -342,6 +342,10 @@ Resources:
           Secrets:
             - Name: OPTIMIZELY_SDK_KEY
               ValueFrom: !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/retaildemostore-optimizely-sdk-key'
+            - Name: AMPLITUDE_SECRET_API_KEY
+              ValueFrom: !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/retaildemostore/webui/amplitude_secret_api_key'
+            - Name: AMPLITUDE_RECOMMENDATION_ID
+              ValueFrom: !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/retaildemostore/webui/amplitude_recommendation_id'
             - Name: SEGMENT_WRITE_KEY
               ValueFrom: !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter/retaildemostore-segment-write-key'
           Environment:

aws/cloudformation-templates/template.yaml

@@ -59,6 +59,8 @@ Metadata:
           default: "Optional Integrations"
         Parameters:
           - AmplitudeApiKey
+          - AmplitudeSecretApiKey
+          - AmplitudeRecommendationID
           - OptimizelySdkKey
           - IncludeSegmentDependencies
           - SegmentWriteKey
@@ -117,6 +119,10 @@ Metadata:
         default: "Deploy personalized offers and pickup notices using Location Services geofencing"
       AmplitudeApiKey:
         default: "Amplitude API Key"
+      AmplitudeSecretApiKey:
+        default: "Amplitude Project Secret API Key"
+      AmplitudeRecommendationID:
+        default: "Amplitude Recommender ID (from the Recommender Details page)"
       OptimizelySdkKey:
         default: "Optimizely SDK Key"
       AmazonPayStoreId:
@@ -292,6 +298,16 @@ Parameters:
     Description: Amplitude API key for integrated product analytics and A/B testing results (optional).
     NoEcho: true
 
+  AmplitudeSecretApiKey:
+    Type: String
+    Description: Amplitude secret API key from you project - this is used for the Profile API
+    NoEcho: true
+
+  AmplitudeRecommendationID:
+    Type: String
+    Description: Amplitude Receommender ID from the Recommender Details page
+    NoEcho: false
+
   OptimizelySdkKey:
     Type: String
     Description: Optimizely SDK key for experimentation (optional).
@@ -505,6 +521,8 @@ Resources:
         CreateOpenSearchServiceLinkedRole: !Ref CreateOpenSearchServiceLinkedRole
         CleanupBucketLambdaArn: !GetAtt CleanupBucket.Outputs.LambdaFunctionArn
         AmplitudeApiKey: !Ref AmplitudeApiKey
+        AmplitudeSecretApiKey: !Ref AmplitudeSecretApiKey
+        AmplitudeRecommendationID: !Ref AmplitudeRecommendationID
         ParentStackName: !Ref AWS::StackName
         OptimizelySdkKey: !Ref OptimizelySdkKey
         SegmentWriteKey: !Ref SegmentWriteKey
@@ -554,7 +572,6 @@ Resources:
         CategoriesTable: !GetAtt Base.Outputs.CategoriesTable
         ExperimentStrategyTable: !GetAtt Base.Outputs.ExperimentStrategyTable
         ParameterPersonalizeEventTrackerId: !GetAtt Base.Outputs.ParameterPersonalizeEventTrackerId
-        ParameterAmplitudeApiKey: !GetAtt Base.Outputs.ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !GetAtt Base.Outputs.ParameterOptimizelySdkKey
         CleanupBucketLambdaArn: !GetAtt CleanupBucket.Outputs.LambdaFunctionArn
         ParameterIVSVideoChannelMap: !GetAtt Base.Outputs.ParameterIVSVideoChannelMap
@@ -618,7 +635,6 @@ Resources:
             !GetAtt Location.Outputs.LocationNotificationEndpoint,
             "NotDeployed",
           ]
-        ParameterAmplitudeApiKey: !GetAtt Base.Outputs.ParameterAmplitudeApiKey
         ParameterOptimizelySdkKey: !GetAtt Base.Outputs.ParameterOptimizelySdkKey
         ParameterSegmentWriteKey: !GetAtt Base.Outputs.ParameterSegmentWriteKey
         ParameterGoogleAnalyticsMeasurementId: !GetAtt Base.Outputs.ParameterGoogleAnalyticsMeasurementId

aws/cloudformation-templates/web-ui-pipeline.yaml

@@ -118,10 +118,6 @@ Parameters:
   ParameterPersonalizeEventTrackerId:
     Type: String
 
-  ParameterAmplitudeApiKey:
-    Type: String
-    Description: SSM parameter name for the Amplitude API key parameter name
-
   ParameterOptimizelySdkKey:
     Type: String
     Description: SSM Parameter name for the Optimizely SDK key parameter name
@@ -433,9 +429,6 @@ Resources:
           - Name: PERSONALIZE_TRACKING_ID
             Type: PARAMETER_STORE
             Value: !Ref ParameterPersonalizeEventTrackerId
-          - Name: AMPLITUDE_API_KEY
-            Type: PARAMETER_STORE
-            Value: !Ref ParameterAmplitudeApiKey
           - Name: OPTIMIZELY_SDK_KEY
             Type: PARAMETER_STORE
             Value: !Ref ParameterOptimizelySdkKey

generators/datagenerator/output.py

@@ -5,9 +5,6 @@
 from datagenerator.amplitude import AmplitudeIdentifyEvent, AmplitudeTrackEvent, AmplitudeSender
 from datagenerator.file import FileEvent
 
-# TODO: Add Personalize output file formatter
-# TODO: Add Amplitude output formatter
-
 class OutputFormatter:
   def __init__(self, timestamp, user, platform, properties, name = None):
     self.event = name

generators/generate_amplitude_conversion_events.py

@@ -0,0 +1,66 @@
+import os
+import requests
+import uuid
+import time
+import json
+
+amplitude_secret_key = '1795766d2d822cda9f4875654f9a6ee6'
+amplitude_rec_id = 'xv8mseo'
+
+conversion = .2
+
+control_group = []
+experiment_group = []
+
+output_file_name = 'src/aws-lambda/personalize-pre-create-resources/data/amplitude/conversion_events.json'
+
+conversion_event = 'Purchase'
+
+timestamp_start = time.time() # Start of script timestamp
+first_timestamp = timestamp_start - (60*60*24*2)
+
+def write_events(user_group):
+    # Generate output file for experiment group
+    time_increment = (60*60*24*2) / len(experiment_group)
+
+    with open(output_file_name, 'w') as f:
+        timestamp = first_timestamp
+        for user in user_group:
+            amplitude_event = {
+                "event_type": conversion_event,
+                "time": int(timestamp * 1000),  # Amplitude wants time in ms since the epoch, we have sec
+                "user_id": user['user_id'],  # Amplitude wants a UID as a string with no less than 5 chars
+                "insert_id": str(uuid.uuid4()),  # This is to prevent duplicates when re-running event gen scripts
+                "event_properties": {
+                    "product_id": user['items'][1],
+                }
+            }
+
+            f.write(f'{json.dumps(amplitude_event)}\n')
+            timestamp += time_increment
+
+for user_id in range(1000, 2500):
+    uid = f'{user_id:0>5}' 
+    response = requests.get('https://profile-api.amplitude.com/v1/userprofile', 
+        headers={'Authorization': f'Api-Key {amplitude_secret_key}'},
+        params={'user_id': uid, 'rec_id': amplitude_rec_id})
+    res = response.json()
+    items = []
+    is_user_in_control_group = True
+    if res:
+        for item in res['userData']['recommendations'][0]['items']:
+            items.append(item)
+
+        is_user_in_control_group = res['userData']['recommendations'][0]['is_control']
+
+        if is_user_in_control_group:
+            control_group.append({'user_id': uid, 'items': items})
+        else:
+            experiment_group.append({'user_id': uid, 'items': items})
+
+    #print(f'{uid} {is_user_in_control_group}')
+
+write_events(experiment_group)
+# split the control list by half
+half_length = int(len(control_group) / 2)
+write_events(control_group[half_length:])