@aws-sdk/client-personalize 3.58.0 → 3.72.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.
Files changed (71) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +2 -2
  3. package/dist-cjs/Personalize.js +45 -0
  4. package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
  5. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  6. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  7. package/dist-cjs/commands/index.js +3 -0
  8. package/dist-cjs/models/models_0.js +72 -4
  9. package/dist-cjs/protocols/Aws_json1_1.js +315 -2
  10. package/dist-es/Personalize.js +45 -0
  11. package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
  12. package/dist-es/commands/TagResourceCommand.js +39 -0
  13. package/dist-es/commands/UntagResourceCommand.js +39 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/models/models_0.js +52 -0
  16. package/dist-es/protocols/Aws_json1_1.js +403 -47
  17. package/dist-types/Personalize.d.ts +113 -89
  18. package/dist-types/PersonalizeClient.d.ts +5 -2
  19. package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +3 -1
  20. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +2 -1
  21. package/dist-types/commands/CreateCampaignCommand.d.ts +5 -6
  22. package/dist-types/commands/CreateDatasetCommand.d.ts +8 -6
  23. package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +1 -1
  24. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +7 -7
  25. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +3 -3
  26. package/dist-types/commands/CreateEventTrackerCommand.d.ts +4 -4
  27. package/dist-types/commands/CreateFilterCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -5
  29. package/dist-types/commands/CreateSchemaCommand.d.ts +4 -4
  30. package/dist-types/commands/CreateSolutionCommand.d.ts +10 -10
  31. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +9 -10
  32. package/dist-types/commands/DeleteCampaignCommand.d.ts +1 -1
  33. package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
  34. package/dist-types/commands/DeleteEventTrackerCommand.d.ts +1 -1
  35. package/dist-types/commands/DeleteSchemaCommand.d.ts +1 -1
  36. package/dist-types/commands/DeleteSolutionCommand.d.ts +2 -2
  37. package/dist-types/commands/DescribeCampaignCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -1
  40. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
  41. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
  42. package/dist-types/commands/DescribeEventTrackerCommand.d.ts +1 -1
  43. package/dist-types/commands/DescribeRecipeCommand.d.ts +1 -1
  44. package/dist-types/commands/DescribeSchemaCommand.d.ts +1 -1
  45. package/dist-types/commands/DescribeSolutionCommand.d.ts +1 -1
  46. package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +2 -1
  47. package/dist-types/commands/ListCampaignsCommand.d.ts +1 -1
  48. package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +2 -2
  49. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
  50. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +2 -2
  51. package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
  52. package/dist-types/commands/ListEventTrackersCommand.d.ts +1 -1
  53. package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
  54. package/dist-types/commands/ListSolutionVersionsCommand.d.ts +1 -2
  55. package/dist-types/commands/ListSolutionsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
  57. package/dist-types/commands/TagResourceCommand.d.ts +35 -0
  58. package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
  59. package/dist-types/commands/UpdateCampaignCommand.d.ts +2 -2
  60. package/dist-types/commands/index.d.ts +3 -0
  61. package/dist-types/models/models_0.d.ts +199 -34
  62. package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
  63. package/dist-types/ts3.4/Personalize.d.ts +15 -0
  64. package/dist-types/ts3.4/PersonalizeClient.d.ts +5 -2
  65. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  66. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  67. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  69. package/dist-types/ts3.4/models/models_0.d.ts +97 -0
  70. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
  71. package/package.json +6 -6
@@ -8,7 +8,7 @@ export interface DescribeSolutionCommandOutput extends DescribeSolutionResponse,
8
8
  }
9
9
  /**
10
10
  * <p>Describes a solution.
11
- * For more information on solutions, see <a>CreateSolution</a>.</p>
11
+ * For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</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
@@ -7,7 +7,8 @@ export interface DescribeSolutionVersionCommandInput extends DescribeSolutionVer
7
7
  export interface DescribeSolutionVersionCommandOutput extends DescribeSolutionVersionResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes a specific version of a solution. For more information on solutions, see <a>CreateSolution</a>.</p>
10
+ * <p>Describes a specific version of a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
11
+ * </p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -10,7 +10,7 @@ export interface ListCampaignsCommandOutput extends ListCampaignsResponse, __Met
10
10
  * <p>Returns a list of campaigns that use the given solution.
11
11
  * When a solution is not specified, all the campaigns associated with the account are listed.
12
12
  * The response provides the properties for each campaign, including the Amazon Resource Name (ARN).
13
- * For more information on campaigns, see <a>CreateCampaign</a>.</p>
13
+ * For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -10,8 +10,8 @@ export interface ListDatasetExportJobsCommandOutput extends ListDatasetExportJob
10
10
  * <p>Returns a list of dataset export jobs that use the given dataset. When a dataset is not
11
11
  * specified, all the dataset export jobs associated with the account are listed. The response
12
12
  * provides the properties for each dataset export job, including the Amazon Resource Name (ARN).
13
- * For more information on dataset export jobs, see <a>CreateDatasetExportJob</a>. For
14
- * more information on datasets, see <a>CreateDataset</a>.</p>
13
+ * For more information on dataset export jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>. For
14
+ * more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
9
9
  /**
10
10
  * <p>Returns a list of dataset groups. The response provides the properties for each dataset
11
11
  * group, including the Amazon Resource Name (ARN). For more information on dataset groups, see
12
- * <a>CreateDatasetGroup</a>.</p>
12
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</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,8 +10,8 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
10
10
  * <p>Returns a list of dataset import jobs that use the given dataset. When a dataset is not
11
11
  * specified, all the dataset import jobs associated with the account are listed. The response
12
12
  * provides the properties for each dataset import job, including the Amazon Resource Name (ARN).
13
- * For more information on dataset import jobs, see <a>CreateDatasetImportJob</a>. For
14
- * more information on datasets, see <a>CreateDataset</a>.</p>
13
+ * For more information on dataset import jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>. For
14
+ * more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
9
9
  /**
10
10
  * <p>Returns the list of datasets contained in the given dataset group. The response provides
11
11
  * the properties for each dataset, including the Amazon Resource Name (ARN). For more
12
- * information on datasets, see <a>CreateDataset</a>.</p>
12
+ * 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
@@ -10,7 +10,7 @@ export interface ListEventTrackersCommandOutput extends ListEventTrackersRespons
10
10
  * <p>Returns the list of event trackers associated with the account.
11
11
  * The response provides the properties for each event tracker, including the Amazon Resource
12
12
  * Name (ARN) and tracking ID. For more
13
- * information on event trackers, see <a>CreateEventTracker</a>.</p>
13
+ * information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
9
9
  /**
10
10
  * <p>Returns the list of schemas associated with the account. The response provides the
11
11
  * properties for each schema, including the Amazon Resource Name (ARN).
12
- * For more information on schemas, see <a>CreateSchema</a>.</p>
12
+ * For more information on schemas, see <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
@@ -9,8 +9,7 @@ export interface ListSolutionVersionsCommandOutput extends ListSolutionVersionsR
9
9
  /**
10
10
  * <p>Returns a list of solution versions for the given solution. When a solution is not
11
11
  * specified, all the solution versions associated with the account are listed. The response
12
- * provides the properties for each solution version, including the Amazon Resource Name (ARN).
13
- * For more information on solutions, see <a>CreateSolution</a>.</p>
12
+ * provides the properties for each solution version, including the Amazon Resource Name (ARN).</p>
14
13
  * @example
15
14
  * Use a bare-bones client and the command you need to make an API call.
16
15
  * ```javascript
@@ -10,7 +10,7 @@ export interface ListSolutionsCommandOutput extends ListSolutionsResponse, __Met
10
10
  * <p>Returns a list of solutions that use the given dataset group.
11
11
  * When a dataset group is not specified, all the solutions associated with the account are listed.
12
12
  * The response provides the properties for each solution, including the Amazon Resource Name (ARN).
13
- * For more information on solutions, see <a>CreateSolution</a>.</p>
13
+ * For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
4
+ import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
5
+ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
6
+ }
7
+ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Get a list of <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> attached to a resource.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { PersonalizeClient, ListTagsForResourceCommand } from "@aws-sdk/client-personalize"; // ES Modules import
15
+ * // const { PersonalizeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
16
+ * const client = new PersonalizeClient(config);
17
+ * const command = new ListTagsForResourceCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
22
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
23
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PersonalizeClientResolvedConfig> {
27
+ readonly input: ListTagsForResourceCommandInput;
28
+ constructor(input: ListTagsForResourceCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
4
+ import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
5
+ export interface TagResourceCommandInput extends TagResourceRequest {
6
+ }
7
+ export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Add a list of tags to a resource.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { PersonalizeClient, TagResourceCommand } from "@aws-sdk/client-personalize"; // ES Modules import
15
+ * // const { PersonalizeClient, TagResourceCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
16
+ * const client = new PersonalizeClient(config);
17
+ * const command = new TagResourceCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
22
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
23
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, PersonalizeClientResolvedConfig> {
27
+ readonly input: TagResourceCommandInput;
28
+ constructor(input: TagResourceCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
4
+ import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
5
+ export interface UntagResourceCommandInput extends UntagResourceRequest {
6
+ }
7
+ export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Remove <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> that are attached to a resource.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { PersonalizeClient, UntagResourceCommand } from "@aws-sdk/client-personalize"; // ES Modules import
15
+ * // const { PersonalizeClient, UntagResourceCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
16
+ * const client = new PersonalizeClient(config);
17
+ * const command = new UntagResourceCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
22
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
23
+ * @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, PersonalizeClientResolvedConfig> {
27
+ readonly input: UntagResourceCommandInput;
28
+ constructor(input: UntagResourceCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -10,12 +10,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
10
10
  * <p>Updates a campaign by either deploying a new solution or changing the value of the
11
11
  * campaign's <code>minProvisionedTPS</code> parameter.</p>
12
12
  * <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
13
- * Check the campaign status using the <a>DescribeCampaign</a> API.</p>
13
+ * Check the campaign status using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> operation.</p>
14
14
  * <note>
15
15
  * <p>You must wait until the <code>status</code> of the
16
16
  * updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
17
17
  * </note>
18
- * <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
18
+ * <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
19
19
  * @example
20
20
  * Use a bare-bones client and the command you need to make an API call.
21
21
  * ```javascript
@@ -50,6 +50,9 @@ export * from "./ListRecommendersCommand";
50
50
  export * from "./ListSchemasCommand";
51
51
  export * from "./ListSolutionVersionsCommand";
52
52
  export * from "./ListSolutionsCommand";
53
+ export * from "./ListTagsForResourceCommand";
53
54
  export * from "./StopSolutionVersionCreationCommand";
55
+ export * from "./TagResourceCommand";
56
+ export * from "./UntagResourceCommand";
54
57
  export * from "./UpdateCampaignCommand";
55
58
  export * from "./UpdateRecommenderCommand";