Skip to content

Commit 67abb92

Browse files
author
AWS
committed
Amazon Personalize Update: This releases ability to delete users and their data, including their metadata and interactions data, from a dataset group.
1 parent a3f5713 commit 67abb92

File tree

2 files changed

+229
-2
lines changed

2 files changed

+229
-2
lines changed

‎.changes/next-release/feature-AmazonPersonalize-996c137.json

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": "This releases ability to delete users and their data, including their metadata and interactions data, from a dataset group."
6+
}

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

Lines changed: 223 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"endpointPrefix":"personalize",
66
"jsonVersion":"1.1",
77
"protocol":"json",
8+
"protocols":["json"],
89
"serviceFullName":"Amazon Personalize",
910
"serviceId":"Personalize",
1011
"signatureVersion":"v4",
@@ -68,6 +69,24 @@
6869
"documentation":"<important> <p> You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see <a href=\"https://aws.amazon.com/personalize/pricing/\">Amazon Personalize pricing</a>.</p> </important> <p>Creates a campaign that deploys a solution version. When a client calls the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html\">GetRecommendations</a> and <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html\">GetPersonalizedRanking</a> APIs, a campaign is specified in the request.</p> <p> <b>Minimum Provisioned TPS and Auto-Scaling</b> </p> <important> <p> A high <code>minProvisionedTPS</code> will increase your cost. We recommend starting with 1 for <code>minProvisionedTPS</code> (the default). Track your usage using Amazon CloudWatch metrics, and increase the <code>minProvisionedTPS</code> as necessary.</p> </important> <p> When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (<code>minProvisionedTPS</code>) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single <code>GetRecommendations</code> or <code>GetPersonalizedRanking</code> request. The default <code>minProvisionedTPS</code> is 1.</p> <p> If your TPS increases beyond the <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down, but never below <code>minProvisionedTPS</code>. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the <code>minProvisionedTPS</code>. </p> <p>You are charged for the the minimum provisioned TPS or, if your requests exceed the <code>minProvisionedTPS</code>, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low <code>minProvisionedTPS</code>, track your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code> as necessary.</p> <p>For more information about campaign costs, see <a href=\"https://aws.amazon.com/personalize/pricing/\">Amazon Personalize pricing</a>.</p> <p> <b>Status</b> </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> <p>To get the campaign status, call <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a>.</p> <note> <p>Wait until the <code>status</code> of the campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html\">ListCampaigns</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html\">UpdateCampaign</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html\">DeleteCampaign</a> </p> </li> </ul>",
6970
"idempotent":true
7071
},
72+
"CreateDataDeletionJob":{
73+
"name":"CreateDataDeletionJob",
74+
"http":{
75+
"method":"POST",
76+
"requestUri":"/"
77+
},
78+
"input":{"shape":"CreateDataDeletionJobRequest"},
79+
"output":{"shape":"CreateDataDeletionJobResponse"},
80+
"errors":[
81+
{"shape":"InvalidInputException"},
82+
{"shape":"ResourceNotFoundException"},
83+
{"shape":"ResourceAlreadyExistsException"},
84+
{"shape":"LimitExceededException"},
85+
{"shape":"ResourceInUseException"},
86+
{"shape":"TooManyTagsException"}
87+
],
88+
"documentation":"<p>Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html\">Deleting users</a>.</p> <ul> <li> <p>Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html\">Preparing your data deletion file and uploading it to Amazon S3</a>.</p> </li> <li> <p>To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs <code>GetObject</code> and <code>ListBucket</code> permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html\">Giving Amazon Personalize Access to Amazon S3 Resources</a>. </p> </li> </ul> <p> After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments. </p> <p> <b>Status</b> </p> <p>A data deletion job can have one of the following statuses:</p> <ul> <li> <p>PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED</p> </li> </ul> <p>To get the status of the data deletion job, call <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html\">DescribeDataDeletionJob</a> API operation and specify the Amazon Resource Name (ARN) of the job. If the status is 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 href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html\">ListDataDeletionJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html\">DescribeDataDeletionJob</a> </p> </li> </ul>"
89+
},
7190
"CreateDataset":{
7291
"name":"CreateDataset",
7392
"http":{
@@ -458,6 +477,21 @@
458477
"documentation":"<p>Describes the given campaign, including its status.</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> <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the <code>failureReason</code> key, which describes why.</p> <p>For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
459478
"idempotent":true
460479
},
480+
"DescribeDataDeletionJob":{
481+
"name":"DescribeDataDeletionJob",
482+
"http":{
483+
"method":"POST",
484+
"requestUri":"/"
485+
},
486+
"input":{"shape":"DescribeDataDeletionJobRequest"},
487+
"output":{"shape":"DescribeDataDeletionJobResponse"},
488+
"errors":[
489+
{"shape":"InvalidInputException"},
490+
{"shape":"ResourceNotFoundException"}
491+
],
492+
"documentation":"<p>Describes the data deletion job created by <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html\">CreateDataDeletionJob</a>, including the job status.</p>",
493+
"idempotent":true
494+
},
461495
"DescribeDataset":{
462496
"name":"DescribeDataset",
463497
"http":{
@@ -712,6 +746,21 @@
712746
"documentation":"<p>Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
713747
"idempotent":true
714748
},
749+
"ListDataDeletionJobs":{
750+
"name":"ListDataDeletionJobs",
751+
"http":{
752+
"method":"POST",
753+
"requestUri":"/"
754+
},
755+
"input":{"shape":"ListDataDeletionJobsRequest"},
756+
"output":{"shape":"ListDataDeletionJobsResponse"},
757+
"errors":[
758+
{"shape":"InvalidInputException"},
759+
{"shape":"InvalidNextTokenException"}
760+
],
761+
"documentation":"<p>Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html\">Deleting users</a>.</p>",
762+
"idempotent":true
763+
},
715764
"ListDatasetExportJobs":{
716765
"name":"ListDatasetExportJobs",
717766
"http":{
@@ -1789,6 +1838,46 @@
17891838
}
17901839
}
17911840
},
1841+
"CreateDataDeletionJobRequest":{
1842+
"type":"structure",
1843+
"required":[
1844+
"jobName",
1845+
"datasetGroupArn",
1846+
"dataSource",
1847+
"roleArn"
1848+
],
1849+
"members":{
1850+
"jobName":{
1851+
"shape":"Name",
1852+
"documentation":"<p>The name for the data deletion job.</p>"
1853+
},
1854+
"datasetGroupArn":{
1855+
"shape":"Arn",
1856+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.</p>"
1857+
},
1858+
"dataSource":{
1859+
"shape":"DataSource",
1860+
"documentation":"<p>The Amazon S3 bucket that contains the list of userIds of the users to delete.</p>"
1861+
},
1862+
"roleArn":{
1863+
"shape":"RoleArn",
1864+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.</p>"
1865+
},
1866+
"tags":{
1867+
"shape":"Tags",
1868+
"documentation":"<p>A list of <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html\">tags</a> to apply to the data deletion job.</p>"
1869+
}
1870+
}
1871+
},
1872+
"CreateDataDeletionJobResponse":{
1873+
"type":"structure",
1874+
"members":{
1875+
"dataDeletionJobArn":{
1876+
"shape":"Arn",
1877+
"documentation":"<p>The Amazon Resource Name (ARN) of the data deletion job.</p>"
1878+
}
1879+
}
1880+
},
17921881
"CreateDatasetExportJobRequest":{
17931882
"type":"structure",
17941883
"required":[
@@ -2219,15 +2308,97 @@
22192308
}
22202309
}
22212310
},
2311+
"DataDeletionJob":{
2312+
"type":"structure",
2313+
"members":{
2314+
"jobName":{
2315+
"shape":"Name",
2316+
"documentation":"<p>The name of the data deletion job.</p>"
2317+
},
2318+
"dataDeletionJobArn":{
2319+
"shape":"Arn",
2320+
"documentation":"<p>The Amazon Resource Name (ARN) of the data deletion job.</p>"
2321+
},
2322+
"datasetGroupArn":{
2323+
"shape":"Arn",
2324+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group the job deletes records from.</p>"
2325+
},
2326+
"dataSource":{"shape":"DataSource"},
2327+
"roleArn":{
2328+
"shape":"RoleArn",
2329+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.</p>"
2330+
},
2331+
"status":{
2332+
"shape":"Status",
2333+
"documentation":"<p>The status of the data deletion job.</p> <p>A data deletion job can have one of the following statuses:</p> <ul> <li> <p>PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED</p> </li> </ul>"
2334+
},
2335+
"numDeleted":{
2336+
"shape":"Integer",
2337+
"documentation":"<p>The number of records deleted by a COMPLETED job.</p>"
2338+
},
2339+
"creationDateTime":{
2340+
"shape":"Date",
2341+
"documentation":"<p>The creation date and time (in Unix time) of the data deletion job.</p>"
2342+
},
2343+
"lastUpdatedDateTime":{
2344+
"shape":"Date",
2345+
"documentation":"<p>The date and time (in Unix time) the data deletion job was last updated.</p>"
2346+
},
2347+
"failureReason":{
2348+
"shape":"FailureReason",
2349+
"documentation":"<p>If a data deletion job fails, provides the reason why.</p>"
2350+
}
2351+
},
2352+
"documentation":"<p>Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html\">Deleting users</a>.</p>"
2353+
},
2354+
"DataDeletionJobSummary":{
2355+
"type":"structure",
2356+
"members":{
2357+
"dataDeletionJobArn":{
2358+
"shape":"Arn",
2359+
"documentation":"<p>The Amazon Resource Name (ARN) of the data deletion job.</p>"
2360+
},
2361+
"datasetGroupArn":{
2362+
"shape":"Arn",
2363+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group the job deleted records from.</p>"
2364+
},
2365+
"jobName":{
2366+
"shape":"Name",
2367+
"documentation":"<p>The name of the data deletion job.</p>"
2368+
},
2369+
"status":{
2370+
"shape":"Status",
2371+
"documentation":"<p>The status of the data deletion job.</p> <p>A data deletion job can have one of the following statuses:</p> <ul> <li> <p>PENDING &gt; IN_PROGRESS &gt; COMPLETED -or- FAILED</p> </li> </ul>"
2372+
},
2373+
"creationDateTime":{
2374+
"shape":"Date",
2375+
"documentation":"<p>The creation date and time (in Unix time) of the data deletion job.</p>"
2376+
},
2377+
"lastUpdatedDateTime":{
2378+
"shape":"Date",
2379+
"documentation":"<p>The date and time (in Unix time) the data deletion job was last updated.</p>"
2380+
},
2381+
"failureReason":{
2382+
"shape":"FailureReason",
2383+
"documentation":"<p>If a data deletion job fails, provides the reason why.</p>"
2384+
}
2385+
},
2386+
"documentation":"<p>Provides a summary of the properties of a data deletion job. For a complete listing, call the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html\">DescribeDataDeletionJob</a> API operation.</p>"
2387+
},
2388+
"DataDeletionJobs":{
2389+
"type":"list",
2390+
"member":{"shape":"DataDeletionJobSummary"},
2391+
"max":100
2392+
},
22222393
"DataSource":{
22232394
"type":"structure",
22242395
"members":{
22252396
"dataLocation":{
22262397
"shape":"S3Location",
2227-
"documentation":"<p>The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: </p> <p> <code>s3://bucket-name/folder-name/</code> </p>"
2398+
"documentation":"<p>For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. </p> <p> For example: </p> <p> <code>s3://bucket-name/folder-name/fileName.csv</code> </p> <p>If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a <code>/</code> after the folder name:</p> <p> <code>s3://bucket-name/folder-name/</code> </p>"
22282399
}
22292400
},
2230-
"documentation":"<p>Describes the data source that contains the data to upload to a dataset.</p>"
2401+
"documentation":"<p>Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.</p>"
22312402
},
22322403
"Dataset":{
22332404
"type":"structure",
@@ -2917,6 +3088,25 @@
29173088
}
29183089
}
29193090
},
3091+
"DescribeDataDeletionJobRequest":{
3092+
"type":"structure",
3093+
"required":["dataDeletionJobArn"],
3094+
"members":{
3095+
"dataDeletionJobArn":{
3096+
"shape":"Arn",
3097+
"documentation":"<p>The Amazon Resource Name (ARN) of the data deletion job.</p>"
3098+
}
3099+
}
3100+
},
3101+
"DescribeDataDeletionJobResponse":{
3102+
"type":"structure",
3103+
"members":{
3104+
"dataDeletionJob":{
3105+
"shape":"DataDeletionJob",
3106+
"documentation":"<p>Information about the data deletion job, including the status.</p> <p>The status is one of the following values:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>IN_PROGRESS</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>FAILED</p> </li> </ul>"
3107+
}
3108+
}
3109+
},
29203110
"DescribeDatasetExportJobRequest":{
29213111
"type":"structure",
29223112
"required":["datasetExportJobArn"],
@@ -3517,6 +3707,7 @@
35173707
"ALL"
35183708
]
35193709
},
3710+
"Integer":{"type":"integer"},
35203711
"IntegerHyperParameterRange":{
35213712
"type":"structure",
35223713
"members":{
@@ -3672,6 +3863,36 @@
36723863
}
36733864
}
36743865
},
3866+
"ListDataDeletionJobsRequest":{
3867+
"type":"structure",
3868+
"members":{
3869+
"datasetGroupArn":{
3870+
"shape":"Arn",
3871+
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.</p>"
3872+
},
3873+
"nextToken":{
3874+
"shape":"NextToken",
3875+
"documentation":"<p>A token returned from the previous call to <code>ListDataDeletionJobs</code> for getting the next set of jobs (if they exist).</p>"
3876+
},
3877+
"maxResults":{
3878+
"shape":"MaxResults",
3879+
"documentation":"<p>The maximum number of data deletion jobs to return.</p>"
3880+
}
3881+
}
3882+
},
3883+
"ListDataDeletionJobsResponse":{
3884+
"type":"structure",
3885+
"members":{
3886+
"dataDeletionJobs":{
3887+
"shape":"DataDeletionJobs",
3888+
"documentation":"<p>The list of data deletion jobs.</p>"
3889+
},
3890+
"nextToken":{
3891+
"shape":"NextToken",
3892+
"documentation":"<p>A token for getting the next set of data deletion jobs (if they exist).</p>"
3893+
}
3894+
}
3895+
},
36753896
"ListDatasetExportJobsRequest":{
36763897
"type":"structure",
36773898
"members":{

0 commit comments

Comments
 (0)