@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
@@ -56,125 +56,59 @@ import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./comma
56
56
  export declare type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeRecipeCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListRecipesCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | StopSolutionVersionCreationCommandInput | UpdateCampaignCommandInput;
57
57
  export declare type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeRecipeCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListRecipesCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | StopSolutionVersionCreationCommandOutput | UpdateCampaignCommandOutput;
58
58
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
59
- /**
60
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
61
- */
59
+
62
60
  requestHandler?: __HttpHandler;
63
- /**
64
- * A constructor for a class implementing the {@link __Hash} interface
65
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
66
- * @internal
67
- */
61
+
68
62
  sha256?: __HashConstructor;
69
- /**
70
- * The function that will be used to convert strings into HTTP endpoints.
71
- * @internal
72
- */
63
+
73
64
  urlParser?: __UrlParser;
74
- /**
75
- * A function that can calculate the length of a request body.
76
- * @internal
77
- */
65
+
78
66
  bodyLengthChecker?: (body: any) => number | undefined;
79
- /**
80
- * A function that converts a stream into an array of bytes.
81
- * @internal
82
- */
67
+
83
68
  streamCollector?: __StreamCollector;
84
- /**
85
- * The function that will be used to convert a base64-encoded string to a byte array.
86
- * @internal
87
- */
69
+
88
70
  base64Decoder?: __Decoder;
89
- /**
90
- * The function that will be used to convert binary data to a base64-encoded string.
91
- * @internal
92
- */
71
+
93
72
  base64Encoder?: __Encoder;
94
- /**
95
- * The function that will be used to convert a UTF8-encoded string to a byte array.
96
- * @internal
97
- */
73
+
98
74
  utf8Decoder?: __Decoder;
99
- /**
100
- * The function that will be used to convert binary data to a UTF-8 encoded string.
101
- * @internal
102
- */
75
+
103
76
  utf8Encoder?: __Encoder;
104
- /**
105
- * The runtime environment.
106
- * @internal
107
- */
77
+
108
78
  runtime?: string;
109
- /**
110
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
111
- * trait of an operation.
112
- */
79
+
113
80
  disableHostPrefix?: boolean;
114
- /**
115
- * Value for how many times a request will be made at most in case of retry.
116
- */
81
+
117
82
  maxAttempts?: number | __Provider<number>;
118
- /**
119
- * Specifies which retry algorithm to use.
120
- */
83
+
121
84
  retryMode?: string | __Provider<string>;
122
- /**
123
- * Optional logger for logging debug/info/warn/error.
124
- */
85
+
125
86
  logger?: __Logger;
126
- /**
127
- * Unique service identifier.
128
- * @internal
129
- */
87
+
130
88
  serviceId?: string;
131
- /**
132
- * The AWS region to which this client will send requests
133
- */
89
+
134
90
  region?: string | __Provider<string>;
135
- /**
136
- * Default credentials provider; Not available in browser runtime.
137
- * @internal
138
- */
91
+
139
92
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
140
- /**
141
- * Fetch related hostname, signing name or signing region with given region.
142
- * @internal
143
- */
93
+
144
94
  regionInfoProvider?: RegionInfoProvider;
145
- /**
146
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
147
- * @internal
148
- */
95
+
149
96
  defaultUserAgentProvider?: Provider<__UserAgent>;
150
97
  }
151
98
  declare type PersonalizeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
152
- /**
153
- * The configuration interface of PersonalizeClient class constructor that set the region, credentials and other options.
154
- */
99
+
155
100
  export interface PersonalizeClientConfig extends PersonalizeClientConfigType {
156
101
  }
157
102
  declare type PersonalizeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
158
- /**
159
- * The resolved configuration interface of PersonalizeClient class. This is resolved and normalized from the {@link PersonalizeClientConfig | constructor configuration interface}.
160
- */
103
+
161
104
  export interface PersonalizeClientResolvedConfig extends PersonalizeClientResolvedConfigType {
162
105
  }
163
- /**
164
- * <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
165
- * recommendations to customers.</p>
166
- */
106
+
167
107
  export declare class PersonalizeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeClientResolvedConfig> {
168
- /**
169
- * The resolved configuration of PersonalizeClient class. This is resolved and normalized from the {@link PersonalizeClientConfig | constructor configuration interface}.
170
- */
108
+
171
109
  readonly config: PersonalizeClientResolvedConfig;
172
110
  constructor(configuration: PersonalizeClientConfig);
173
- /**
174
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
175
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
176
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
177
- */
111
+
178
112
  destroy(): void;
179
113
  }
180
114
  export {};
@@ -6,30 +6,11 @@ export interface CreateBatchInferenceJobCommandInput extends CreateBatchInferenc
6
6
  }
7
7
  export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferenceJobResponse, __MetadataBearer {
8
8
  }
9
- /**
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 <a>recommendations-batch</a>.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { PersonalizeClient, CreateBatchInferenceJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
16
- * // const { PersonalizeClient, CreateBatchInferenceJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
17
- * const client = new PersonalizeClient(config);
18
- * const command = new CreateBatchInferenceJobCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link CreateBatchInferenceJobCommandInput} for command's `input` shape.
23
- * @see {@link CreateBatchInferenceJobCommandOutput} for command's `response` shape.
24
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class CreateBatchInferenceJobCommand extends $Command<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
28
11
  readonly input: CreateBatchInferenceJobCommandInput;
29
12
  constructor(input: CreateBatchInferenceJobCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,99 +6,11 @@ export interface CreateCampaignCommandInput extends CreateCampaignRequest {
6
6
  }
7
7
  export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a campaign by deploying a solution version. When a client calls the
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
12
- * and
13
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
14
- * APIs, a campaign is specified in the request.</p>
15
- *
16
- * <p>
17
- * <b>Minimum Provisioned TPS and Auto-Scaling</b>
18
- * </p>
19
- *
20
- * <p>A transaction is a single <code>GetRecommendations</code> or
21
- * <code>GetPersonalizedRanking</code> call. Transactions per second (TPS) is the throughput
22
- * and unit of billing for Amazon Personalize. The minimum provisioned TPS
23
- * (<code>minProvisionedTPS</code>) specifies the baseline throughput provisioned by
24
- * Amazon Personalize, and thus, the minimum billing charge.
25
- * </p>
26
- * <p>
27
- * If your TPS increases beyond
28
- * <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down,
29
- * but never below <code>minProvisionedTPS</code>.
30
- * There's a short time delay while the capacity is increased that might cause loss of
31
- * transactions.</p>
32
- * <p>The actual TPS used is calculated as the average requests/second within a 5-minute window.
33
- * You pay for maximum of either the minimum provisioned TPS or the actual TPS.
34
- * We recommend starting with a low <code>minProvisionedTPS</code>, track
35
- * your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code>
36
- * as necessary.</p>
37
- *
38
- * <p>
39
- * <b>Status</b>
40
- * </p>
41
- * <p>A campaign can be in one of the following states:</p>
42
- * <ul>
43
- * <li>
44
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
45
- * </li>
46
- * <li>
47
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
48
- * </li>
49
- * </ul>
50
- * <p>To get the campaign status, call <a>DescribeCampaign</a>.</p>
51
- * <note>
52
- * <p>Wait until the <code>status</code> of the campaign
53
- * is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
54
- * </note>
55
- *
56
- * <p class="title">
57
- * <b>Related APIs</b>
58
- * </p>
59
- * <ul>
60
- * <li>
61
- * <p>
62
- * <a>ListCampaigns</a>
63
- * </p>
64
- * </li>
65
- * <li>
66
- * <p>
67
- * <a>DescribeCampaign</a>
68
- * </p>
69
- * </li>
70
- * <li>
71
- * <p>
72
- * <a>UpdateCampaign</a>
73
- * </p>
74
- * </li>
75
- * <li>
76
- * <p>
77
- * <a>DeleteCampaign</a>
78
- * </p>
79
- * </li>
80
- * </ul>
81
- * @example
82
- * Use a bare-bones client and the command you need to make an API call.
83
- * ```javascript
84
- * import { PersonalizeClient, CreateCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import
85
- * // const { PersonalizeClient, CreateCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
86
- * const client = new PersonalizeClient(config);
87
- * const command = new CreateCampaignCommand(input);
88
- * const response = await client.send(command);
89
- * ```
90
- *
91
- * @see {@link CreateCampaignCommandInput} for command's `input` shape.
92
- * @see {@link CreateCampaignCommandOutput} for command's `response` shape.
93
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
94
- *
95
- */
9
+
96
10
  export declare class CreateCampaignCommand extends $Command<CreateCampaignCommandInput, CreateCampaignCommandOutput, PersonalizeClientResolvedConfig> {
97
11
  readonly input: CreateCampaignCommandInput;
98
12
  constructor(input: CreateCampaignCommandInput);
99
- /**
100
- * @internal
101
- */
13
+
102
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCampaignCommandInput, CreateCampaignCommandOutput>;
103
15
  private serialize;
104
16
  private deserialize;
@@ -6,79 +6,11 @@ export interface CreateDatasetCommandInput extends CreateDatasetRequest {
6
6
  }
7
7
  export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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>
11
- * <p>There are three types of datasets:</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>Each dataset type has an associated schema with required field types. Only the
24
- * <code>Interactions</code> dataset is required in order to train a model (also referred to as
25
- * creating a solution).</p>
26
- * <p>A dataset 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 > DELETE IN_PROGRESS</p>
33
- * </li>
34
- * </ul>
35
- * <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
36
- * <p class="title">
37
- * <b>Related APIs</b>
38
- * </p>
39
- * <ul>
40
- * <li>
41
- * <p>
42
- * <a>CreateDatasetGroup</a>
43
- * </p>
44
- * </li>
45
- * <li>
46
- * <p>
47
- * <a>ListDatasets</a>
48
- * </p>
49
- * </li>
50
- * <li>
51
- * <p>
52
- * <a>DescribeDataset</a>
53
- * </p>
54
- * </li>
55
- * <li>
56
- * <p>
57
- * <a>DeleteDataset</a>
58
- * </p>
59
- * </li>
60
- * </ul>
61
- * @example
62
- * Use a bare-bones client and the command you need to make an API call.
63
- * ```javascript
64
- * import { PersonalizeClient, CreateDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import
65
- * // const { PersonalizeClient, CreateDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
66
- * const client = new PersonalizeClient(config);
67
- * const command = new CreateDatasetCommand(input);
68
- * const response = await client.send(command);
69
- * ```
70
- *
71
- * @see {@link CreateDatasetCommandInput} for command's `input` shape.
72
- * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
73
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
74
- *
75
- */
9
+
76
10
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, PersonalizeClientResolvedConfig> {
77
11
  readonly input: CreateDatasetCommandInput;
78
12
  constructor(input: CreateDatasetCommandInput);
79
- /**
80
- * @internal
81
- */
13
+
82
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput>;
83
15
  private serialize;
84
16
  private deserialize;
@@ -6,50 +6,11 @@ export interface CreateDatasetExportJobCommandInput extends CreateDatasetExportJ
6
6
  }
7
7
  export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExportJobResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>
11
- * Creates a job that exports data from your dataset to an Amazon S3 bucket.
12
- * To allow Amazon Personalize to export the training data, you must specify an
13
- * service-linked IAM role that gives Amazon Personalize <code>PutObject</code> permissions for your Amazon S3 bucket.
14
- * For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
15
- * in the Amazon Personalize developer guide.
16
- * </p>
17
- * <p>
18
- * <b>Status</b>
19
- * </p>
20
- * <p>A dataset export job can be in one of the following states:</p>
21
- * <ul>
22
- * <li>
23
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
24
- * </li>
25
- * </ul>
26
- * <p>
27
- * To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
28
- * and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.
31
- * </p>
32
- * @example
33
- * Use a bare-bones client and the command you need to make an API call.
34
- * ```javascript
35
- * import { PersonalizeClient, CreateDatasetExportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
36
- * // const { PersonalizeClient, CreateDatasetExportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
37
- * const client = new PersonalizeClient(config);
38
- * const command = new CreateDatasetExportJobCommand(input);
39
- * const response = await client.send(command);
40
- * ```
41
- *
42
- * @see {@link CreateDatasetExportJobCommandInput} for command's `input` shape.
43
- * @see {@link CreateDatasetExportJobCommandOutput} for command's `response` shape.
44
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
45
- *
46
- */
9
+
47
10
  export declare class CreateDatasetExportJobCommand extends $Command<CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput, PersonalizeClientResolvedConfig> {
48
11
  readonly input: CreateDatasetExportJobCommandInput;
49
12
  constructor(input: CreateDatasetExportJobCommandInput);
50
- /**
51
- * @internal
52
- */
13
+
53
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput>;
54
15
  private serialize;
55
16
  private deserialize;
@@ -6,104 +6,11 @@ export interface CreateDatasetGroupCommandInput extends CreateDatasetGroupReques
6
6
  }
7
7
  export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates an empty dataset group. A dataset group contains related datasets that supply data
11
- * for training a model. A dataset group can contain at most three datasets, one for each type of
12
- * dataset:</p>
13
- * <ul>
14
- * <li>
15
- * <p>Interactions</p>
16
- * </li>
17
- * <li>
18
- * <p>Items</p>
19
- * </li>
20
- * <li>
21
- * <p>Users</p>
22
- * </li>
23
- * </ul>
24
- * <p>To train a model (create a solution), a dataset group that contains an
25
- * <code>Interactions</code> dataset is required. Call <a>CreateDataset</a> to add a
26
- * dataset to the group.</p>
27
- * <p>A dataset group can be in one of the following states:</p>
28
- * <ul>
29
- * <li>
30
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
31
- * </li>
32
- * <li>
33
- * <p>DELETE PENDING</p>
34
- * </li>
35
- * </ul>
36
- * <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
37
- * the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
38
- * which describes why the creation failed.</p>
39
- * <note>
40
- * <p>You must wait until the <code>status</code> of the dataset group is <code>ACTIVE</code>
41
- * before adding a dataset to the group.</p>
42
- * </note>
43
- * <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you
44
- * specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to
45
- * access the key.</p>
46
- * <p class="title">
47
- * <b>APIs that require a dataset group ARN in the request</b>
48
- * </p>
49
- * <ul>
50
- * <li>
51
- * <p>
52
- * <a>CreateDataset</a>
53
- * </p>
54
- * </li>
55
- * <li>
56
- * <p>
57
- * <a>CreateEventTracker</a>
58
- * </p>
59
- * </li>
60
- * <li>
61
- * <p>
62
- * <a>CreateSolution</a>
63
- * </p>
64
- * </li>
65
- * </ul>
66
- * <p class="title">
67
- * <b>Related APIs</b>
68
- * </p>
69
- * <ul>
70
- * <li>
71
- * <p>
72
- * <a>ListDatasetGroups</a>
73
- * </p>
74
- * </li>
75
- * <li>
76
- * <p>
77
- * <a>DescribeDatasetGroup</a>
78
- * </p>
79
- * </li>
80
- * <li>
81
- * <p>
82
- * <a>DeleteDatasetGroup</a>
83
- * </p>
84
- * </li>
85
- * </ul>
86
- * @example
87
- * Use a bare-bones client and the command you need to make an API call.
88
- * ```javascript
89
- * import { PersonalizeClient, CreateDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import
90
- * // const { PersonalizeClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
91
- * const client = new PersonalizeClient(config);
92
- * const command = new CreateDatasetGroupCommand(input);
93
- * const response = await client.send(command);
94
- * ```
95
- *
96
- * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape.
97
- * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape.
98
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
99
- *
100
- */
9
+
101
10
  export declare class CreateDatasetGroupCommand extends $Command<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput, PersonalizeClientResolvedConfig> {
102
11
  readonly input: CreateDatasetGroupCommandInput;
103
12
  constructor(input: CreateDatasetGroupCommandInput);
104
- /**
105
- * @internal
106
- */
13
+
107
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput>;
108
15
  private serialize;
109
16
  private deserialize;
@@ -6,70 +6,11 @@ export interface CreateDatasetImportJobCommandInput extends CreateDatasetImportJ
6
6
  }
7
7
  export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImportJobResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an
11
- * Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an
12
- * IAM service role that has permission to read from the data source, as Amazon Personalize makes a
13
- * copy of your data and processes it internally. For information on granting access
14
- * to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize
15
- * Access to Amazon S3 Resources</a>. </p>
16
- * <important>
17
- * <p>The dataset import job replaces any existing data in the dataset that you imported in bulk.</p>
18
- * </important>
19
- * <p>
20
- * <b>Status</b>
21
- * </p>
22
- * <p>A dataset import job 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
- * </ul>
28
- * <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
29
- * providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
30
- * complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
31
- * includes a <code>failureReason</code> key, which describes why the job failed.</p>
32
- * <note>
33
- * <p>Importing takes time. You must wait until the status shows as ACTIVE before training a
34
- * model using the dataset.</p>
35
- * </note>
36
- *
37
- * <p class="title">
38
- * <b>Related APIs</b>
39
- * </p>
40
- * <ul>
41
- * <li>
42
- * <p>
43
- * <a>ListDatasetImportJobs</a>
44
- * </p>
45
- * </li>
46
- * <li>
47
- * <p>
48
- * <a>DescribeDatasetImportJob</a>
49
- * </p>
50
- * </li>
51
- * </ul>
52
- * @example
53
- * Use a bare-bones client and the command you need to make an API call.
54
- * ```javascript
55
- * import { PersonalizeClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
56
- * // const { PersonalizeClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
57
- * const client = new PersonalizeClient(config);
58
- * const command = new CreateDatasetImportJobCommand(input);
59
- * const response = await client.send(command);
60
- * ```
61
- *
62
- * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape.
63
- * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape.
64
- * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape.
65
- *
66
- */
9
+
67
10
  export declare class CreateDatasetImportJobCommand extends $Command<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput, PersonalizeClientResolvedConfig> {
68
11
  readonly input: CreateDatasetImportJobCommandInput;
69
12
  constructor(input: CreateDatasetImportJobCommandInput);
70
- /**
71
- * @internal
72
- */
13
+
73
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput>;
74
15
  private serialize;
75
16
  private deserialize;