@aws-sdk/client-personalize 3.56.0 → 3.67.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/CHANGELOG.md +27 -0
- package/README.md +2 -2
- package/dist-cjs/Personalize.js +45 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
- package/dist-cjs/commands/TagResourceCommand.js +36 -0
- package/dist-cjs/commands/UntagResourceCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +72 -4
- package/dist-cjs/protocols/Aws_json1_1.js +315 -2
- package/dist-es/Personalize.js +45 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
- package/dist-es/commands/TagResourceCommand.js +39 -0
- package/dist-es/commands/UntagResourceCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +52 -0
- package/dist-es/protocols/Aws_json1_1.js +403 -47
- package/dist-types/Personalize.d.ts +113 -89
- package/dist-types/PersonalizeClient.d.ts +5 -2
- package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +3 -1
- package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +2 -1
- package/dist-types/commands/CreateCampaignCommand.d.ts +5 -6
- package/dist-types/commands/CreateDatasetCommand.d.ts +8 -6
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +7 -7
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +3 -3
- package/dist-types/commands/CreateEventTrackerCommand.d.ts +4 -4
- package/dist-types/commands/CreateFilterCommand.d.ts +1 -1
- package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -5
- package/dist-types/commands/CreateSchemaCommand.d.ts +4 -4
- package/dist-types/commands/CreateSolutionCommand.d.ts +10 -10
- package/dist-types/commands/CreateSolutionVersionCommand.d.ts +9 -10
- package/dist-types/commands/DeleteCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSolutionCommand.d.ts +2 -2
- package/dist-types/commands/DescribeCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecipeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +2 -1
- package/dist-types/commands/ListCampaignsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/commands/ListEventTrackersCommand.d.ts +1 -1
- package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
- package/dist-types/commands/ListSolutionVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListSolutionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
- package/dist-types/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +199 -34
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/Personalize.d.ts +15 -0
- package/dist-types/ts3.4/PersonalizeClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +97 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
- package/package.json +18 -18
|
@@ -58,11 +58,14 @@ import { ListRecommendersCommandInput, ListRecommendersCommandOutput } from "./c
|
|
|
58
58
|
import { ListSchemasCommandInput, ListSchemasCommandOutput } from "./commands/ListSchemasCommand";
|
|
59
59
|
import { ListSolutionsCommandInput, ListSolutionsCommandOutput } from "./commands/ListSolutionsCommand";
|
|
60
60
|
import { ListSolutionVersionsCommandInput, ListSolutionVersionsCommandOutput } from "./commands/ListSolutionVersionsCommand";
|
|
61
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
61
62
|
import { StopSolutionVersionCreationCommandInput, StopSolutionVersionCreationCommandOutput } from "./commands/StopSolutionVersionCreationCommand";
|
|
63
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
64
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
62
65
|
import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./commands/UpdateCampaignCommand";
|
|
63
66
|
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
64
|
-
export declare type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | StopSolutionVersionCreationCommandInput | UpdateCampaignCommandInput | UpdateRecommenderCommandInput;
|
|
65
|
-
export declare type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | StopSolutionVersionCreationCommandOutput | UpdateCampaignCommandOutput | UpdateRecommenderCommandOutput;
|
|
67
|
+
export declare type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | ListTagsForResourceCommandInput | StopSolutionVersionCreationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCampaignCommandInput | UpdateRecommenderCommandInput;
|
|
68
|
+
export declare type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | ListTagsForResourceCommandOutput | StopSolutionVersionCreationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCampaignCommandOutput | UpdateRecommenderCommandOutput;
|
|
66
69
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
67
70
|
/**
|
|
68
71
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -8,7 +8,9 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a batch inference job. The operation can handle up to 50 million records and the
|
|
11
|
-
* input file must be in JSON format. For more information, see
|
|
11
|
+
* input file must be in JSON format. For more information, see
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html">Creating a batch inference job</a>.
|
|
13
|
+
* </p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -8,7 +8,8 @@ export interface CreateBatchSegmentJobCommandOutput extends CreateBatchSegmentJo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
11
|
-
* input file must be in JSON format. For more information, see
|
|
11
|
+
* input file must be in JSON format. For more information, see
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -47,34 +47,33 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
47
47
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* </ul>
|
|
50
|
-
* <p>To get the campaign status, call <a>DescribeCampaign</a>.</p>
|
|
50
|
+
* <p>To get the campaign status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>.</p>
|
|
51
51
|
* <note>
|
|
52
52
|
* <p>Wait until the <code>status</code> of the campaign
|
|
53
53
|
* is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
|
|
54
54
|
* </note>
|
|
55
|
-
*
|
|
56
55
|
* <p class="title">
|
|
57
56
|
* <b>Related APIs</b>
|
|
58
57
|
* </p>
|
|
59
58
|
* <ul>
|
|
60
59
|
* <li>
|
|
61
60
|
* <p>
|
|
62
|
-
* <a>ListCampaigns</a>
|
|
61
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a>
|
|
63
62
|
* </p>
|
|
64
63
|
* </li>
|
|
65
64
|
* <li>
|
|
66
65
|
* <p>
|
|
67
|
-
* <a>DescribeCampaign</a>
|
|
66
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>
|
|
68
67
|
* </p>
|
|
69
68
|
* </li>
|
|
70
69
|
* <li>
|
|
71
70
|
* <p>
|
|
72
|
-
* <a>UpdateCampaign</a>
|
|
71
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html">UpdateCampaign</a>
|
|
73
72
|
* </p>
|
|
74
73
|
* </li>
|
|
75
74
|
* <li>
|
|
76
75
|
* <p>
|
|
77
|
-
* <a>DeleteCampaign</a>
|
|
76
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html">DeleteCampaign</a>
|
|
78
77
|
* </p>
|
|
79
78
|
* </li>
|
|
80
79
|
* </ul>
|
|
@@ -7,7 +7,9 @@ export interface CreateDatasetCommandInput extends CreateDatasetRequest {
|
|
|
7
7
|
export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an empty dataset and adds it to the specified dataset group. Use
|
|
10
|
+
* <p>Creates an empty dataset and adds it to the specified dataset group. Use
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a dataset.</p>
|
|
12
|
+
*
|
|
11
13
|
* <p>There are three types of datasets:</p>
|
|
12
14
|
* <ul>
|
|
13
15
|
* <li>
|
|
@@ -32,29 +34,29 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
32
34
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
33
35
|
* </li>
|
|
34
36
|
* </ul>
|
|
35
|
-
* <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
|
|
37
|
+
* <p>To get the status of the dataset, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>.</p>
|
|
36
38
|
* <p class="title">
|
|
37
39
|
* <b>Related APIs</b>
|
|
38
40
|
* </p>
|
|
39
41
|
* <ul>
|
|
40
42
|
* <li>
|
|
41
43
|
* <p>
|
|
42
|
-
* <a>CreateDatasetGroup</a>
|
|
44
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
|
|
43
45
|
* </p>
|
|
44
46
|
* </li>
|
|
45
47
|
* <li>
|
|
46
48
|
* <p>
|
|
47
|
-
* <a>ListDatasets</a>
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html">ListDatasets</a>
|
|
48
50
|
* </p>
|
|
49
51
|
* </li>
|
|
50
52
|
* <li>
|
|
51
53
|
* <p>
|
|
52
|
-
* <a>DescribeDataset</a>
|
|
54
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>
|
|
53
55
|
* </p>
|
|
54
56
|
* </li>
|
|
55
57
|
* <li>
|
|
56
58
|
* <p>
|
|
57
|
-
* <a>DeleteDataset</a>
|
|
59
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html">DeleteDataset</a>
|
|
58
60
|
* </p>
|
|
59
61
|
* </li>
|
|
60
62
|
* </ul>
|
|
@@ -24,7 +24,7 @@ export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExport
|
|
|
24
24
|
* </li>
|
|
25
25
|
* </ul>
|
|
26
26
|
* <p>
|
|
27
|
-
* To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
|
|
27
|
+
* To get the status of the export job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html">DescribeDatasetExportJob</a>,
|
|
28
28
|
* and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is
|
|
29
29
|
* complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
30
30
|
* includes a <code>failureReason</code> key, which describes why the job failed.
|
|
@@ -36,7 +36,7 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
36
36
|
* <p>DELETE PENDING</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* </ul>
|
|
39
|
-
* <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
|
|
39
|
+
* <p>To get the status of the dataset group, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>. If
|
|
40
40
|
* the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
|
|
41
41
|
* which describes why the creation failed.</p>
|
|
42
42
|
* <note>
|
|
@@ -52,17 +52,17 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
52
52
|
* <ul>
|
|
53
53
|
* <li>
|
|
54
54
|
* <p>
|
|
55
|
-
* <a>CreateDataset</a>
|
|
55
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
56
56
|
* </p>
|
|
57
57
|
* </li>
|
|
58
58
|
* <li>
|
|
59
59
|
* <p>
|
|
60
|
-
* <a>CreateEventTracker</a>
|
|
60
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>
|
|
61
61
|
* </p>
|
|
62
62
|
* </li>
|
|
63
63
|
* <li>
|
|
64
64
|
* <p>
|
|
65
|
-
* <a>CreateSolution</a>
|
|
65
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
66
66
|
* </p>
|
|
67
67
|
* </li>
|
|
68
68
|
* </ul>
|
|
@@ -72,17 +72,17 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
72
72
|
* <ul>
|
|
73
73
|
* <li>
|
|
74
74
|
* <p>
|
|
75
|
-
* <a>ListDatasetGroups</a>
|
|
75
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a>
|
|
76
76
|
* </p>
|
|
77
77
|
* </li>
|
|
78
78
|
* <li>
|
|
79
79
|
* <p>
|
|
80
|
-
* <a>DescribeDatasetGroup</a>
|
|
80
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
81
81
|
* </p>
|
|
82
82
|
* </li>
|
|
83
83
|
* <li>
|
|
84
84
|
* <p>
|
|
85
|
-
* <a>DeleteDatasetGroup</a>
|
|
85
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html">DeleteDatasetGroup</a>
|
|
86
86
|
* </p>
|
|
87
87
|
* </li>
|
|
88
88
|
* </ul>
|
|
@@ -25,7 +25,7 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
25
25
|
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* </ul>
|
|
28
|
-
* <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
|
|
28
|
+
* <p>To get the status of the import job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>,
|
|
29
29
|
* providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
|
|
30
30
|
* complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
31
31
|
* includes a <code>failureReason</code> key, which describes why the job failed.</p>
|
|
@@ -40,12 +40,12 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
40
40
|
* <ul>
|
|
41
41
|
* <li>
|
|
42
42
|
* <p>
|
|
43
|
-
* <a>ListDatasetImportJobs</a>
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a>
|
|
44
44
|
* </p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
47
|
* <p>
|
|
48
|
-
* <a>DescribeDatasetImportJob</a>
|
|
48
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
|
|
49
49
|
* </p>
|
|
50
50
|
* </li>
|
|
51
51
|
* </ul>
|
|
@@ -29,7 +29,7 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo
|
|
|
29
29
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
30
30
|
* </li>
|
|
31
31
|
* </ul>
|
|
32
|
-
* <p>To get the status of the event tracker, call <a>DescribeEventTracker</a>.</p>
|
|
32
|
+
* <p>To get the status of the event tracker, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>.</p>
|
|
33
33
|
* <note>
|
|
34
34
|
* <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p>
|
|
35
35
|
* </note>
|
|
@@ -39,17 +39,17 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo
|
|
|
39
39
|
* <ul>
|
|
40
40
|
* <li>
|
|
41
41
|
* <p>
|
|
42
|
-
* <a>ListEventTrackers</a>
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html">ListEventTrackers</a>
|
|
43
43
|
* </p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>
|
|
47
|
-
* <a>DescribeEventTracker</a>
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>
|
|
48
48
|
* </p>
|
|
49
49
|
* </li>
|
|
50
50
|
* <li>
|
|
51
51
|
* <p>
|
|
52
|
-
* <a>DeleteEventTracker</a>
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html">DeleteEventTracker</a>
|
|
53
53
|
* </p>
|
|
54
54
|
* </li>
|
|
55
55
|
* </ul>
|
|
@@ -7,7 +7,7 @@ export interface CreateFilterCommandInput extends CreateFilterRequest {
|
|
|
7
7
|
export interface CreateFilterCommandOutput extends CreateFilterResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a recommendation filter. For more information, see <a>
|
|
10
|
+
* <p>Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -50,7 +50,7 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons
|
|
|
50
50
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
51
51
|
* </li>
|
|
52
52
|
* </ul>
|
|
53
|
-
* <p>To get the recommender status, call <a>DescribeRecommender</a>.</p>
|
|
53
|
+
* <p>To get the recommender status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>.</p>
|
|
54
54
|
* <note>
|
|
55
55
|
* <p>Wait until the <code>status</code> of the recommender
|
|
56
56
|
* is <code>ACTIVE</code> before asking the recommender for recommendations.</p>
|
|
@@ -61,22 +61,22 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons
|
|
|
61
61
|
* <ul>
|
|
62
62
|
* <li>
|
|
63
63
|
* <p>
|
|
64
|
-
* <a>ListRecommenders</a>
|
|
64
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html">ListRecommenders</a>
|
|
65
65
|
* </p>
|
|
66
66
|
* </li>
|
|
67
67
|
* <li>
|
|
68
68
|
* <p>
|
|
69
|
-
* <a>DescribeRecommender</a>
|
|
69
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>
|
|
70
70
|
* </p>
|
|
71
71
|
* </li>
|
|
72
72
|
* <li>
|
|
73
73
|
* <p>
|
|
74
|
-
* <a>UpdateRecommender</a>
|
|
74
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html">UpdateRecommender</a>
|
|
75
75
|
* </p>
|
|
76
76
|
* </li>
|
|
77
77
|
* <li>
|
|
78
78
|
* <p>
|
|
79
|
-
* <a>DeleteRecommender</a>
|
|
79
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html">DeleteRecommender</a>
|
|
80
80
|
* </p>
|
|
81
81
|
* </li>
|
|
82
82
|
* </ul>
|
|
@@ -12,7 +12,7 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
|
|
|
12
12
|
* <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
|
|
13
13
|
* type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you
|
|
14
14
|
* provide the domain of the Domain dataset group.
|
|
15
|
-
*
|
|
15
|
+
* You specify a schema when you call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
16
16
|
*
|
|
17
17
|
* <p class="title">
|
|
18
18
|
* <b>Related APIs</b>
|
|
@@ -20,17 +20,17 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
|
|
|
20
20
|
* <ul>
|
|
21
21
|
* <li>
|
|
22
22
|
* <p>
|
|
23
|
-
* <a>ListSchemas</a>
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html">ListSchemas</a>
|
|
24
24
|
* </p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
27
|
* <p>
|
|
28
|
-
* <a>DescribeSchema</a>
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html">DescribeSchema</a>
|
|
29
29
|
* </p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
32
|
* <p>
|
|
33
|
-
* <a>DeleteSchema</a>
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html">DeleteSchema</a>
|
|
34
34
|
* </p>
|
|
35
35
|
* </li>
|
|
36
36
|
* </ul>
|
|
@@ -9,11 +9,11 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates the configuration for training a model. A trained model is known as
|
|
11
11
|
* a solution. After the configuration is created, you train the model (create a solution)
|
|
12
|
-
* by calling the <a>CreateSolutionVersion</a> operation. Every time you call
|
|
12
|
+
* by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. Every time you call
|
|
13
13
|
* <code>CreateSolutionVersion</code>, a new version of the solution is created.</p>
|
|
14
14
|
* <p>After creating a solution version, you check its accuracy by calling
|
|
15
|
-
* <a>GetSolutionMetrics</a>. When you are satisfied with the version, you
|
|
16
|
-
* deploy it using <a>CreateCampaign</a>. The campaign provides recommendations
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the version, you
|
|
16
|
+
* deploy it using <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. The campaign provides recommendations
|
|
17
17
|
* to a client through the
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
|
|
19
19
|
* <p>To train a model, Amazon Personalize requires training data and a recipe. The training data
|
|
@@ -38,7 +38,7 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M
|
|
|
38
38
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* </ul>
|
|
41
|
-
* <p>To get the status of the solution, call <a>DescribeSolution</a>. Wait
|
|
41
|
+
* <p>To get the status of the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>. Wait
|
|
42
42
|
* until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p>
|
|
43
43
|
*
|
|
44
44
|
*
|
|
@@ -49,34 +49,34 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M
|
|
|
49
49
|
* <ul>
|
|
50
50
|
* <li>
|
|
51
51
|
* <p>
|
|
52
|
-
* <a>ListSolutions</a>
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
53
53
|
* </p>
|
|
54
54
|
* </li>
|
|
55
55
|
* <li>
|
|
56
56
|
* <p>
|
|
57
|
-
* <a>CreateSolutionVersion</a>
|
|
57
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a>
|
|
58
58
|
* </p>
|
|
59
59
|
* </li>
|
|
60
60
|
* <li>
|
|
61
61
|
* <p>
|
|
62
|
-
* <a>DescribeSolution</a>
|
|
62
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
63
63
|
* </p>
|
|
64
64
|
* </li>
|
|
65
65
|
* <li>
|
|
66
66
|
* <p>
|
|
67
|
-
* <a>DeleteSolution</a>
|
|
67
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
68
68
|
* </p>
|
|
69
69
|
* </li>
|
|
70
70
|
* </ul>
|
|
71
71
|
* <ul>
|
|
72
72
|
* <li>
|
|
73
73
|
* <p>
|
|
74
|
-
* <a>ListSolutionVersions</a>
|
|
74
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
75
75
|
* </p>
|
|
76
76
|
* </li>
|
|
77
77
|
* <li>
|
|
78
78
|
* <p>
|
|
79
|
-
* <a>DescribeSolutionVersion</a>
|
|
79
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
80
80
|
* </p>
|
|
81
81
|
* </li>
|
|
82
82
|
* </ul>
|
|
@@ -7,7 +7,8 @@ export interface CreateSolutionVersionCommandInput extends CreateSolutionVersion
|
|
|
7
7
|
export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a>CreateSolution</a>
|
|
10
|
+
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
11
|
+
* operation and must be in the ACTIVE state before calling
|
|
11
12
|
* <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
|
|
12
13
|
* call this operation.</p>
|
|
13
14
|
* <p>
|
|
@@ -34,7 +35,7 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
|
|
|
34
35
|
* <p>CREATE STOPPED</p>
|
|
35
36
|
* </li>
|
|
36
37
|
* </ul>
|
|
37
|
-
* <p>To get the status of the version, call <a>DescribeSolutionVersion</a>. Wait
|
|
38
|
+
* <p>To get the status of the version, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. Wait
|
|
38
39
|
* until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p>
|
|
39
40
|
* <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code>
|
|
40
41
|
* key, which describes why the job failed.</p>
|
|
@@ -44,34 +45,32 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
|
|
|
44
45
|
* <ul>
|
|
45
46
|
* <li>
|
|
46
47
|
* <p>
|
|
47
|
-
* <a>ListSolutionVersions</a>
|
|
48
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
48
49
|
* </p>
|
|
49
50
|
* </li>
|
|
50
51
|
* <li>
|
|
51
52
|
* <p>
|
|
52
|
-
* <a>DescribeSolutionVersion</a>
|
|
53
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
53
54
|
* </p>
|
|
54
55
|
* </li>
|
|
55
|
-
* </ul>
|
|
56
|
-
* <ul>
|
|
57
56
|
* <li>
|
|
58
57
|
* <p>
|
|
59
|
-
* <a>ListSolutions</a>
|
|
58
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
60
59
|
* </p>
|
|
61
60
|
* </li>
|
|
62
61
|
* <li>
|
|
63
62
|
* <p>
|
|
64
|
-
* <a>CreateSolution</a>
|
|
63
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
65
64
|
* </p>
|
|
66
65
|
* </li>
|
|
67
66
|
* <li>
|
|
68
67
|
* <p>
|
|
69
|
-
* <a>DescribeSolution</a>
|
|
68
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
70
69
|
* </p>
|
|
71
70
|
* </li>
|
|
72
71
|
* <li>
|
|
73
72
|
* <p>
|
|
74
|
-
* <a>DeleteSolution</a>
|
|
73
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
75
74
|
* </p>
|
|
76
75
|
* </li>
|
|
77
76
|
* </ul>
|
|
@@ -12,7 +12,7 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* longer be specified in a
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
14
14
|
* request.
|
|
15
|
-
* For
|
|
15
|
+
* For information on creating campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
11
11
|
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN
|
|
12
|
-
* PROGRESS state. For more information on datasets, see <a>CreateDataset</a>.</p>
|
|
12
|
+
* PROGRESS state. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes the event tracker. Does not delete the event-interactions dataset from
|
|
11
11
|
* the associated dataset group. For more
|
|
12
|
-
* information on event trackers, see <a>CreateEventTracker</a>.</p>
|
|
12
|
+
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes a schema. Before deleting a schema, you must delete all
|
|
11
11
|
* datasets referencing the schema. For more information on schemas, see
|
|
12
|
-
* <a>CreateSchema</a>.</p>
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -10,10 +10,10 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
|
|
11
11
|
* Before deleting a solution, you must delete all campaigns based on
|
|
12
12
|
* the solution. To determine what campaigns are using the solution, call
|
|
13
|
-
* <a>ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution.
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution.
|
|
14
14
|
* You can't delete a solution if an associated <code>SolutionVersion</code> is in the
|
|
15
15
|
* CREATE PENDING or IN PROGRESS state.
|
|
16
|
-
* For more information on solutions, see <a>CreateSolution</a>.</p>
|
|
16
|
+
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface DescribeCampaignCommandOutput extends DescribeCampaignResponse,
|
|
|
19
19
|
* </ul>
|
|
20
20
|
* <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
|
|
21
21
|
* <code>failureReason</code> key, which describes why.</p>
|
|
22
|
-
* <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
|
|
22
|
+
* <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
|
|
|
7
7
|
export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the given dataset. For more information on datasets, see <a>CreateDataset</a>.</p>
|
|
10
|
+
* <p>Describes the given dataset. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DescribeDatasetExportJobCommandInput extends DescribeDatasetExp
|
|
|
7
7
|
export interface DescribeDatasetExportJobCommandOutput extends DescribeDatasetExportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the dataset export job created by <a>CreateDatasetExportJob</a>,
|
|
10
|
+
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>,
|
|
11
11
|
* including the export job status.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface DescribeDatasetGroupCommandInput extends DescribeDatasetGroupRe
|
|
|
7
7
|
export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the given dataset group. For more information on dataset groups, see <a>CreateDatasetGroup</a>.</p>
|
|
10
|
+
* <p>Describes the given dataset group. For more information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DescribeDatasetImportJobCommandInput extends DescribeDatasetImp
|
|
|
7
7
|
export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetImportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the dataset import job created by <a>CreateDatasetImportJob</a>,
|
|
10
|
+
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>,
|
|
11
11
|
* including the import job status.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DescribeEventTrackerCommandOutput extends DescribeEventTrackerR
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes an event tracker. The response includes the <code>trackingId</code> and
|
|
11
11
|
* <code>status</code> of the event tracker.
|
|
12
|
-
* For more information on event trackers, see <a>CreateEventTracker</a>.</p>
|
|
12
|
+
* For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -21,7 +21,7 @@ export interface DescribeRecipeCommandOutput extends DescribeRecipeResponse, __M
|
|
|
21
21
|
* </li>
|
|
22
22
|
* </ul>
|
|
23
23
|
* <p>Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a
|
|
24
|
-
* solution with the <a>CreateSolution</a> API.
|
|
24
|
+
* solution with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> API.
|
|
25
25
|
* <code>CreateSolution</code> trains a model by using the algorithm
|
|
26
26
|
* in the specified recipe and a training dataset. The solution, when deployed as a campaign,
|
|
27
27
|
* can provide recommendations using the
|
|
@@ -8,7 +8,7 @@ export interface DescribeSchemaCommandOutput extends DescribeSchemaResponse, __M
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes a schema. For more information on schemas, see
|
|
11
|
-
* <a>CreateSchema</a>.</p>
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|