@aws-sdk/client-personalize 3.567.0 → 3.569.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist-cjs/index.js +159 -0
- package/dist-es/Personalize.js +6 -0
- package/dist-es/commands/CreateDataDeletionJobCommand.js +24 -0
- package/dist-es/commands/DescribeDataDeletionJobCommand.js +24 -0
- package/dist-es/commands/ListDataDeletionJobsCommand.js +24 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +101 -0
- package/dist-types/Personalize.d.ts +22 -0
- package/dist-types/PersonalizeClient.d.ts +5 -2
- package/dist-types/commands/CreateDataDeletionJobCommand.d.ts +138 -0
- package/dist-types/commands/DescribeDataDeletionJobCommand.d.ts +78 -0
- package/dist-types/commands/ListDataDeletionJobsCommand.d.ts +84 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +255 -16
- package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
- package/dist-types/ts3.4/Personalize.d.ts +52 -0
- package/dist-types/ts3.4/PersonalizeClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/CreateDataDeletionJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DescribeDataDeletionJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListDataDeletionJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +49 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +7 -5
|
@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
|
2
2
|
import { CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput } from "./commands/CreateBatchInferenceJobCommand";
|
|
3
3
|
import { CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput } from "./commands/CreateBatchSegmentJobCommand";
|
|
4
4
|
import { CreateCampaignCommandInput, CreateCampaignCommandOutput } from "./commands/CreateCampaignCommand";
|
|
5
|
+
import { CreateDataDeletionJobCommandInput, CreateDataDeletionJobCommandOutput } from "./commands/CreateDataDeletionJobCommand";
|
|
5
6
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
6
7
|
import { CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput } from "./commands/CreateDatasetExportJobCommand";
|
|
7
8
|
import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
|
|
@@ -26,6 +27,7 @@ import { DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput } from ".
|
|
|
26
27
|
import { DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput } from "./commands/DescribeBatchInferenceJobCommand";
|
|
27
28
|
import { DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput } from "./commands/DescribeBatchSegmentJobCommand";
|
|
28
29
|
import { DescribeCampaignCommandInput, DescribeCampaignCommandOutput } from "./commands/DescribeCampaignCommand";
|
|
30
|
+
import { DescribeDataDeletionJobCommandInput, DescribeDataDeletionJobCommandOutput } from "./commands/DescribeDataDeletionJobCommand";
|
|
29
31
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
30
32
|
import { DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput } from "./commands/DescribeDatasetExportJobCommand";
|
|
31
33
|
import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
|
|
@@ -43,6 +45,7 @@ import { GetSolutionMetricsCommandInput, GetSolutionMetricsCommandOutput } from
|
|
|
43
45
|
import { ListBatchInferenceJobsCommandInput, ListBatchInferenceJobsCommandOutput } from "./commands/ListBatchInferenceJobsCommand";
|
|
44
46
|
import { ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput } from "./commands/ListBatchSegmentJobsCommand";
|
|
45
47
|
import { ListCampaignsCommandInput, ListCampaignsCommandOutput } from "./commands/ListCampaignsCommand";
|
|
48
|
+
import { ListDataDeletionJobsCommandInput, ListDataDeletionJobsCommandOutput } from "./commands/ListDataDeletionJobsCommand";
|
|
46
49
|
import { ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput } from "./commands/ListDatasetExportJobsCommand";
|
|
47
50
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
48
51
|
import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
|
|
@@ -86,6 +89,12 @@ export interface Personalize {
|
|
|
86
89
|
createCampaign(args: CreateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<CreateCampaignCommandOutput>;
|
|
87
90
|
createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
88
91
|
createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
92
|
+
/**
|
|
93
|
+
* @see {@link CreateDataDeletionJobCommand}
|
|
94
|
+
*/
|
|
95
|
+
createDataDeletionJob(args: CreateDataDeletionJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataDeletionJobCommandOutput>;
|
|
96
|
+
createDataDeletionJob(args: CreateDataDeletionJobCommandInput, cb: (err: any, data?: CreateDataDeletionJobCommandOutput) => void): void;
|
|
97
|
+
createDataDeletionJob(args: CreateDataDeletionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataDeletionJobCommandOutput) => void): void;
|
|
89
98
|
/**
|
|
90
99
|
* @see {@link CreateDatasetCommand}
|
|
91
100
|
*/
|
|
@@ -230,6 +239,12 @@ export interface Personalize {
|
|
|
230
239
|
describeCampaign(args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCampaignCommandOutput>;
|
|
231
240
|
describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
232
241
|
describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
242
|
+
/**
|
|
243
|
+
* @see {@link DescribeDataDeletionJobCommand}
|
|
244
|
+
*/
|
|
245
|
+
describeDataDeletionJob(args: DescribeDataDeletionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataDeletionJobCommandOutput>;
|
|
246
|
+
describeDataDeletionJob(args: DescribeDataDeletionJobCommandInput, cb: (err: any, data?: DescribeDataDeletionJobCommandOutput) => void): void;
|
|
247
|
+
describeDataDeletionJob(args: DescribeDataDeletionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataDeletionJobCommandOutput) => void): void;
|
|
233
248
|
/**
|
|
234
249
|
* @see {@link DescribeDatasetCommand}
|
|
235
250
|
*/
|
|
@@ -335,6 +350,13 @@ export interface Personalize {
|
|
|
335
350
|
listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
|
|
336
351
|
listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
337
352
|
listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
353
|
+
/**
|
|
354
|
+
* @see {@link ListDataDeletionJobsCommand}
|
|
355
|
+
*/
|
|
356
|
+
listDataDeletionJobs(): Promise<ListDataDeletionJobsCommandOutput>;
|
|
357
|
+
listDataDeletionJobs(args: ListDataDeletionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataDeletionJobsCommandOutput>;
|
|
358
|
+
listDataDeletionJobs(args: ListDataDeletionJobsCommandInput, cb: (err: any, data?: ListDataDeletionJobsCommandOutput) => void): void;
|
|
359
|
+
listDataDeletionJobs(args: ListDataDeletionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataDeletionJobsCommandOutput) => void): void;
|
|
338
360
|
/**
|
|
339
361
|
* @see {@link ListDatasetExportJobsCommand}
|
|
340
362
|
*/
|
|
@@ -10,6 +10,7 @@ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/
|
|
|
10
10
|
import { CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput } from "./commands/CreateBatchInferenceJobCommand";
|
|
11
11
|
import { CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput } from "./commands/CreateBatchSegmentJobCommand";
|
|
12
12
|
import { CreateCampaignCommandInput, CreateCampaignCommandOutput } from "./commands/CreateCampaignCommand";
|
|
13
|
+
import { CreateDataDeletionJobCommandInput, CreateDataDeletionJobCommandOutput } from "./commands/CreateDataDeletionJobCommand";
|
|
13
14
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
14
15
|
import { CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput } from "./commands/CreateDatasetExportJobCommand";
|
|
15
16
|
import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
|
|
@@ -34,6 +35,7 @@ import { DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput } from ".
|
|
|
34
35
|
import { DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput } from "./commands/DescribeBatchInferenceJobCommand";
|
|
35
36
|
import { DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput } from "./commands/DescribeBatchSegmentJobCommand";
|
|
36
37
|
import { DescribeCampaignCommandInput, DescribeCampaignCommandOutput } from "./commands/DescribeCampaignCommand";
|
|
38
|
+
import { DescribeDataDeletionJobCommandInput, DescribeDataDeletionJobCommandOutput } from "./commands/DescribeDataDeletionJobCommand";
|
|
37
39
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
38
40
|
import { DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput } from "./commands/DescribeDatasetExportJobCommand";
|
|
39
41
|
import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
|
|
@@ -51,6 +53,7 @@ import { GetSolutionMetricsCommandInput, GetSolutionMetricsCommandOutput } from
|
|
|
51
53
|
import { ListBatchInferenceJobsCommandInput, ListBatchInferenceJobsCommandOutput } from "./commands/ListBatchInferenceJobsCommand";
|
|
52
54
|
import { ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput } from "./commands/ListBatchSegmentJobsCommand";
|
|
53
55
|
import { ListCampaignsCommandInput, ListCampaignsCommandOutput } from "./commands/ListCampaignsCommand";
|
|
56
|
+
import { ListDataDeletionJobsCommandInput, ListDataDeletionJobsCommandOutput } from "./commands/ListDataDeletionJobsCommand";
|
|
54
57
|
import { ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput } from "./commands/ListDatasetExportJobsCommand";
|
|
55
58
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
56
59
|
import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
|
|
@@ -80,11 +83,11 @@ export { __Client };
|
|
|
80
83
|
/**
|
|
81
84
|
* @public
|
|
82
85
|
*/
|
|
83
|
-
export type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateMetricAttributionCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteMetricAttributionCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeMetricAttributionCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListMetricAttributionMetricsCommandInput | ListMetricAttributionsCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | ListTagsForResourceCommandInput | StartRecommenderCommandInput | StopRecommenderCommandInput | StopSolutionVersionCreationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCampaignCommandInput | UpdateDatasetCommandInput | UpdateMetricAttributionCommandInput | UpdateRecommenderCommandInput;
|
|
86
|
+
export type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDataDeletionJobCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateMetricAttributionCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteMetricAttributionCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDataDeletionJobCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeMetricAttributionCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDataDeletionJobsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListMetricAttributionMetricsCommandInput | ListMetricAttributionsCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | ListTagsForResourceCommandInput | StartRecommenderCommandInput | StopRecommenderCommandInput | StopSolutionVersionCreationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCampaignCommandInput | UpdateDatasetCommandInput | UpdateMetricAttributionCommandInput | UpdateRecommenderCommandInput;
|
|
84
87
|
/**
|
|
85
88
|
* @public
|
|
86
89
|
*/
|
|
87
|
-
export type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateMetricAttributionCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteMetricAttributionCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeMetricAttributionCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListMetricAttributionMetricsCommandOutput | ListMetricAttributionsCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | ListTagsForResourceCommandOutput | StartRecommenderCommandOutput | StopRecommenderCommandOutput | StopSolutionVersionCreationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCampaignCommandOutput | UpdateDatasetCommandOutput | UpdateMetricAttributionCommandOutput | UpdateRecommenderCommandOutput;
|
|
90
|
+
export type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDataDeletionJobCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateMetricAttributionCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteMetricAttributionCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDataDeletionJobCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeMetricAttributionCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDataDeletionJobsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListMetricAttributionMetricsCommandOutput | ListMetricAttributionsCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | ListTagsForResourceCommandOutput | StartRecommenderCommandOutput | StopRecommenderCommandOutput | StopSolutionVersionCreationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCampaignCommandOutput | UpdateDatasetCommandOutput | UpdateMetricAttributionCommandOutput | UpdateRecommenderCommandOutput;
|
|
88
91
|
/**
|
|
89
92
|
* @public
|
|
90
93
|
*/
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateDataDeletionJobRequest, CreateDataDeletionJobResponse } from "../models/models_0";
|
|
4
|
+
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateDataDeletionJobCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateDataDeletionJobCommandInput extends CreateDataDeletionJobRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateDataDeletionJobCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateDataDeletionJobCommandOutput extends CreateDataDeletionJobResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateDataDeletionJobCommand_base: {
|
|
24
|
+
new (input: CreateDataDeletionJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataDeletionJobCommandInput, CreateDataDeletionJobCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateDataDeletionJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataDeletionJobCommandInput, CreateDataDeletionJobCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Creates a batch job that deletes all
|
|
30
|
+
* 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
|
|
31
|
+
* an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains
|
|
32
|
+
* on the users’ data and no longer considers the users when generating user segments.
|
|
33
|
+
* 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>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information
|
|
37
|
+
* 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>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <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
|
|
41
|
+
* read from the data source. This role
|
|
42
|
+
* needs <code>GetObject</code> and <code>ListBucket</code> permissions for the bucket and its content.
|
|
43
|
+
* These permissions are the same as importing data. For information on granting access to your Amazon S3
|
|
44
|
+
* bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving
|
|
45
|
+
* Amazon Personalize Access to Amazon S3 Resources</a>. </p>
|
|
46
|
+
* </li>
|
|
47
|
+
* </ul>
|
|
48
|
+
* <p>
|
|
49
|
+
* 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,
|
|
50
|
+
* Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.
|
|
51
|
+
* </p>
|
|
52
|
+
* <p>
|
|
53
|
+
* <b>Status</b>
|
|
54
|
+
* </p>
|
|
55
|
+
* <p>A data deletion job can have one of the following statuses:</p>
|
|
56
|
+
* <ul>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>PENDING > IN_PROGRESS > COMPLETED -or- FAILED</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
61
|
+
* <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
|
|
62
|
+
* (ARN) of the job. If the status is FAILED, the response
|
|
63
|
+
* includes a <code>failureReason</code> key, which describes why the job
|
|
64
|
+
* failed.</p>
|
|
65
|
+
* <p class="title">
|
|
66
|
+
* <b>Related APIs</b>
|
|
67
|
+
* </p>
|
|
68
|
+
* <ul>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>
|
|
71
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html">ListDataDeletionJobs</a>
|
|
72
|
+
* </p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>
|
|
76
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html">DescribeDataDeletionJob</a>
|
|
77
|
+
* </p>
|
|
78
|
+
* </li>
|
|
79
|
+
* </ul>
|
|
80
|
+
* @example
|
|
81
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
82
|
+
* ```javascript
|
|
83
|
+
* import { PersonalizeClient, CreateDataDeletionJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
|
|
84
|
+
* // const { PersonalizeClient, CreateDataDeletionJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
|
|
85
|
+
* const client = new PersonalizeClient(config);
|
|
86
|
+
* const input = { // CreateDataDeletionJobRequest
|
|
87
|
+
* jobName: "STRING_VALUE", // required
|
|
88
|
+
* datasetGroupArn: "STRING_VALUE", // required
|
|
89
|
+
* dataSource: { // DataSource
|
|
90
|
+
* dataLocation: "STRING_VALUE",
|
|
91
|
+
* },
|
|
92
|
+
* roleArn: "STRING_VALUE", // required
|
|
93
|
+
* tags: [ // Tags
|
|
94
|
+
* { // Tag
|
|
95
|
+
* tagKey: "STRING_VALUE", // required
|
|
96
|
+
* tagValue: "STRING_VALUE", // required
|
|
97
|
+
* },
|
|
98
|
+
* ],
|
|
99
|
+
* };
|
|
100
|
+
* const command = new CreateDataDeletionJobCommand(input);
|
|
101
|
+
* const response = await client.send(command);
|
|
102
|
+
* // { // CreateDataDeletionJobResponse
|
|
103
|
+
* // dataDeletionJobArn: "STRING_VALUE",
|
|
104
|
+
* // };
|
|
105
|
+
*
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
108
|
+
* @param CreateDataDeletionJobCommandInput - {@link CreateDataDeletionJobCommandInput}
|
|
109
|
+
* @returns {@link CreateDataDeletionJobCommandOutput}
|
|
110
|
+
* @see {@link CreateDataDeletionJobCommandInput} for command's `input` shape.
|
|
111
|
+
* @see {@link CreateDataDeletionJobCommandOutput} for command's `response` shape.
|
|
112
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
115
|
+
* <p>Provide a valid value for the field or parameter.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
118
|
+
* <p>The limit on the number of requests per second has been exceeded.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link ResourceAlreadyExistsException} (client fault)
|
|
121
|
+
* <p>The specified resource already exists.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
124
|
+
* <p>The specified resource is in use.</p>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
127
|
+
* <p>Could not find the specified resource.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link TooManyTagsException} (client fault)
|
|
130
|
+
* <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link PersonalizeServiceException}
|
|
133
|
+
* <p>Base exception class for all service exceptions from Personalize service.</p>
|
|
134
|
+
*
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export declare class CreateDataDeletionJobCommand extends CreateDataDeletionJobCommand_base {
|
|
138
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DescribeDataDeletionJobRequest, DescribeDataDeletionJobResponse } from "../models/models_0";
|
|
4
|
+
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DescribeDataDeletionJobCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DescribeDataDeletionJobCommandInput extends DescribeDataDeletionJobRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DescribeDataDeletionJobCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DescribeDataDeletionJobCommandOutput extends DescribeDataDeletionJobResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DescribeDataDeletionJobCommand_base: {
|
|
24
|
+
new (input: DescribeDataDeletionJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeDataDeletionJobCommandInput, DescribeDataDeletionJobCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DescribeDataDeletionJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeDataDeletionJobCommandInput, DescribeDataDeletionJobCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <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>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { PersonalizeClient, DescribeDataDeletionJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
|
|
34
|
+
* // const { PersonalizeClient, DescribeDataDeletionJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
|
|
35
|
+
* const client = new PersonalizeClient(config);
|
|
36
|
+
* const input = { // DescribeDataDeletionJobRequest
|
|
37
|
+
* dataDeletionJobArn: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DescribeDataDeletionJobCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeDataDeletionJobResponse
|
|
42
|
+
* // dataDeletionJob: { // DataDeletionJob
|
|
43
|
+
* // jobName: "STRING_VALUE",
|
|
44
|
+
* // dataDeletionJobArn: "STRING_VALUE",
|
|
45
|
+
* // datasetGroupArn: "STRING_VALUE",
|
|
46
|
+
* // dataSource: { // DataSource
|
|
47
|
+
* // dataLocation: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // roleArn: "STRING_VALUE",
|
|
50
|
+
* // status: "STRING_VALUE",
|
|
51
|
+
* // numDeleted: Number("int"),
|
|
52
|
+
* // creationDateTime: new Date("TIMESTAMP"),
|
|
53
|
+
* // lastUpdatedDateTime: new Date("TIMESTAMP"),
|
|
54
|
+
* // failureReason: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param DescribeDataDeletionJobCommandInput - {@link DescribeDataDeletionJobCommandInput}
|
|
61
|
+
* @returns {@link DescribeDataDeletionJobCommandOutput}
|
|
62
|
+
* @see {@link DescribeDataDeletionJobCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link DescribeDataDeletionJobCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
67
|
+
* <p>Provide a valid value for the field or parameter.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>Could not find the specified resource.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link PersonalizeServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Personalize service.</p>
|
|
74
|
+
*
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export declare class DescribeDataDeletionJobCommand extends DescribeDataDeletionJobCommand_base {
|
|
78
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListDataDeletionJobsRequest, ListDataDeletionJobsResponse } from "../models/models_0";
|
|
4
|
+
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link ListDataDeletionJobsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListDataDeletionJobsCommandInput extends ListDataDeletionJobsRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ListDataDeletionJobsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ListDataDeletionJobsCommandOutput extends ListDataDeletionJobsResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ListDataDeletionJobsCommand_base: {
|
|
24
|
+
new (input: ListDataDeletionJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDataDeletionJobsCommandInput, ListDataDeletionJobsCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [ListDataDeletionJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListDataDeletionJobsCommandInput, ListDataDeletionJobsCommandOutput, PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Returns a list of data deletion jobs for a dataset group ordered by creation time,
|
|
30
|
+
* with the most recent first.
|
|
31
|
+
* When
|
|
32
|
+
* a dataset group is not specified, all the data deletion jobs associated with
|
|
33
|
+
* the account are listed. The response provides the properties for each
|
|
34
|
+
* job, including the Amazon Resource Name (ARN). For more
|
|
35
|
+
* information on data deletion jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html">Deleting users</a>.</p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { PersonalizeClient, ListDataDeletionJobsCommand } from "@aws-sdk/client-personalize"; // ES Modules import
|
|
40
|
+
* // const { PersonalizeClient, ListDataDeletionJobsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
|
|
41
|
+
* const client = new PersonalizeClient(config);
|
|
42
|
+
* const input = { // ListDataDeletionJobsRequest
|
|
43
|
+
* datasetGroupArn: "STRING_VALUE",
|
|
44
|
+
* nextToken: "STRING_VALUE",
|
|
45
|
+
* maxResults: Number("int"),
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListDataDeletionJobsCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ListDataDeletionJobsResponse
|
|
50
|
+
* // dataDeletionJobs: [ // DataDeletionJobs
|
|
51
|
+
* // { // DataDeletionJobSummary
|
|
52
|
+
* // dataDeletionJobArn: "STRING_VALUE",
|
|
53
|
+
* // datasetGroupArn: "STRING_VALUE",
|
|
54
|
+
* // jobName: "STRING_VALUE",
|
|
55
|
+
* // status: "STRING_VALUE",
|
|
56
|
+
* // creationDateTime: new Date("TIMESTAMP"),
|
|
57
|
+
* // lastUpdatedDateTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // failureReason: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // nextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param ListDataDeletionJobsCommandInput - {@link ListDataDeletionJobsCommandInput}
|
|
67
|
+
* @returns {@link ListDataDeletionJobsCommandOutput}
|
|
68
|
+
* @see {@link ListDataDeletionJobsCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link ListDataDeletionJobsCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
73
|
+
* <p>Provide a valid value for the field or parameter.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
76
|
+
* <p>The token is not valid.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link PersonalizeServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Personalize service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class ListDataDeletionJobsCommand extends ListDataDeletionJobsCommand_base {
|
|
84
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./CreateBatchInferenceJobCommand";
|
|
2
2
|
export * from "./CreateBatchSegmentJobCommand";
|
|
3
3
|
export * from "./CreateCampaignCommand";
|
|
4
|
+
export * from "./CreateDataDeletionJobCommand";
|
|
4
5
|
export * from "./CreateDatasetCommand";
|
|
5
6
|
export * from "./CreateDatasetExportJobCommand";
|
|
6
7
|
export * from "./CreateDatasetGroupCommand";
|
|
@@ -25,6 +26,7 @@ export * from "./DescribeAlgorithmCommand";
|
|
|
25
26
|
export * from "./DescribeBatchInferenceJobCommand";
|
|
26
27
|
export * from "./DescribeBatchSegmentJobCommand";
|
|
27
28
|
export * from "./DescribeCampaignCommand";
|
|
29
|
+
export * from "./DescribeDataDeletionJobCommand";
|
|
28
30
|
export * from "./DescribeDatasetCommand";
|
|
29
31
|
export * from "./DescribeDatasetExportJobCommand";
|
|
30
32
|
export * from "./DescribeDatasetGroupCommand";
|
|
@@ -42,6 +44,7 @@ export * from "./GetSolutionMetricsCommand";
|
|
|
42
44
|
export * from "./ListBatchInferenceJobsCommand";
|
|
43
45
|
export * from "./ListBatchSegmentJobsCommand";
|
|
44
46
|
export * from "./ListCampaignsCommand";
|
|
47
|
+
export * from "./ListDataDeletionJobsCommand";
|
|
45
48
|
export * from "./ListDatasetExportJobsCommand";
|
|
46
49
|
export * from "./ListDatasetGroupsCommand";
|
|
47
50
|
export * from "./ListDatasetImportJobsCommand";
|