Skip to content

Commit 26038cd

Browse files
This release provides ability to customers to change schema associated with their datasets in Amazon Personalize
1 parent cfa79d5 commit 26038cd

21 files changed

+1241
-7
lines changed

generator/ServiceModels/personalize/personalize-2018-05-22.api.json

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -953,6 +953,21 @@
953953
],
954954
"idempotent":true
955955
},
956+
"UpdateDataset":{
957+
"name":"UpdateDataset",
958+
"http":{
959+
"method":"POST",
960+
"requestUri":"/"
961+
},
962+
"input":{"shape":"UpdateDatasetRequest"},
963+
"output":{"shape":"UpdateDatasetResponse"},
964+
"errors":[
965+
{"shape":"InvalidInputException"},
966+
{"shape":"ResourceNotFoundException"},
967+
{"shape":"ResourceInUseException"}
968+
],
969+
"idempotent":true
970+
},
956971
"UpdateMetricAttribution":{
957972
"name":"UpdateMetricAttribution",
958973
"http":{
@@ -1557,7 +1572,8 @@
15571572
"schemaArn":{"shape":"Arn"},
15581573
"status":{"shape":"Status"},
15591574
"creationDateTime":{"shape":"Date"},
1560-
"lastUpdatedDateTime":{"shape":"Date"}
1575+
"lastUpdatedDateTime":{"shape":"Date"},
1576+
"latestDatasetUpdate":{"shape":"DatasetUpdateSummary"}
15611577
}
15621578
},
15631579
"DatasetExportJob":{
@@ -1698,6 +1714,16 @@
16981714
"type":"string",
16991715
"max":256
17001716
},
1717+
"DatasetUpdateSummary":{
1718+
"type":"structure",
1719+
"members":{
1720+
"schemaArn":{"shape":"Arn"},
1721+
"status":{"shape":"Status"},
1722+
"failureReason":{"shape":"FailureReason"},
1723+
"creationDateTime":{"shape":"Date"},
1724+
"lastUpdatedDateTime":{"shape":"Date"}
1725+
}
1726+
},
17011727
"Datasets":{
17021728
"type":"list",
17031729
"member":{"shape":"DatasetSummary"},
@@ -3043,6 +3069,23 @@
30433069
"campaignArn":{"shape":"Arn"}
30443070
}
30453071
},
3072+
"UpdateDatasetRequest":{
3073+
"type":"structure",
3074+
"required":[
3075+
"datasetArn",
3076+
"schemaArn"
3077+
],
3078+
"members":{
3079+
"datasetArn":{"shape":"Arn"},
3080+
"schemaArn":{"shape":"Arn"}
3081+
}
3082+
},
3083+
"UpdateDatasetResponse":{
3084+
"type":"structure",
3085+
"members":{
3086+
"datasetArn":{"shape":"Arn"}
3087+
}
3088+
},
30463089
"UpdateMetricAttributionRequest":{
30473090
"type":"structure",
30483091
"members":{

generator/ServiceModels/personalize/personalize-2018-05-22.docs.json

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
"TagResource": "<p>Add a list of tags to a resource.</p>",
6767
"UntagResource": "<p>Remove <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html\">tags</a> that are attached to a resource.</p>",
6868
"UpdateCampaign": "<p>Updates a campaign by either deploying a new solution or changing the value of the campaign's <code>minProvisionedTPS</code> parameter.</p> <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a> operation.</p> <note> <p>You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is <code>Active</code>. </p> </note> <p>For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
69+
"UpdateDataset": "<p>Update a dataset to replace its schema with a new or existing one. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html\">Replacing a dataset's schema</a>. </p>",
6970
"UpdateMetricAttribution": "<p>Updates a metric attribution.</p>",
7071
"UpdateRecommender": "<p>Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the <code>latestRecommenderUpdate</code> returned in the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html\">DescribeRecommender</a> operation. </p>"
7172
},
@@ -135,7 +136,7 @@
135136
"CreateRecommenderRequest$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html\">Choosing recommender use cases</a>. </p>",
136137
"CreateRecommenderResponse$recommenderArn": "<p>The Amazon Resource Name (ARN) of the recommender.</p>",
137138
"CreateSchemaResponse$schemaArn": "<p>The Amazon Resource Name (ARN) of the created schema.</p>",
138-
"CreateSolutionRequest$recipeArn": "<p>The ARN of the recipe to use for model training. Only specified when <code>performAutoML</code> is false.</p>",
139+
"CreateSolutionRequest$recipeArn": "<p>The ARN of the recipe to use for model training. This is required when <code>performAutoML</code> is false.</p>",
139140
"CreateSolutionRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>",
140141
"CreateSolutionResponse$solutionArn": "<p>The ARN of the solution.</p>",
141142
"CreateSolutionVersionRequest$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution containing the training configuration information.</p>",
@@ -156,6 +157,7 @@
156157
"DatasetSchema$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema.</p>",
157158
"DatasetSchemaSummary$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema.</p>",
158159
"DatasetSummary$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset.</p>",
160+
"DatasetUpdateSummary$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.</p>",
159161
"DeleteCampaignRequest$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign to delete.</p>",
160162
"DeleteDatasetGroupRequest$datasetGroupArn": "<p>The ARN of the dataset group to delete.</p>",
161163
"DeleteDatasetRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to delete.</p>",
@@ -220,7 +222,7 @@
220222
"RecommenderSummary$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>",
221223
"RecommenderSummary$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.</p>",
222224
"Solution$solutionArn": "<p>The ARN of the solution.</p>",
223-
"Solution$recipeArn": "<p>The ARN of the recipe used to create the solution.</p>",
225+
"Solution$recipeArn": "<p>The ARN of the recipe used to create the solution. This is required when <code>performAutoML</code> is false.</p>",
224226
"Solution$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>",
225227
"SolutionSummary$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution.</p>",
226228
"SolutionSummary$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe used by the solution.</p>",
@@ -239,6 +241,9 @@
239241
"UpdateCampaignRequest$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign.</p>",
240242
"UpdateCampaignRequest$solutionVersionArn": "<p>The ARN of a new solution version to deploy.</p>",
241243
"UpdateCampaignResponse$campaignArn": "<p>The same campaign ARN as given in the request.</p>",
244+
"UpdateDatasetRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset that you want to update.</p>",
245+
"UpdateDatasetRequest$schemaArn": "<p>The Amazon Resource Name (ARN) of the new schema you want use.</p>",
246+
"UpdateDatasetResponse$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset you updated.</p>",
242247
"UpdateMetricAttributionRequest$metricAttributionArn": "<p>The Amazon Resource Name (ARN) for the metric attribution to update.</p>",
243248
"UpdateMetricAttributionResponse$metricAttributionArn": "<p>The Amazon Resource Name (ARN) for the metric attribution that you updated.</p>",
244249
"UpdateRecommenderRequest$recommenderArn": "<p>The Amazon Resource Name (ARN) of the recommender to modify.</p>",
@@ -686,6 +691,12 @@
686691
"ExcludedDatasetColumns$key": null
687692
}
688693
},
694+
"DatasetUpdateSummary": {
695+
"base": "<p>Describes an update to a dataset.</p>",
696+
"refs": {
697+
"Dataset$latestDatasetUpdate": "<p>Describes the latest update to the dataset.</p>"
698+
}
699+
},
689700
"Datasets": {
690701
"base": null,
691702
"refs": {
@@ -731,6 +742,8 @@
731742
"DatasetSchemaSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the schema was last updated.</p>",
732743
"DatasetSummary$creationDateTime": "<p>The date and time (in Unix time) that the dataset was created.</p>",
733744
"DatasetSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the dataset was last updated.</p>",
745+
"DatasetUpdateSummary$creationDateTime": "<p>The creation date and time (in Unix time) of the dataset update.</p>",
746+
"DatasetUpdateSummary$lastUpdatedDateTime": "<p>The last update date and time (in Unix time) of the dataset.</p>",
734747
"EventTracker$creationDateTime": "<p>The date and time (in Unix format) that the event tracker was created.</p>",
735748
"EventTracker$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the event tracker was last updated.</p>",
736749
"EventTrackerSummary$creationDateTime": "<p>The date and time (in Unix time) that the event tracker was created.</p>",
@@ -1116,6 +1129,7 @@
11161129
"DatasetGroupSummary$failureReason": "<p>If creating a dataset group fails, the reason behind the failure.</p>",
11171130
"DatasetImportJob$failureReason": "<p>If a dataset import job fails, provides the reason why.</p>",
11181131
"DatasetImportJobSummary$failureReason": "<p>If a dataset import job fails, the reason behind the failure.</p>",
1132+
"DatasetUpdateSummary$failureReason": "<p>If updating a dataset fails, provides the reason why.</p>",
11191133
"Filter$failureReason": "<p>If the filter failed, the reason for its failure.</p>",
11201134
"FilterSummary$failureReason": "<p>If the filter failed, the reason for the failure.</p>",
11211135
"MetricAttribution$failureReason": "<p>The metric attribution's failure reason.</p>",
@@ -1913,6 +1927,7 @@
19131927
"DatasetImportJob$status": "<p>The status of the dataset import job.</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>",
19141928
"DatasetImportJobSummary$status": "<p>The status of the dataset import job.</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>",
19151929
"DatasetSummary$status": "<p>The status of the dataset.</p> <p>A dataset 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>",
1930+
"DatasetUpdateSummary$status": "<p>The status of the dataset update. </p>",
19161931
"EventTracker$status": "<p>The status of the event tracker.</p> <p>An event tracker 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>",
19171932
"EventTrackerSummary$status": "<p>The status of the event tracker.</p> <p>An event tracker 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>",
19181933
"FeatureTransformation$status": "<p>The status of the feature transformation.</p> <p>A feature transformation 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>",
@@ -2087,6 +2102,16 @@
20872102
"refs": {
20882103
}
20892104
},
2105+
"UpdateDatasetRequest": {
2106+
"base": null,
2107+
"refs": {
2108+
}
2109+
},
2110+
"UpdateDatasetResponse": {
2111+
"base": null,
2112+
"refs": {
2113+
}
2114+
},
20902115
"UpdateMetricAttributionRequest": {
20912116
"base": null,
20922117
"refs": {

generator/ServiceModels/personalize/personalize-2018-05-22.normal.json

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,6 +1017,22 @@
10171017
"documentation":"<p>Updates a campaign by either deploying a new solution or changing the value of the campaign's <code>minProvisionedTPS</code> parameter.</p> <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a> operation.</p> <note> <p>You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is <code>Active</code>. </p> </note> <p>For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
10181018
"idempotent":true
10191019
},
1020+
"UpdateDataset":{
1021+
"name":"UpdateDataset",
1022+
"http":{
1023+
"method":"POST",
1024+
"requestUri":"/"
1025+
},
1026+
"input":{"shape":"UpdateDatasetRequest"},
1027+
"output":{"shape":"UpdateDatasetResponse"},
1028+
"errors":[
1029+
{"shape":"InvalidInputException"},
1030+
{"shape":"ResourceNotFoundException"},
1031+
{"shape":"ResourceInUseException"}
1032+
],
1033+
"documentation":"<p>Update a dataset to replace its schema with a new or existing one. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html\">Replacing a dataset's schema</a>. </p>",
1034+
"idempotent":true
1035+
},
10201036
"UpdateMetricAttribution":{
10211037
"name":"UpdateMetricAttribution",
10221038
"http":{
@@ -2094,7 +2110,7 @@
20942110
},
20952111
"recipeArn":{
20962112
"shape":"Arn",
2097-
"documentation":"<p>The ARN of the recipe to use for model training. Only specified when <code>performAutoML</code> is false.</p>"
2113+
"documentation":"<p>The ARN of the recipe to use for model training. This is required when <code>performAutoML</code> is false.</p>"
20982114
},
20992115
"datasetGroupArn":{
21002116
"shape":"Arn",
@@ -2198,6 +2214,10 @@
21982214
"lastUpdatedDateTime":{
21992215
"shape":"Date",
22002216
"documentation":"<p>A time stamp that shows when the dataset was updated.</p>"
2217+
},
2218+
"latestDatasetUpdate":{
2219+
"shape":"DatasetUpdateSummary",
2220+
"documentation":"<p>Describes the latest update to the dataset.</p>"
22012221
}
22022222
},
22032223
"documentation":"<p>Provides metadata for a dataset.</p>"
@@ -2551,6 +2571,32 @@
25512571
"type":"string",
25522572
"max":256
25532573
},
2574+
"DatasetUpdateSummary":{
2575+
"type":"structure",
2576+
"members":{
2577+
"schemaArn":{
2578+
"shape":"Arn",
2579+
"documentation":"<p>The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.</p>"
2580+
},
2581+
"status":{
2582+
"shape":"Status",
2583+
"documentation":"<p>The status of the dataset update. </p>"
2584+
},
2585+
"failureReason":{
2586+
"shape":"FailureReason",
2587+
"documentation":"<p>If updating a dataset fails, provides the reason why.</p>"
2588+
},
2589+
"creationDateTime":{
2590+
"shape":"Date",
2591+
"documentation":"<p>The creation date and time (in Unix time) of the dataset update.</p>"
2592+
},
2593+
"lastUpdatedDateTime":{
2594+
"shape":"Date",
2595+
"documentation":"<p>The last update date and time (in Unix time) of the dataset.</p>"
2596+
}
2597+
},
2598+
"documentation":"<p>Describes an update to a dataset.</p>"
2599+
},
25542600
"Datasets":{
25552601
"type":"list",
25562602
"member":{"shape":"DatasetSummary"},
@@ -4456,7 +4502,7 @@
44564502
},
44574503
"recipeArn":{
44584504
"shape":"Arn",
4459-
"documentation":"<p>The ARN of the recipe used to create the solution.</p>"
4505+
"documentation":"<p>The ARN of the recipe used to create the solution. This is required when <code>performAutoML</code> is false.</p>"
44604506
},
44614507
"datasetGroupArn":{
44624508
"shape":"Arn",
@@ -4892,6 +4938,32 @@
48924938
}
48934939
}
48944940
},
4941+
"UpdateDatasetRequest":{
4942+
"type":"structure",
4943+
"required":[
4944+
"datasetArn",
4945+
"schemaArn"
4946+
],
4947+
"members":{
4948+
"datasetArn":{
4949+
"shape":"Arn",
4950+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset that you want to update.</p>"
4951+
},
4952+
"schemaArn":{
4953+
"shape":"Arn",
4954+
"documentation":"<p>The Amazon Resource Name (ARN) of the new schema you want use.</p>"
4955+
}
4956+
}
4957+
},
4958+
"UpdateDatasetResponse":{
4959+
"type":"structure",
4960+
"members":{
4961+
"datasetArn":{
4962+
"shape":"Arn",
4963+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset you updated.</p>"
4964+
}
4965+
}
4966+
},
48954967
"UpdateMetricAttributionRequest":{
48964968
"type":"structure",
48974969
"members":{

sdk/code-analysis/ServiceAnalysis/Personalize/Generated/PropertyValueRules.xml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,21 @@
766766
<max>256</max>
767767
<pattern>arn:([a-z\d-]+):personalize:.*:.*:.+</pattern>
768768
</property-value-rule>
769+
<property-value-rule>
770+
<property>Amazon.Personalize.Model.UpdateDatasetRequest.DatasetArn</property>
771+
<max>256</max>
772+
<pattern>arn:([a-z\d-]+):personalize:.*:.*:.+</pattern>
773+
</property-value-rule>
774+
<property-value-rule>
775+
<property>Amazon.Personalize.Model.UpdateDatasetRequest.SchemaArn</property>
776+
<max>256</max>
777+
<pattern>arn:([a-z\d-]+):personalize:.*:.*:.+</pattern>
778+
</property-value-rule>
779+
<property-value-rule>
780+
<property>Amazon.Personalize.Model.UpdateDatasetResponse.DatasetArn</property>
781+
<max>256</max>
782+
<pattern>arn:([a-z\d-]+):personalize:.*:.*:.+</pattern>
783+
</property-value-rule>
769784
<property-value-rule>
770785
<property>Amazon.Personalize.Model.UpdateMetricAttributionRequest.MetricAttributionArn</property>
771786
<max>256</max>
@@ -1187,6 +1202,15 @@
11871202
<property>Amazon.Personalize.Model.DatasetSummary.Status</property>
11881203
<max>256</max>
11891204
</property-value-rule>
1205+
<property-value-rule>
1206+
<property>Amazon.Personalize.Model.DatasetUpdateSummary.SchemaArn</property>
1207+
<max>256</max>
1208+
<pattern>arn:([a-z\d-]+):personalize:.*:.*:.+</pattern>
1209+
</property-value-rule>
1210+
<property-value-rule>
1211+
<property>Amazon.Personalize.Model.DatasetUpdateSummary.Status</property>
1212+
<max>256</max>
1213+
</property-value-rule>
11901214
<property-value-rule>
11911215
<property>Amazon.Personalize.Model.DataSource.DataLocation</property>
11921216
<max>256</max>

sdk/src/Services/Personalize/Generated/Model/CreateSolutionRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ internal bool IsSetPerformHPO()
245245
/// <summary>
246246
/// Gets and sets the property RecipeArn.
247247
/// <para>
248-
/// The ARN of the recipe to use for model training. Only specified when <code>performAutoML</code>
248+
/// The ARN of the recipe to use for model training. This is required when <code>performAutoML</code>
249249
/// is false.
250250
/// </para>
251251
/// </summary>

0 commit comments

Comments
 (0)