@aws-sdk/client-personalize 3.36.0 → 3.39.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 (137) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Personalize.js +0 -4
  3. package/dist-cjs/PersonalizeClient.js +0 -9
  4. package/dist-cjs/commands/CreateBatchInferenceJobCommand.js +0 -25
  5. package/dist-cjs/commands/CreateCampaignCommand.js +0 -94
  6. package/dist-cjs/commands/CreateDatasetCommand.js +0 -74
  7. package/dist-cjs/commands/CreateDatasetExportJobCommand.js +0 -45
  8. package/dist-cjs/commands/CreateDatasetGroupCommand.js +0 -99
  9. package/dist-cjs/commands/CreateDatasetImportJobCommand.js +0 -65
  10. package/dist-cjs/commands/CreateEventTrackerCommand.js +0 -69
  11. package/dist-cjs/commands/CreateFilterCommand.js +0 -24
  12. package/dist-cjs/commands/CreateSchemaCommand.js +0 -49
  13. package/dist-cjs/commands/CreateSolutionCommand.js +0 -96
  14. package/dist-cjs/commands/CreateSolutionVersionCommand.js +0 -91
  15. package/dist-cjs/commands/DeleteCampaignCommand.js +0 -29
  16. package/dist-cjs/commands/DeleteDatasetCommand.js +0 -26
  17. package/dist-cjs/commands/DeleteDatasetGroupCommand.js +0 -36
  18. package/dist-cjs/commands/DeleteEventTrackerCommand.js +0 -26
  19. package/dist-cjs/commands/DeleteFilterCommand.js +0 -24
  20. package/dist-cjs/commands/DeleteSchemaCommand.js +0 -26
  21. package/dist-cjs/commands/DeleteSolutionCommand.js +0 -30
  22. package/dist-cjs/commands/DescribeAlgorithmCommand.js +0 -24
  23. package/dist-cjs/commands/DescribeBatchInferenceJobCommand.js +0 -26
  24. package/dist-cjs/commands/DescribeCampaignCommand.js +0 -36
  25. package/dist-cjs/commands/DescribeDatasetCommand.js +0 -24
  26. package/dist-cjs/commands/DescribeDatasetExportJobCommand.js +0 -25
  27. package/dist-cjs/commands/DescribeDatasetGroupCommand.js +0 -24
  28. package/dist-cjs/commands/DescribeDatasetImportJobCommand.js +0 -25
  29. package/dist-cjs/commands/DescribeEventTrackerCommand.js +0 -26
  30. package/dist-cjs/commands/DescribeFeatureTransformationCommand.js +0 -24
  31. package/dist-cjs/commands/DescribeFilterCommand.js +0 -24
  32. package/dist-cjs/commands/DescribeRecipeCommand.js +0 -42
  33. package/dist-cjs/commands/DescribeSchemaCommand.js +0 -25
  34. package/dist-cjs/commands/DescribeSolutionCommand.js +0 -25
  35. package/dist-cjs/commands/DescribeSolutionVersionCommand.js +0 -24
  36. package/dist-cjs/commands/GetSolutionMetricsCommand.js +0 -24
  37. package/dist-cjs/commands/ListBatchInferenceJobsCommand.js +0 -25
  38. package/dist-cjs/commands/ListCampaignsCommand.js +0 -27
  39. package/dist-cjs/commands/ListDatasetExportJobsCommand.js +0 -28
  40. package/dist-cjs/commands/ListDatasetGroupsCommand.js +0 -26
  41. package/dist-cjs/commands/ListDatasetImportJobsCommand.js +0 -28
  42. package/dist-cjs/commands/ListDatasetsCommand.js +0 -26
  43. package/dist-cjs/commands/ListEventTrackersCommand.js +0 -27
  44. package/dist-cjs/commands/ListFiltersCommand.js +0 -24
  45. package/dist-cjs/commands/ListRecipesCommand.js +0 -25
  46. package/dist-cjs/commands/ListSchemasCommand.js +0 -26
  47. package/dist-cjs/commands/ListSolutionVersionsCommand.js +0 -27
  48. package/dist-cjs/commands/ListSolutionsCommand.js +0 -27
  49. package/dist-cjs/commands/StopSolutionVersionCreationCommand.js +0 -37
  50. package/dist-cjs/commands/UpdateCampaignCommand.js +0 -32
  51. package/dist-cjs/commands/index.js +50 -0
  52. package/dist-cjs/endpoints.js +6 -1
  53. package/dist-cjs/index.js +4 -62
  54. package/dist-cjs/models/models_0.js +0 -429
  55. package/dist-cjs/pagination/ListBatchInferenceJobsPaginator.js +0 -10
  56. package/dist-cjs/pagination/ListCampaignsPaginator.js +0 -10
  57. package/dist-cjs/pagination/ListDatasetExportJobsPaginator.js +0 -10
  58. package/dist-cjs/pagination/ListDatasetGroupsPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListDatasetImportJobsPaginator.js +0 -10
  60. package/dist-cjs/pagination/ListDatasetsPaginator.js +0 -10
  61. package/dist-cjs/pagination/ListEventTrackersPaginator.js +0 -10
  62. package/dist-cjs/pagination/ListFiltersPaginator.js +0 -10
  63. package/dist-cjs/pagination/ListRecipesPaginator.js +0 -10
  64. package/dist-cjs/pagination/ListSchemasPaginator.js +0 -10
  65. package/dist-cjs/pagination/ListSolutionVersionsPaginator.js +0 -10
  66. package/dist-cjs/pagination/ListSolutionsPaginator.js +0 -10
  67. package/dist-cjs/pagination/index.js +16 -0
  68. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  69. package/dist-cjs/runtimeConfig.browser.js +1 -5
  70. package/dist-cjs/runtimeConfig.js +1 -5
  71. package/dist-cjs/runtimeConfig.native.js +0 -3
  72. package/dist-cjs/runtimeConfig.shared.js +0 -3
  73. package/dist-es/commands/index.js +47 -0
  74. package/dist-es/endpoints.js +6 -1
  75. package/dist-es/index.js +4 -62
  76. package/dist-es/pagination/index.js +13 -0
  77. package/dist-types/commands/index.d.ts +47 -0
  78. package/dist-types/index.d.ts +4 -62
  79. package/dist-types/pagination/index.d.ts +13 -0
  80. package/dist-types/ts3.4/Personalize.d.ts +48 -728
  81. package/dist-types/ts3.4/PersonalizeClient.d.ts +24 -90
  82. package/dist-types/ts3.4/commands/CreateBatchInferenceJobCommand.d.ts +2 -21
  83. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +2 -90
  84. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +2 -70
  85. package/dist-types/ts3.4/commands/CreateDatasetExportJobCommand.d.ts +2 -41
  86. package/dist-types/ts3.4/commands/CreateDatasetGroupCommand.d.ts +2 -95
  87. package/dist-types/ts3.4/commands/CreateDatasetImportJobCommand.d.ts +2 -61
  88. package/dist-types/ts3.4/commands/CreateEventTrackerCommand.d.ts +2 -65
  89. package/dist-types/ts3.4/commands/CreateFilterCommand.d.ts +2 -20
  90. package/dist-types/ts3.4/commands/CreateSchemaCommand.d.ts +2 -45
  91. package/dist-types/ts3.4/commands/CreateSolutionCommand.d.ts +2 -92
  92. package/dist-types/ts3.4/commands/CreateSolutionVersionCommand.d.ts +2 -87
  93. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +2 -25
  94. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +2 -22
  95. package/dist-types/ts3.4/commands/DeleteDatasetGroupCommand.d.ts +2 -32
  96. package/dist-types/ts3.4/commands/DeleteEventTrackerCommand.d.ts +2 -22
  97. package/dist-types/ts3.4/commands/DeleteFilterCommand.d.ts +2 -20
  98. package/dist-types/ts3.4/commands/DeleteSchemaCommand.d.ts +2 -22
  99. package/dist-types/ts3.4/commands/DeleteSolutionCommand.d.ts +2 -26
  100. package/dist-types/ts3.4/commands/DescribeAlgorithmCommand.d.ts +2 -20
  101. package/dist-types/ts3.4/commands/DescribeBatchInferenceJobCommand.d.ts +2 -22
  102. package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +2 -32
  103. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/DescribeDatasetExportJobCommand.d.ts +2 -21
  105. package/dist-types/ts3.4/commands/DescribeDatasetGroupCommand.d.ts +2 -20
  106. package/dist-types/ts3.4/commands/DescribeDatasetImportJobCommand.d.ts +2 -21
  107. package/dist-types/ts3.4/commands/DescribeEventTrackerCommand.d.ts +2 -22
  108. package/dist-types/ts3.4/commands/DescribeFeatureTransformationCommand.d.ts +2 -20
  109. package/dist-types/ts3.4/commands/DescribeFilterCommand.d.ts +2 -20
  110. package/dist-types/ts3.4/commands/DescribeRecipeCommand.d.ts +2 -38
  111. package/dist-types/ts3.4/commands/DescribeSchemaCommand.d.ts +2 -21
  112. package/dist-types/ts3.4/commands/DescribeSolutionCommand.d.ts +2 -21
  113. package/dist-types/ts3.4/commands/DescribeSolutionVersionCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/GetSolutionMetricsCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/ListBatchInferenceJobsCommand.d.ts +2 -21
  116. package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +2 -23
  117. package/dist-types/ts3.4/commands/ListDatasetExportJobsCommand.d.ts +2 -24
  118. package/dist-types/ts3.4/commands/ListDatasetGroupsCommand.d.ts +2 -22
  119. package/dist-types/ts3.4/commands/ListDatasetImportJobsCommand.d.ts +2 -24
  120. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +2 -22
  121. package/dist-types/ts3.4/commands/ListEventTrackersCommand.d.ts +2 -23
  122. package/dist-types/ts3.4/commands/ListFiltersCommand.d.ts +2 -20
  123. package/dist-types/ts3.4/commands/ListRecipesCommand.d.ts +2 -21
  124. package/dist-types/ts3.4/commands/ListSchemasCommand.d.ts +2 -22
  125. package/dist-types/ts3.4/commands/ListSolutionVersionsCommand.d.ts +2 -23
  126. package/dist-types/ts3.4/commands/ListSolutionsCommand.d.ts +2 -23
  127. package/dist-types/ts3.4/commands/StopSolutionVersionCreationCommand.d.ts +2 -33
  128. package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +2 -28
  129. package/dist-types/ts3.4/commands/index.d.ts +47 -0
  130. package/dist-types/ts3.4/index.d.ts +4 -62
  131. package/dist-types/ts3.4/models/models_0.d.ts +620 -2318
  132. package/dist-types/ts3.4/pagination/index.d.ts +13 -0
  133. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  134. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  135. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  136. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  137. package/package.json +32 -32
package/CHANGELOG.md CHANGED
@@ -3,6 +3,48 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.39.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.38.0...v3.39.0) (2021-10-29)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-personalize
9
+
10
+
11
+
12
+
13
+
14
+ # [3.38.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.37.0...v3.38.0) (2021-10-22)
15
+
16
+
17
+ ### Features
18
+
19
+ * **client-documentation-generator:** rename package ([#2916](https://github.com/aws/aws-sdk-js-v3/issues/2916)) ([1a80bfd](https://github.com/aws/aws-sdk-js-v3/commit/1a80bfd2dfc583001ddb4a21b6432eaaad699aa7))
20
+ * **clients:** export folder from index.ts ([#2912](https://github.com/aws/aws-sdk-js-v3/issues/2912)) ([183b46d](https://github.com/aws/aws-sdk-js-v3/commit/183b46dde7f5613128038bf1c076f3c0b693203b))
21
+
22
+
23
+
24
+
25
+
26
+ # [3.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
27
+
28
+
29
+ ### Features
30
+
31
+ * **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
32
+
33
+
34
+
35
+
36
+
37
+ ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
38
+
39
+
40
+ ### Bug Fixes
41
+
42
+ * **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
43
+
44
+
45
+
46
+
47
+
6
48
  # [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
7
49
 
8
50
 
@@ -49,10 +49,6 @@ const ListSolutionVersionsCommand_1 = require("./commands/ListSolutionVersionsCo
49
49
  const StopSolutionVersionCreationCommand_1 = require("./commands/StopSolutionVersionCreationCommand");
50
50
  const UpdateCampaignCommand_1 = require("./commands/UpdateCampaignCommand");
51
51
  const PersonalizeClient_1 = require("./PersonalizeClient");
52
- /**
53
- * <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
54
- * recommendations to customers.</p>
55
- */
56
52
  class Personalize extends PersonalizeClient_1.PersonalizeClient {
57
53
  createBatchInferenceJob(args, optionsOrCb, cb) {
58
54
  const command = new CreateBatchInferenceJobCommand_1.CreateBatchInferenceJobCommand(args);
@@ -10,10 +10,6 @@ const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
10
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
11
11
  const smithy_client_1 = require("@aws-sdk/smithy-client");
12
12
  const runtimeConfig_1 = require("./runtimeConfig");
13
- /**
14
- * <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
15
- * recommendations to customers.</p>
16
- */
17
13
  class PersonalizeClient extends smithy_client_1.Client {
18
14
  constructor(configuration) {
19
15
  const _config_0 = runtimeConfig_1.getRuntimeConfig(configuration);
@@ -32,11 +28,6 @@ class PersonalizeClient extends smithy_client_1.Client {
32
28
  this.middlewareStack.use(middleware_signing_1.getAwsAuthPlugin(this.config));
33
29
  this.middlewareStack.use(middleware_user_agent_1.getUserAgentPlugin(this.config));
34
30
  }
35
- /**
36
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
37
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
38
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
39
- */
40
31
  destroy() {
41
32
  super.destroy();
42
33
  }
@@ -5,36 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates a batch inference job. The operation can handle up to 50 million records and the
10
- * input file must be in JSON format. For more information, see <a>recommendations-batch</a>.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { PersonalizeClient, CreateBatchInferenceJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
15
- * // const { PersonalizeClient, CreateBatchInferenceJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
16
- * const client = new PersonalizeClient(config);
17
- * const command = new CreateBatchInferenceJobCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link CreateBatchInferenceJobCommandInput} for command's `input` shape.
22
- * @see {@link CreateBatchInferenceJobCommandOutput} for command's `response` shape.
23
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class CreateBatchInferenceJobCommand extends smithy_client_1.Command {
27
- // Start section: command_properties
28
- // End section: command_properties
29
9
  constructor(input) {
30
- // Start section: command_constructor
31
10
  super();
32
11
  this.input = input;
33
- // End section: command_constructor
34
12
  }
35
- /**
36
- * @internal
37
- */
38
13
  resolveMiddleware(clientStack, configuration, options) {
39
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
40
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,105 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates a campaign by deploying a solution version. When a client calls the
10
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
11
- * and
12
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
13
- * APIs, a campaign is specified in the request.</p>
14
- *
15
- * <p>
16
- * <b>Minimum Provisioned TPS and Auto-Scaling</b>
17
- * </p>
18
- *
19
- * <p>A transaction is a single <code>GetRecommendations</code> or
20
- * <code>GetPersonalizedRanking</code> call. Transactions per second (TPS) is the throughput
21
- * and unit of billing for Amazon Personalize. The minimum provisioned TPS
22
- * (<code>minProvisionedTPS</code>) specifies the baseline throughput provisioned by
23
- * Amazon Personalize, and thus, the minimum billing charge.
24
- * </p>
25
- * <p>
26
- * If your TPS increases beyond
27
- * <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down,
28
- * but never below <code>minProvisionedTPS</code>.
29
- * There's a short time delay while the capacity is increased that might cause loss of
30
- * transactions.</p>
31
- * <p>The actual TPS used is calculated as the average requests/second within a 5-minute window.
32
- * You pay for maximum of either the minimum provisioned TPS or the actual TPS.
33
- * We recommend starting with a low <code>minProvisionedTPS</code>, track
34
- * your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code>
35
- * as necessary.</p>
36
- *
37
- * <p>
38
- * <b>Status</b>
39
- * </p>
40
- * <p>A campaign can be in one of the following states:</p>
41
- * <ul>
42
- * <li>
43
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
44
- * </li>
45
- * <li>
46
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
47
- * </li>
48
- * </ul>
49
- * <p>To get the campaign status, call <a>DescribeCampaign</a>.</p>
50
- * <note>
51
- * <p>Wait until the <code>status</code> of the campaign
52
- * is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
53
- * </note>
54
- *
55
- * <p class="title">
56
- * <b>Related APIs</b>
57
- * </p>
58
- * <ul>
59
- * <li>
60
- * <p>
61
- * <a>ListCampaigns</a>
62
- * </p>
63
- * </li>
64
- * <li>
65
- * <p>
66
- * <a>DescribeCampaign</a>
67
- * </p>
68
- * </li>
69
- * <li>
70
- * <p>
71
- * <a>UpdateCampaign</a>
72
- * </p>
73
- * </li>
74
- * <li>
75
- * <p>
76
- * <a>DeleteCampaign</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, CreateCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import
84
- * // const { PersonalizeClient, CreateCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
85
- * const client = new PersonalizeClient(config);
86
- * const command = new CreateCampaignCommand(input);
87
- * const response = await client.send(command);
88
- * ```
89
- *
90
- * @see {@link CreateCampaignCommandInput} for command's `input` shape.
91
- * @see {@link CreateCampaignCommandOutput} for command's `response` shape.
92
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
93
- *
94
- */
95
8
  class CreateCampaignCommand extends smithy_client_1.Command {
96
- // Start section: command_properties
97
- // End section: command_properties
98
9
  constructor(input) {
99
- // Start section: command_constructor
100
10
  super();
101
11
  this.input = input;
102
- // End section: command_constructor
103
12
  }
104
- /**
105
- * @internal
106
- */
107
13
  resolveMiddleware(clientStack, configuration, options) {
108
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
109
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,85 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates an empty dataset and adds it to the specified dataset group. Use <a>CreateDatasetImportJob</a> to import your training data to a dataset.</p>
10
- * <p>There are three types of datasets:</p>
11
- * <ul>
12
- * <li>
13
- * <p>Interactions</p>
14
- * </li>
15
- * <li>
16
- * <p>Items</p>
17
- * </li>
18
- * <li>
19
- * <p>Users</p>
20
- * </li>
21
- * </ul>
22
- * <p>Each dataset type has an associated schema with required field types. Only the
23
- * <code>Interactions</code> dataset is required in order to train a model (also referred to as
24
- * creating a solution).</p>
25
- * <p>A dataset can be in one of the following states:</p>
26
- * <ul>
27
- * <li>
28
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
29
- * </li>
30
- * <li>
31
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
32
- * </li>
33
- * </ul>
34
- * <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
35
- * <p class="title">
36
- * <b>Related APIs</b>
37
- * </p>
38
- * <ul>
39
- * <li>
40
- * <p>
41
- * <a>CreateDatasetGroup</a>
42
- * </p>
43
- * </li>
44
- * <li>
45
- * <p>
46
- * <a>ListDatasets</a>
47
- * </p>
48
- * </li>
49
- * <li>
50
- * <p>
51
- * <a>DescribeDataset</a>
52
- * </p>
53
- * </li>
54
- * <li>
55
- * <p>
56
- * <a>DeleteDataset</a>
57
- * </p>
58
- * </li>
59
- * </ul>
60
- * @example
61
- * Use a bare-bones client and the command you need to make an API call.
62
- * ```javascript
63
- * import { PersonalizeClient, CreateDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import
64
- * // const { PersonalizeClient, CreateDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
65
- * const client = new PersonalizeClient(config);
66
- * const command = new CreateDatasetCommand(input);
67
- * const response = await client.send(command);
68
- * ```
69
- *
70
- * @see {@link CreateDatasetCommandInput} for command's `input` shape.
71
- * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
72
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
73
- *
74
- */
75
8
  class CreateDatasetCommand extends smithy_client_1.Command {
76
- // Start section: command_properties
77
- // End section: command_properties
78
9
  constructor(input) {
79
- // Start section: command_constructor
80
10
  super();
81
11
  this.input = input;
82
- // End section: command_constructor
83
12
  }
84
- /**
85
- * @internal
86
- */
87
13
  resolveMiddleware(clientStack, configuration, options) {
88
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
89
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,56 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>
10
- * Creates a job that exports data from your dataset to an Amazon S3 bucket.
11
- * To allow Amazon Personalize to export the training data, you must specify an
12
- * service-linked IAM role that gives Amazon Personalize <code>PutObject</code> permissions for your Amazon S3 bucket.
13
- * For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
14
- * in the Amazon Personalize developer guide.
15
- * </p>
16
- * <p>
17
- * <b>Status</b>
18
- * </p>
19
- * <p>A dataset export job can be in one of the following states:</p>
20
- * <ul>
21
- * <li>
22
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
23
- * </li>
24
- * </ul>
25
- * <p>
26
- * To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
27
- * and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is
28
- * complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
29
- * includes a <code>failureReason</code> key, which describes why the job failed.
30
- * </p>
31
- * @example
32
- * Use a bare-bones client and the command you need to make an API call.
33
- * ```javascript
34
- * import { PersonalizeClient, CreateDatasetExportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
35
- * // const { PersonalizeClient, CreateDatasetExportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
36
- * const client = new PersonalizeClient(config);
37
- * const command = new CreateDatasetExportJobCommand(input);
38
- * const response = await client.send(command);
39
- * ```
40
- *
41
- * @see {@link CreateDatasetExportJobCommandInput} for command's `input` shape.
42
- * @see {@link CreateDatasetExportJobCommandOutput} for command's `response` shape.
43
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
44
- *
45
- */
46
8
  class CreateDatasetExportJobCommand extends smithy_client_1.Command {
47
- // Start section: command_properties
48
- // End section: command_properties
49
9
  constructor(input) {
50
- // Start section: command_constructor
51
10
  super();
52
11
  this.input = input;
53
- // End section: command_constructor
54
12
  }
55
- /**
56
- * @internal
57
- */
58
13
  resolveMiddleware(clientStack, configuration, options) {
59
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
60
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,110 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates an empty dataset group. A dataset group contains related datasets that supply data
10
- * for training a model. A dataset group can contain at most three datasets, one for each type of
11
- * dataset:</p>
12
- * <ul>
13
- * <li>
14
- * <p>Interactions</p>
15
- * </li>
16
- * <li>
17
- * <p>Items</p>
18
- * </li>
19
- * <li>
20
- * <p>Users</p>
21
- * </li>
22
- * </ul>
23
- * <p>To train a model (create a solution), a dataset group that contains an
24
- * <code>Interactions</code> dataset is required. Call <a>CreateDataset</a> to add a
25
- * dataset to the group.</p>
26
- * <p>A dataset group can be in one of the following states:</p>
27
- * <ul>
28
- * <li>
29
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
30
- * </li>
31
- * <li>
32
- * <p>DELETE PENDING</p>
33
- * </li>
34
- * </ul>
35
- * <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
36
- * the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
37
- * which describes why the creation failed.</p>
38
- * <note>
39
- * <p>You must wait until the <code>status</code> of the dataset group is <code>ACTIVE</code>
40
- * before adding a dataset to the group.</p>
41
- * </note>
42
- * <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you
43
- * specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to
44
- * access the key.</p>
45
- * <p class="title">
46
- * <b>APIs that require a dataset group ARN in the request</b>
47
- * </p>
48
- * <ul>
49
- * <li>
50
- * <p>
51
- * <a>CreateDataset</a>
52
- * </p>
53
- * </li>
54
- * <li>
55
- * <p>
56
- * <a>CreateEventTracker</a>
57
- * </p>
58
- * </li>
59
- * <li>
60
- * <p>
61
- * <a>CreateSolution</a>
62
- * </p>
63
- * </li>
64
- * </ul>
65
- * <p class="title">
66
- * <b>Related APIs</b>
67
- * </p>
68
- * <ul>
69
- * <li>
70
- * <p>
71
- * <a>ListDatasetGroups</a>
72
- * </p>
73
- * </li>
74
- * <li>
75
- * <p>
76
- * <a>DescribeDatasetGroup</a>
77
- * </p>
78
- * </li>
79
- * <li>
80
- * <p>
81
- * <a>DeleteDatasetGroup</a>
82
- * </p>
83
- * </li>
84
- * </ul>
85
- * @example
86
- * Use a bare-bones client and the command you need to make an API call.
87
- * ```javascript
88
- * import { PersonalizeClient, CreateDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import
89
- * // const { PersonalizeClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
90
- * const client = new PersonalizeClient(config);
91
- * const command = new CreateDatasetGroupCommand(input);
92
- * const response = await client.send(command);
93
- * ```
94
- *
95
- * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape.
96
- * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape.
97
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
98
- *
99
- */
100
8
  class CreateDatasetGroupCommand extends smithy_client_1.Command {
101
- // Start section: command_properties
102
- // End section: command_properties
103
9
  constructor(input) {
104
- // Start section: command_constructor
105
10
  super();
106
11
  this.input = input;
107
- // End section: command_constructor
108
12
  }
109
- /**
110
- * @internal
111
- */
112
13
  resolveMiddleware(clientStack, configuration, options) {
113
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
114
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,76 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an
10
- * Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an
11
- * IAM service role that has permission to read from the data source, as Amazon Personalize makes a
12
- * copy of your data and processes it internally. For information on granting access
13
- * to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize
14
- * Access to Amazon S3 Resources</a>. </p>
15
- * <important>
16
- * <p>The dataset import job replaces any existing data in the dataset that you imported in bulk.</p>
17
- * </important>
18
- * <p>
19
- * <b>Status</b>
20
- * </p>
21
- * <p>A dataset import job can be in one of the following states:</p>
22
- * <ul>
23
- * <li>
24
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
25
- * </li>
26
- * </ul>
27
- * <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
28
- * providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
29
- * complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
30
- * includes a <code>failureReason</code> key, which describes why the job failed.</p>
31
- * <note>
32
- * <p>Importing takes time. You must wait until the status shows as ACTIVE before training a
33
- * model using the dataset.</p>
34
- * </note>
35
- *
36
- * <p class="title">
37
- * <b>Related APIs</b>
38
- * </p>
39
- * <ul>
40
- * <li>
41
- * <p>
42
- * <a>ListDatasetImportJobs</a>
43
- * </p>
44
- * </li>
45
- * <li>
46
- * <p>
47
- * <a>DescribeDatasetImportJob</a>
48
- * </p>
49
- * </li>
50
- * </ul>
51
- * @example
52
- * Use a bare-bones client and the command you need to make an API call.
53
- * ```javascript
54
- * import { PersonalizeClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
55
- * // const { PersonalizeClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
56
- * const client = new PersonalizeClient(config);
57
- * const command = new CreateDatasetImportJobCommand(input);
58
- * const response = await client.send(command);
59
- * ```
60
- *
61
- * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape.
62
- * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape.
63
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
64
- *
65
- */
66
8
  class CreateDatasetImportJobCommand extends smithy_client_1.Command {
67
- // Start section: command_properties
68
- // End section: command_properties
69
9
  constructor(input) {
70
- // Start section: command_constructor
71
10
  super();
72
11
  this.input = input;
73
- // End section: command_constructor
74
12
  }
75
- /**
76
- * @internal
77
- */
78
13
  resolveMiddleware(clientStack, configuration, options) {
79
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
80
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,80 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates an event tracker that you use when adding event data to a specified dataset
10
- * group using the
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
12
- * <note>
13
- * <p>Only one event tracker can be associated with a dataset group. You will get
14
- * an error if you call <code>CreateEventTracker</code> using the same dataset group as an
15
- * existing event tracker.</p>
16
- * </note>
17
- * <p>When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the
18
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> operation.
19
- * Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify
20
- * in your event tracker.
21
- * </p>
22
- * <p>The event tracker can be in one of the following states:</p>
23
- * <ul>
24
- * <li>
25
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
26
- * </li>
27
- * <li>
28
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
29
- * </li>
30
- * </ul>
31
- * <p>To get the status of the event tracker, call <a>DescribeEventTracker</a>.</p>
32
- * <note>
33
- * <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p>
34
- * </note>
35
- * <p class="title">
36
- * <b>Related APIs</b>
37
- * </p>
38
- * <ul>
39
- * <li>
40
- * <p>
41
- * <a>ListEventTrackers</a>
42
- * </p>
43
- * </li>
44
- * <li>
45
- * <p>
46
- * <a>DescribeEventTracker</a>
47
- * </p>
48
- * </li>
49
- * <li>
50
- * <p>
51
- * <a>DeleteEventTracker</a>
52
- * </p>
53
- * </li>
54
- * </ul>
55
- * @example
56
- * Use a bare-bones client and the command you need to make an API call.
57
- * ```javascript
58
- * import { PersonalizeClient, CreateEventTrackerCommand } from "@aws-sdk/client-personalize"; // ES Modules import
59
- * // const { PersonalizeClient, CreateEventTrackerCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
60
- * const client = new PersonalizeClient(config);
61
- * const command = new CreateEventTrackerCommand(input);
62
- * const response = await client.send(command);
63
- * ```
64
- *
65
- * @see {@link CreateEventTrackerCommandInput} for command's `input` shape.
66
- * @see {@link CreateEventTrackerCommandOutput} for command's `response` shape.
67
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
68
- *
69
- */
70
8
  class CreateEventTrackerCommand extends smithy_client_1.Command {
71
- // Start section: command_properties
72
- // End section: command_properties
73
9
  constructor(input) {
74
- // Start section: command_constructor
75
10
  super();
76
11
  this.input = input;
77
- // End section: command_constructor
78
12
  }
79
- /**
80
- * @internal
81
- */
82
13
  resolveMiddleware(clientStack, configuration, options) {
83
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
84
15
  const stack = clientStack.concat(this.middlewareStack);