Skip to content

Commit 8f9c2a2

Browse files
author
AWS
committed
Amazon Personalize Update: Add 'exploration' functionality
1 parent 7a89430 commit 8f9c2a2

File tree

2 files changed

+53
-5
lines changed

2 files changed

+53
-5
lines changed

‎.changes/next-release/feature-AmazonPersonalize-819e8a4.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Personalize",
4+
"description": "Add 'exploration' functionality"
5+
}

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

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
{"shape":"LimitExceededException"},
9797
{"shape":"ResourceInUseException"}
9898
],
99-
"documentation":"<p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source.</p> <important> <p>The dataset import job replaces any previous data in the dataset.</p> </important> <p> <b>Status</b> </p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> </ul> <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <note> <p>Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListDatasetImportJobs</a> </p> </li> <li> <p> <a>DescribeDatasetImportJob</a> </p> </li> </ul>"
99+
"documentation":"<p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.</p> <important> <p>The dataset import job replaces any previous data in the dataset.</p> </important> <p> <b>Status</b> </p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> </ul> <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <note> <p>Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListDatasetImportJobs</a> </p> </li> <li> <p> <a>DescribeDatasetImportJob</a> </p> </li> </ul>"
100100
},
101101
"CreateEventTracker":{
102102
"name":"CreateEventTracker",
@@ -130,7 +130,7 @@
130130
{"shape":"ResourceNotFoundException"},
131131
{"shape":"LimitExceededException"}
132132
],
133-
"documentation":"<p>Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.</p>"
133+
"documentation":"<p>Creates a recommendation filter. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filters.html\">Using Filters with Amazon Personalize</a>.</p>"
134134
},
135135
"CreateSchema":{
136136
"name":"CreateSchema",
@@ -176,6 +176,7 @@
176176
"errors":[
177177
{"shape":"InvalidInputException"},
178178
{"shape":"ResourceNotFoundException"},
179+
{"shape":"LimitExceededException"},
179180
{"shape":"ResourceInUseException"}
180181
],
181182
"documentation":"<p>Trains or retrains an active solution. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling <code>CreateSolutionVersion</code>. A new version of the solution is created every time you call this operation.</p> <p> <b>Status</b> </p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> </ul> <p>To get the status of the version, call <a>DescribeSolutionVersion</a>. Wait until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p> <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListSolutionVersions</a> </p> </li> <li> <p> <a>DescribeSolutionVersion</a> </p> </li> </ul> <ul> <li> <p> <a>ListSolutions</a> </p> </li> <li> <p> <a>CreateSolution</a> </p> </li> <li> <p> <a>DescribeSolution</a> </p> </li> <li> <p> <a>DeleteSolution</a> </p> </li> </ul>"
@@ -249,7 +250,8 @@
249250
"input":{"shape":"DeleteFilterRequest"},
250251
"errors":[
251252
{"shape":"InvalidInputException"},
252-
{"shape":"ResourceNotFoundException"}
253+
{"shape":"ResourceNotFoundException"},
254+
{"shape":"ResourceInUseException"}
253255
],
254256
"documentation":"<p>Deletes a filter.</p>"
255257
},
@@ -812,6 +814,10 @@
812814
"shape":"BatchInferenceJobOutput",
813815
"documentation":"<p>The Amazon S3 bucket that contains the output data generated by the batch inference job.</p>"
814816
},
817+
"batchInferenceJobConfig":{
818+
"shape":"BatchInferenceJobConfig",
819+
"documentation":"<p>A string to string map of the configuration details of a batch inference job.</p>"
820+
},
815821
"roleArn":{
816822
"shape":"RoleArn",
817823
"documentation":"<p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.</p>"
@@ -831,6 +837,16 @@
831837
},
832838
"documentation":"<p>Contains information on a batch inference job.</p>"
833839
},
840+
"BatchInferenceJobConfig":{
841+
"type":"structure",
842+
"members":{
843+
"itemExplorationConfig":{
844+
"shape":"HyperParameters",
845+
"documentation":"<p>A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See <a>customizing-solution-config-hpo</a>.</p>"
846+
}
847+
},
848+
"documentation":"<p>The configuration details of a batch inference job.</p>"
849+
},
834850
"BatchInferenceJobInput":{
835851
"type":"structure",
836852
"required":["s3DataSource"],
@@ -912,6 +928,10 @@
912928
"shape":"TransactionsPerSecond",
913929
"documentation":"<p>Specifies the requested minimum provisioned transactions (recommendations) per second.</p>"
914930
},
931+
"campaignConfig":{
932+
"shape":"CampaignConfig",
933+
"documentation":"<p>The configuration details of a campaign.</p>"
934+
},
915935
"status":{
916936
"shape":"Status",
917937
"documentation":"<p>The status of the campaign.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p> </li> </ul>"
@@ -932,6 +952,16 @@
932952
},
933953
"documentation":"<p>Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see <a>CreateCampaign</a>.</p>"
934954
},
955+
"CampaignConfig":{
956+
"type":"structure",
957+
"members":{
958+
"itemExplorationConfig":{
959+
"shape":"HyperParameters",
960+
"documentation":"<p>A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See <a>customizing-solution-config-hpo</a>.</p>"
961+
}
962+
},
963+
"documentation":"<p>The configuration details of a campaign.</p>"
964+
},
935965
"CampaignSummary":{
936966
"type":"structure",
937967
"members":{
@@ -973,6 +1003,7 @@
9731003
"shape":"TransactionsPerSecond",
9741004
"documentation":"<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>"
9751005
},
1006+
"campaignConfig":{"shape":"CampaignConfig"},
9761007
"status":{
9771008
"shape":"Status",
9781009
"documentation":"<p>The status of the campaign update.</p> <p>A campaign update can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING &gt; DELETE IN_PROGRESS</p> </li> </ul>"
@@ -1093,6 +1124,10 @@
10931124
"roleArn":{
10941125
"shape":"RoleArn",
10951126
"documentation":"<p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.</p>"
1127+
},
1128+
"batchInferenceJobConfig":{
1129+
"shape":"BatchInferenceJobConfig",
1130+
"documentation":"<p>The configuration details of a batch inference job.</p>"
10961131
}
10971132
}
10981133
},
@@ -1124,6 +1159,10 @@
11241159
"minProvisionedTPS":{
11251160
"shape":"TransactionsPerSecond",
11261161
"documentation":"<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>"
1162+
},
1163+
"campaignConfig":{
1164+
"shape":"CampaignConfig",
1165+
"documentation":"<p>The configuration details of a campaign.</p>"
11271166
}
11281167
}
11291168
},
@@ -1283,7 +1322,7 @@
12831322
},
12841323
"filterExpression":{
12851324
"shape":"FilterExpression",
1286-
"documentation":"<p>The filter expression that designates the interaction types that the filter will filter out. A filter expression must follow the following format:</p> <p> <code>EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")</code> </p> <p>Where \"EVENT_TYPE\" is the type of event to filter out. To filter out all items with any interactions history, set <code>\"*\"</code> as the EVENT_TYPE. For more information, see Using Filters with Amazon Personalize.</p>"
1325+
"documentation":"<p>The filter expression that designates the interaction types that the filter will filter out. A filter expression must follow the following format:</p> <p> <code>EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")</code> </p> <p>Where \"EVENT_TYPE\" is the type of event to filter out. To filter out all items with any interactions history, set <code>\"*\"</code> as the EVENT_TYPE. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filters.html\">Using Filters with Amazon Personalize</a>.</p>"
12871326
}
12881327
}
12891328
},
@@ -2244,7 +2283,7 @@
22442283
},
22452284
"filterExpression":{
22462285
"shape":"FilterExpression",
2247-
"documentation":"<p>Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format:</p> <p> <code>EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")</code> </p> <p>Where \"EVENT_TYPE\" is the type of event to filter out. For more information, see Using Filters with Amazon Personalize.</p>"
2286+
"documentation":"<p>Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format:</p> <p> <code>EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")</code> </p> <p>Where \"EVENT_TYPE\" is the type of event to filter out. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filters.html\">Using Filters with Amazon Personalize</a>.</p>"
22482287
},
22492288
"status":{
22502289
"shape":"Status",
@@ -3227,6 +3266,10 @@
32273266
"minProvisionedTPS":{
32283267
"shape":"TransactionsPerSecond",
32293268
"documentation":"<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>"
3269+
},
3270+
"campaignConfig":{
3271+
"shape":"CampaignConfig",
3272+
"documentation":"<p>The configuration details of a campaign.</p>"
32303273
}
32313274
}
32323275
},

0 commit comments

Comments
 (0)