Skip to content

Commit 3a1b741

Browse files
author
AWS
committed
Amazon Personalize Update: Add support for eventsConfig for CreateSolution, UpdateSolution, DescribeSolution, DescribeSolutionVersion. Add support for GetSolutionMetrics to return weighted NDCG metrics when eventsConfig is enabled for the solution.
1 parent d11d306 commit 3a1b741

File tree

2 files changed

+61
-5
lines changed

2 files changed

+61
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Personalize",
4+
"contributor": "",
5+
"description": "Add support for eventsConfig for CreateSolution, UpdateSolution, DescribeSolution, DescribeSolutionVersion. Add support for GetSolutionMetrics to return weighted NDCG metrics when eventsConfig is enabled for the solution."
6+
}

services/personalize/src/main/resources/codegen-resources/service-2.json

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@
311311
{"shape":"ResourceNotFoundException"},
312312
{"shape":"ResourceInUseException"}
313313
],
314-
"documentation":"<p>Deletes a dataset. You can't delete a dataset if an associated <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html\">CreateDataset</a>.</p>",
314+
"documentation":"<p>Deletes a dataset. You can't delete a dataset if an associated <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information about deleting datasets, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/delete-dataset.html\">Deleting a dataset</a>. </p>",
315315
"idempotent":true
316316
},
317317
"DeleteDatasetGroup":{
@@ -1662,7 +1662,8 @@
16621662
},
16631663
"ColumnName":{
16641664
"type":"string",
1665-
"max":150
1665+
"max":150,
1666+
"pattern":"[A-Za-z_][A-Za-z\\d_]*"
16661667
},
16671668
"ColumnNamesList":{
16681669
"type":"list",
@@ -3385,6 +3386,29 @@
33853386
]
33863387
},
33873388
"ErrorMessage":{"type":"string"},
3389+
"EventParameters":{
3390+
"type":"structure",
3391+
"members":{
3392+
"eventType":{
3393+
"shape":"EventType",
3394+
"documentation":"<p>The name of the event type to be considered for solution creation.</p>"
3395+
},
3396+
"eventValueThreshold":{
3397+
"shape":"EventTypeThresholdValue",
3398+
"documentation":"<p>The threshold of the event type. Only events with a value greater or equal to this threshold will be considered for solution creation.</p>"
3399+
},
3400+
"weight":{
3401+
"shape":"EventTypeWeight",
3402+
"documentation":"<p>The weight of the event type. A higher weight means higher importance of the event type for the created solution.</p>"
3403+
}
3404+
},
3405+
"documentation":"<p>Describes the parameters of events, which are used in solution creation.</p>"
3406+
},
3407+
"EventParametersList":{
3408+
"type":"list",
3409+
"member":{"shape":"EventParameters"},
3410+
"max":10
3411+
},
33883412
"EventTracker":{
33893413
"type":"structure",
33903414
"members":{
@@ -3458,10 +3482,26 @@
34583482
"type":"string",
34593483
"max":256
34603484
},
3485+
"EventTypeThresholdValue":{"type":"double"},
3486+
"EventTypeWeight":{
3487+
"type":"double",
3488+
"max":1,
3489+
"min":0
3490+
},
34613491
"EventValueThreshold":{
34623492
"type":"string",
34633493
"max":256
34643494
},
3495+
"EventsConfig":{
3496+
"type":"structure",
3497+
"members":{
3498+
"eventParametersList":{
3499+
"shape":"EventParametersList",
3500+
"documentation":"<p>A list of event parameters, which includes event types and their event value thresholds and weights.</p>"
3501+
}
3502+
},
3503+
"documentation":"<p>Describes the configuration of events, which are used in solution creation.</p>"
3504+
},
34653505
"ExcludedDatasetColumns":{
34663506
"type":"map",
34673507
"key":{"shape":"DatasetType"},
@@ -4888,6 +4928,10 @@
48884928
"shape":"AutoMLConfig",
48894929
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html\">AutoMLConfig</a> object containing a list of recipes to search when AutoML is performed.</p>"
48904930
},
4931+
"eventsConfig":{
4932+
"shape":"EventsConfig",
4933+
"documentation":"<p>Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.</p>"
4934+
},
48914935
"optimizationObjective":{
48924936
"shape":"OptimizationObjective",
48934937
"documentation":"<p>Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html\">Optimizing a solution</a>.</p>"
@@ -4936,7 +4980,11 @@
49364980
"SolutionUpdateConfig":{
49374981
"type":"structure",
49384982
"members":{
4939-
"autoTrainingConfig":{"shape":"AutoTrainingConfig"}
4983+
"autoTrainingConfig":{"shape":"AutoTrainingConfig"},
4984+
"eventsConfig":{
4985+
"shape":"EventsConfig",
4986+
"documentation":"<p>Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.</p>"
4987+
}
49404988
},
49414989
"documentation":"<p>The configuration details of the solution update.</p>"
49424990
},
@@ -5162,7 +5210,8 @@
51625210
"type":"string",
51635211
"max":128,
51645212
"min":1,
5165-
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
5213+
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
5214+
"sensitive":true
51665215
},
51675216
"TagKeys":{
51685217
"type":"list",
@@ -5196,7 +5245,8 @@
51965245
"type":"string",
51975246
"max":256,
51985247
"min":0,
5199-
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
5248+
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
5249+
"sensitive":true
52005250
},
52015251
"Tags":{
52025252
"type":"list",

0 commit comments

Comments
 (0)