@aws-sdk/client-cleanroomsml 3.529.1 → 3.535.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 (63) hide show
  1. package/dist-types/CleanRoomsML.d.ts +6 -1
  2. package/dist-types/CleanRoomsMLClient.d.ts +1 -1
  3. package/dist-types/commands/CreateAudienceModelCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateConfiguredAudienceModelCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateTrainingDatasetCommand.d.ts +2 -1
  6. package/dist-types/commands/DeleteAudienceGenerationJobCommand.d.ts +2 -1
  7. package/dist-types/commands/DeleteAudienceModelCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteConfiguredAudienceModelCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteTrainingDatasetCommand.d.ts +2 -1
  11. package/dist-types/commands/GetAudienceGenerationJobCommand.d.ts +2 -1
  12. package/dist-types/commands/GetAudienceModelCommand.d.ts +2 -1
  13. package/dist-types/commands/GetConfiguredAudienceModelCommand.d.ts +2 -1
  14. package/dist-types/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +2 -1
  15. package/dist-types/commands/GetTrainingDatasetCommand.d.ts +2 -1
  16. package/dist-types/commands/ListAudienceExportJobsCommand.d.ts +2 -1
  17. package/dist-types/commands/ListAudienceGenerationJobsCommand.d.ts +2 -1
  18. package/dist-types/commands/ListAudienceModelsCommand.d.ts +2 -1
  19. package/dist-types/commands/ListConfiguredAudienceModelsCommand.d.ts +2 -1
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  21. package/dist-types/commands/ListTrainingDatasetsCommand.d.ts +2 -1
  22. package/dist-types/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +2 -1
  23. package/dist-types/commands/StartAudienceExportJobCommand.d.ts +2 -1
  24. package/dist-types/commands/StartAudienceGenerationJobCommand.d.ts +2 -1
  25. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  26. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  27. package/dist-types/commands/UpdateConfiguredAudienceModelCommand.d.ts +2 -1
  28. package/dist-types/models/models_0.d.ts +233 -233
  29. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  30. package/dist-types/runtimeConfig.d.ts +2 -2
  31. package/dist-types/runtimeConfig.native.d.ts +2 -2
  32. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  33. package/dist-types/ts3.4/CleanRoomsML.d.ts +5 -0
  34. package/dist-types/ts3.4/commands/CreateAudienceModelCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/CreateConfiguredAudienceModelCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/CreateTrainingDatasetCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/DeleteAudienceGenerationJobCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/DeleteAudienceModelCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/DeleteTrainingDatasetCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/GetAudienceGenerationJobCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/GetAudienceModelCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/GetConfiguredAudienceModelCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/GetTrainingDatasetCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/ListAudienceExportJobsCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/ListAudienceGenerationJobsCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/ListAudienceModelsCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/ListConfiguredAudienceModelsCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/ListTrainingDatasetsCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/StartAudienceExportJobCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/StartAudienceGenerationJobCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/UpdateConfiguredAudienceModelCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  60. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  61. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  62. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  63. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { CleanRoomsMLServiceException as __BaseException } from "./CleanRoomsMLServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,24 +13,24 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>Provides information about an Amazon S3 bucket and path.</p>
17
+ * @public
18
18
  */
19
19
  export interface S3ConfigMap {
20
20
  /**
21
- * @public
22
21
  * <p>The Amazon S3 location URI.</p>
22
+ * @public
23
23
  */
24
24
  s3Uri: string | undefined;
25
25
  }
26
26
  /**
27
- * @public
28
27
  * <p>Defines the Amazon S3 bucket where the configured audience is stored.</p>
28
+ * @public
29
29
  */
30
30
  export interface AudienceDestination {
31
31
  /**
32
- * @public
33
32
  * <p>The Amazon S3 bucket and path for the configured audience.</p>
33
+ * @public
34
34
  */
35
35
  s3Destination: S3ConfigMap | undefined;
36
36
  }
@@ -39,18 +39,18 @@ export interface AudienceDestination {
39
39
  */
40
40
  export interface ListAudienceExportJobsRequest {
41
41
  /**
42
- * @public
43
42
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
43
+ * @public
44
44
  */
45
45
  nextToken?: string;
46
46
  /**
47
- * @public
48
47
  * <p>The maximum size of the results that is returned per call.</p>
48
+ * @public
49
49
  */
50
50
  maxResults?: number;
51
51
  /**
52
- * @public
53
52
  * <p>The Amazon Resource Name (ARN) of the audience generation job that you are interested in.</p>
53
+ * @public
54
54
  */
55
55
  audienceGenerationJobArn?: string;
56
56
  }
@@ -67,20 +67,20 @@ export declare const AudienceSizeType: {
67
67
  */
68
68
  export type AudienceSizeType = (typeof AudienceSizeType)[keyof typeof AudienceSizeType];
69
69
  /**
70
- * @public
71
70
  * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
71
+ * @public
72
72
  */
73
73
  export interface AudienceSize {
74
74
  /**
75
- * @public
76
75
  * <p>Whether the audience size is defined in absolute terms or as a percentage. You can use the <code>ABSOLUTE</code>
77
76
  * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
78
77
  * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
78
+ * @public
79
79
  */
80
80
  type: AudienceSizeType | undefined;
81
81
  /**
82
- * @public
83
82
  * <p>Specify an audience size value.</p>
83
+ * @public
84
84
  */
85
85
  value: number | undefined;
86
86
  }
@@ -99,69 +99,69 @@ export declare const AudienceExportJobStatus: {
99
99
  */
100
100
  export type AudienceExportJobStatus = (typeof AudienceExportJobStatus)[keyof typeof AudienceExportJobStatus];
101
101
  /**
102
- * @public
103
102
  * <p>Details about the status of a resource.</p>
103
+ * @public
104
104
  */
105
105
  export interface StatusDetails {
106
106
  /**
107
- * @public
108
107
  * <p>The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.</p>
108
+ * @public
109
109
  */
110
110
  statusCode?: string;
111
111
  /**
112
- * @public
113
112
  * <p>The error message that was returned. The message is intended for human consumption and can change at any time. Use the <code>statusCode</code> for programmatic error handling.</p>
113
+ * @public
114
114
  */
115
115
  message?: string;
116
116
  }
117
117
  /**
118
- * @public
119
118
  * <p>Provides information about the audience export job.</p>
119
+ * @public
120
120
  */
121
121
  export interface AudienceExportJobSummary {
122
122
  /**
123
- * @public
124
123
  * <p>The time at which the audience export job was created.</p>
124
+ * @public
125
125
  */
126
126
  createTime: Date | undefined;
127
127
  /**
128
- * @public
129
128
  * <p>The most recent time at which the audience export job was updated.</p>
129
+ * @public
130
130
  */
131
131
  updateTime: Date | undefined;
132
132
  /**
133
- * @public
134
133
  * <p>The name of the audience export job.</p>
134
+ * @public
135
135
  */
136
136
  name: string | undefined;
137
137
  /**
138
- * @public
139
138
  * <p>The Amazon Resource Name (ARN) of the audience generation job that was exported.</p>
139
+ * @public
140
140
  */
141
141
  audienceGenerationJobArn: string | undefined;
142
142
  /**
143
- * @public
144
143
  * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
144
+ * @public
145
145
  */
146
146
  audienceSize: AudienceSize | undefined;
147
147
  /**
148
- * @public
149
148
  * <p>The description of the audience export job.</p>
149
+ * @public
150
150
  */
151
151
  description?: string;
152
152
  /**
153
- * @public
154
153
  * <p>The status of the audience export job.</p>
154
+ * @public
155
155
  */
156
156
  status: AudienceExportJobStatus | undefined;
157
157
  /**
158
- * @public
159
158
  * <p>Details about the status of a resource.</p>
159
+ * @public
160
160
  */
161
161
  statusDetails?: StatusDetails;
162
162
  /**
163
- * @public
164
163
  * <p>The Amazon S3 bucket where the audience export is stored.</p>
164
+ * @public
165
165
  */
166
166
  outputLocation?: string;
167
167
  }
@@ -170,19 +170,19 @@ export interface AudienceExportJobSummary {
170
170
  */
171
171
  export interface ListAudienceExportJobsResponse {
172
172
  /**
173
- * @public
174
173
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
174
+ * @public
175
175
  */
176
176
  nextToken?: string;
177
177
  /**
178
- * @public
179
178
  * <p>The audience export jobs that match the request.</p>
179
+ * @public
180
180
  */
181
181
  audienceExportJobs: AudienceExportJobSummary[] | undefined;
182
182
  }
183
183
  /**
184
- * @public
185
184
  * <p>The request parameters for this request are incorrect.</p>
185
+ * @public
186
186
  */
187
187
  export declare class ValidationException extends __BaseException {
188
188
  readonly name: "ValidationException";
@@ -193,8 +193,8 @@ export declare class ValidationException extends __BaseException {
193
193
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
194
194
  }
195
195
  /**
196
- * @public
197
196
  * <p>A resource with that name already exists in this region.</p>
197
+ * @public
198
198
  */
199
199
  export declare class ConflictException extends __BaseException {
200
200
  readonly name: "ConflictException";
@@ -205,8 +205,8 @@ export declare class ConflictException extends __BaseException {
205
205
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
206
206
  }
207
207
  /**
208
- * @public
209
208
  * <p>The resource you are requesting does not exist.</p>
209
+ * @public
210
210
  */
211
211
  export declare class ResourceNotFoundException extends __BaseException {
212
212
  readonly name: "ResourceNotFoundException";
@@ -217,8 +217,8 @@ export declare class ResourceNotFoundException extends __BaseException {
217
217
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
218
218
  }
219
219
  /**
220
- * @public
221
220
  * <p>You have exceeded your service quota.</p>
221
+ * @public
222
222
  */
223
223
  export declare class ServiceQuotaExceededException extends __BaseException {
224
224
  readonly name: "ServiceQuotaExceededException";
@@ -233,23 +233,23 @@ export declare class ServiceQuotaExceededException extends __BaseException {
233
233
  */
234
234
  export interface StartAudienceExportJobRequest {
235
235
  /**
236
- * @public
237
236
  * <p>The name of the audience export job.</p>
237
+ * @public
238
238
  */
239
239
  name: string | undefined;
240
240
  /**
241
- * @public
242
241
  * <p>The Amazon Resource Name (ARN) of the audience generation job that you want to export.</p>
242
+ * @public
243
243
  */
244
244
  audienceGenerationJobArn: string | undefined;
245
245
  /**
246
- * @public
247
246
  * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
247
+ * @public
248
248
  */
249
249
  audienceSize: AudienceSize | undefined;
250
250
  /**
251
- * @public
252
251
  * <p>The description of the audience export job.</p>
252
+ * @public
253
253
  */
254
254
  description?: string;
255
255
  }
@@ -258,8 +258,8 @@ export interface StartAudienceExportJobRequest {
258
258
  */
259
259
  export interface DeleteAudienceGenerationJobRequest {
260
260
  /**
261
- * @public
262
261
  * <p>The Amazon Resource Name (ARN) of the audience generation job that you want to delete.</p>
262
+ * @public
263
263
  */
264
264
  audienceGenerationJobArn: string | undefined;
265
265
  }
@@ -268,51 +268,51 @@ export interface DeleteAudienceGenerationJobRequest {
268
268
  */
269
269
  export interface GetAudienceGenerationJobRequest {
270
270
  /**
271
- * @public
272
271
  * <p>The Amazon Resource Name (ARN) of the audience generation job that you are interested in.</p>
272
+ * @public
273
273
  */
274
274
  audienceGenerationJobArn: string | undefined;
275
275
  }
276
276
  /**
277
- * @public
278
277
  * <p>The relevance score of a generated audience.</p>
278
+ * @public
279
279
  */
280
280
  export interface RelevanceMetric {
281
281
  /**
282
- * @public
283
282
  * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
283
+ * @public
284
284
  */
285
285
  audienceSize: AudienceSize | undefined;
286
286
  /**
287
- * @public
288
287
  * <p>The relevance score of the generated audience.</p>
288
+ * @public
289
289
  */
290
290
  score?: number;
291
291
  }
292
292
  /**
293
- * @public
294
293
  * <p>Metrics that describe the quality of the generated audience.</p>
294
+ * @public
295
295
  */
296
296
  export interface AudienceQualityMetrics {
297
297
  /**
298
- * @public
299
298
  * <p>The relevance scores of the generated audience.</p>
299
+ * @public
300
300
  */
301
301
  relevanceMetrics: RelevanceMetric[] | undefined;
302
302
  }
303
303
  /**
304
- * @public
305
304
  * <p>Defines the Amazon S3 bucket where the training data for the configured audience is stored.</p>
305
+ * @public
306
306
  */
307
307
  export interface AudienceGenerationJobDataSource {
308
308
  /**
309
- * @public
310
309
  * <p>The Amazon S3 bucket where the training data for the configured audience is stored.</p>
310
+ * @public
311
311
  */
312
312
  dataSource: S3ConfigMap | undefined;
313
313
  /**
314
- * @public
315
314
  * <p>The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.</p>
315
+ * @public
316
316
  */
317
317
  roleArn: string | undefined;
318
318
  }
@@ -338,73 +338,73 @@ export type AudienceGenerationJobStatus = (typeof AudienceGenerationJobStatus)[k
338
338
  */
339
339
  export interface GetAudienceGenerationJobResponse {
340
340
  /**
341
- * @public
342
341
  * <p>The time at which the audience generation job was created.</p>
342
+ * @public
343
343
  */
344
344
  createTime: Date | undefined;
345
345
  /**
346
- * @public
347
346
  * <p>The most recent time at which the audience generation job was updated.</p>
347
+ * @public
348
348
  */
349
349
  updateTime: Date | undefined;
350
350
  /**
351
- * @public
352
351
  * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
352
+ * @public
353
353
  */
354
354
  audienceGenerationJobArn: string | undefined;
355
355
  /**
356
- * @public
357
356
  * <p>The name of the audience generation job.</p>
357
+ * @public
358
358
  */
359
359
  name: string | undefined;
360
360
  /**
361
- * @public
362
361
  * <p>The description of the audience generation job.</p>
362
+ * @public
363
363
  */
364
364
  description?: string;
365
365
  /**
366
- * @public
367
366
  * <p>The status of the audience generation job.</p>
367
+ * @public
368
368
  */
369
369
  status: AudienceGenerationJobStatus | undefined;
370
370
  /**
371
- * @public
372
371
  * <p>Details about the status of the audience generation job.</p>
372
+ * @public
373
373
  */
374
374
  statusDetails?: StatusDetails;
375
375
  /**
376
- * @public
377
376
  * <p>The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.</p>
377
+ * @public
378
378
  */
379
379
  configuredAudienceModelArn: string | undefined;
380
380
  /**
381
- * @public
382
381
  * <p>The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job. </p>
382
+ * @public
383
383
  */
384
384
  seedAudience?: AudienceGenerationJobDataSource;
385
385
  /**
386
- * @public
387
386
  * <p>Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify <code>TRUE</code>, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first <code>minimumSeedSize</code> count of users are from the seed.</p>
387
+ * @public
388
388
  */
389
389
  includeSeedInOutput?: boolean;
390
390
  /**
391
- * @public
392
391
  * <p>The identifier of the collaboration that this audience generation job is associated with.</p>
392
+ * @public
393
393
  */
394
394
  collaborationId?: string;
395
395
  /**
396
- * @public
397
396
  * <p>The relevance scores for different audience sizes. </p>
397
+ * @public
398
398
  */
399
399
  metrics?: AudienceQualityMetrics;
400
400
  /**
401
- * @public
402
401
  * <p>The AWS account that started this audience generation job.</p>
402
+ * @public
403
403
  */
404
404
  startedBy?: string;
405
405
  /**
406
- * @public
407
406
  * <p>The tags that are associated to this audience generation job.</p>
407
+ * @public
408
408
  */
409
409
  tags?: Record<string, string>;
410
410
  }
@@ -413,74 +413,74 @@ export interface GetAudienceGenerationJobResponse {
413
413
  */
414
414
  export interface ListAudienceGenerationJobsRequest {
415
415
  /**
416
- * @public
417
416
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
417
+ * @public
418
418
  */
419
419
  nextToken?: string;
420
420
  /**
421
- * @public
422
421
  * <p>The maximum size of the results that is returned per call.</p>
422
+ * @public
423
423
  */
424
424
  maxResults?: number;
425
425
  /**
426
- * @public
427
426
  * <p>The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.</p>
427
+ * @public
428
428
  */
429
429
  configuredAudienceModelArn?: string;
430
430
  /**
431
- * @public
432
431
  * <p>The identifier of the collaboration that contains the audience generation jobs that you are interested in.</p>
432
+ * @public
433
433
  */
434
434
  collaborationId?: string;
435
435
  }
436
436
  /**
437
- * @public
438
437
  * <p>Provides information about the configured audience generation job.</p>
438
+ * @public
439
439
  */
440
440
  export interface AudienceGenerationJobSummary {
441
441
  /**
442
- * @public
443
442
  * <p>The time at which the audience generation job was created.</p>
443
+ * @public
444
444
  */
445
445
  createTime: Date | undefined;
446
446
  /**
447
- * @public
448
447
  * <p>The most recent time at which the audience generation job was updated.</p>
448
+ * @public
449
449
  */
450
450
  updateTime: Date | undefined;
451
451
  /**
452
- * @public
453
452
  * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
453
+ * @public
454
454
  */
455
455
  audienceGenerationJobArn: string | undefined;
456
456
  /**
457
- * @public
458
457
  * <p>The name of the audience generation job.</p>
458
+ * @public
459
459
  */
460
460
  name: string | undefined;
461
461
  /**
462
- * @public
463
462
  * <p>The description of the audience generation job.</p>
463
+ * @public
464
464
  */
465
465
  description?: string;
466
466
  /**
467
- * @public
468
467
  * <p>The status of the audience generation job.</p>
468
+ * @public
469
469
  */
470
470
  status: AudienceGenerationJobStatus | undefined;
471
471
  /**
472
- * @public
473
472
  * <p>The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.</p>
473
+ * @public
474
474
  */
475
475
  configuredAudienceModelArn: string | undefined;
476
476
  /**
477
- * @public
478
477
  * <p>The identifier of the collaboration that contains this audience generation job.</p>
478
+ * @public
479
479
  */
480
480
  collaborationId?: string;
481
481
  /**
482
- * @public
483
482
  * <p>The AWS Account that submitted the job.</p>
483
+ * @public
484
484
  */
485
485
  startedBy?: string;
486
486
  }
@@ -489,13 +489,13 @@ export interface AudienceGenerationJobSummary {
489
489
  */
490
490
  export interface ListAudienceGenerationJobsResponse {
491
491
  /**
492
- * @public
493
492
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
493
+ * @public
494
494
  */
495
495
  nextToken?: string;
496
496
  /**
497
- * @public
498
497
  * <p>The audience generation jobs that match the request.</p>
498
+ * @public
499
499
  */
500
500
  audienceGenerationJobs: AudienceGenerationJobSummary[] | undefined;
501
501
  }
@@ -504,37 +504,36 @@ export interface ListAudienceGenerationJobsResponse {
504
504
  */
505
505
  export interface StartAudienceGenerationJobRequest {
506
506
  /**
507
- * @public
508
507
  * <p>The name of the audience generation job.</p>
508
+ * @public
509
509
  */
510
510
  name: string | undefined;
511
511
  /**
512
- * @public
513
512
  * <p>The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.</p>
513
+ * @public
514
514
  */
515
515
  configuredAudienceModelArn: string | undefined;
516
516
  /**
517
- * @public
518
517
  * <p>The seed audience that is used to generate the audience.</p>
518
+ * @public
519
519
  */
520
520
  seedAudience: AudienceGenerationJobDataSource | undefined;
521
521
  /**
522
- * @public
523
522
  * <p>Whether the seed audience is included in the audience generation output.</p>
523
+ * @public
524
524
  */
525
525
  includeSeedInOutput?: boolean;
526
526
  /**
527
- * @public
528
527
  * <p>The identifier of the collaboration that contains the audience generation job.</p>
528
+ * @public
529
529
  */
530
530
  collaborationId?: string;
531
531
  /**
532
- * @public
533
532
  * <p>The description of the audience generation job.</p>
533
+ * @public
534
534
  */
535
535
  description?: string;
536
536
  /**
537
- * @public
538
537
  * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
539
538
  * <p>The following basic restrictions apply to tags:</p>
540
539
  * <ul>
@@ -560,6 +559,7 @@ export interface StartAudienceGenerationJobRequest {
560
559
  * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
561
560
  * </li>
562
561
  * </ul>
562
+ * @public
563
563
  */
564
564
  tags?: Record<string, string>;
565
565
  }
@@ -568,8 +568,8 @@ export interface StartAudienceGenerationJobRequest {
568
568
  */
569
569
  export interface StartAudienceGenerationJobResponse {
570
570
  /**
571
- * @public
572
571
  * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
572
+ * @public
573
573
  */
574
574
  audienceGenerationJobArn: string | undefined;
575
575
  }
@@ -578,32 +578,31 @@ export interface StartAudienceGenerationJobResponse {
578
578
  */
579
579
  export interface CreateAudienceModelRequest {
580
580
  /**
581
- * @public
582
581
  * <p>The start date and time of the training window.</p>
582
+ * @public
583
583
  */
584
584
  trainingDataStartTime?: Date;
585
585
  /**
586
- * @public
587
586
  * <p>The end date and time of the training window.</p>
587
+ * @public
588
588
  */
589
589
  trainingDataEndTime?: Date;
590
590
  /**
591
- * @public
592
591
  * <p>The name of the audience model resource.</p>
592
+ * @public
593
593
  */
594
594
  name: string | undefined;
595
595
  /**
596
- * @public
597
596
  * <p>The Amazon Resource Name (ARN) of the training dataset for this audience model.</p>
597
+ * @public
598
598
  */
599
599
  trainingDatasetArn: string | undefined;
600
600
  /**
601
- * @public
602
601
  * <p>The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.</p>
602
+ * @public
603
603
  */
604
604
  kmsKeyArn?: string;
605
605
  /**
606
- * @public
607
606
  * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
608
607
  * <p>The following basic restrictions apply to tags:</p>
609
608
  * <ul>
@@ -629,11 +628,12 @@ export interface CreateAudienceModelRequest {
629
628
  * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
630
629
  * </li>
631
630
  * </ul>
631
+ * @public
632
632
  */
633
633
  tags?: Record<string, string>;
634
634
  /**
635
- * @public
636
635
  * <p>The description of the audience model.</p>
636
+ * @public
637
637
  */
638
638
  description?: string;
639
639
  }
@@ -642,8 +642,8 @@ export interface CreateAudienceModelRequest {
642
642
  */
643
643
  export interface CreateAudienceModelResponse {
644
644
  /**
645
- * @public
646
645
  * <p>The Amazon Resource Name (ARN) of the audience model.</p>
646
+ * @public
647
647
  */
648
648
  audienceModelArn: string | undefined;
649
649
  }
@@ -652,8 +652,8 @@ export interface CreateAudienceModelResponse {
652
652
  */
653
653
  export interface DeleteAudienceModelRequest {
654
654
  /**
655
- * @public
656
655
  * <p>The Amazon Resource Name (ARN) of the audience model that you want to delete.</p>
656
+ * @public
657
657
  */
658
658
  audienceModelArn: string | undefined;
659
659
  }
@@ -662,8 +662,8 @@ export interface DeleteAudienceModelRequest {
662
662
  */
663
663
  export interface GetAudienceModelRequest {
664
664
  /**
665
- * @public
666
665
  * <p>The Amazon Resource Name (ARN) of the audience model that you are interested in.</p>
666
+ * @public
667
667
  */
668
668
  audienceModelArn: string | undefined;
669
669
  }
@@ -682,23 +682,23 @@ export declare const AudienceModelMetricType: {
682
682
  */
683
683
  export type AudienceModelMetricType = (typeof AudienceModelMetricType)[keyof typeof AudienceModelMetricType];
684
684
  /**
685
- * @public
686
685
  * <p>The audience model metrics.</p>
686
+ * @public
687
687
  */
688
688
  export interface AudienceModelMetric {
689
689
  /**
690
- * @public
691
690
  * <p>The audience model metric.</p>
691
+ * @public
692
692
  */
693
693
  type: AudienceModelMetricType | undefined;
694
694
  /**
695
- * @public
696
695
  * <p>The number of users that were used to generate these model metrics.</p>
696
+ * @public
697
697
  */
698
698
  forTopKItemPredictions: number | undefined;
699
699
  /**
700
- * @public
701
700
  * <p>The value of the audience model metric</p>
701
+ * @public
702
702
  */
703
703
  value: number | undefined;
704
704
  }
@@ -724,68 +724,68 @@ export type AudienceModelStatus = (typeof AudienceModelStatus)[keyof typeof Audi
724
724
  */
725
725
  export interface GetAudienceModelResponse {
726
726
  /**
727
- * @public
728
727
  * <p>The time at which the audience model was created.</p>
728
+ * @public
729
729
  */
730
730
  createTime: Date | undefined;
731
731
  /**
732
- * @public
733
732
  * <p>The most recent time at which the audience model was updated.</p>
733
+ * @public
734
734
  */
735
735
  updateTime: Date | undefined;
736
736
  /**
737
- * @public
738
737
  * <p>The start date specified for the training window.</p>
738
+ * @public
739
739
  */
740
740
  trainingDataStartTime?: Date;
741
741
  /**
742
- * @public
743
742
  * <p>The end date specified for the training window.</p>
743
+ * @public
744
744
  */
745
745
  trainingDataEndTime?: Date;
746
746
  /**
747
- * @public
748
747
  * <p>The Amazon Resource Name (ARN) of the audience model.</p>
748
+ * @public
749
749
  */
750
750
  audienceModelArn: string | undefined;
751
751
  /**
752
- * @public
753
752
  * <p>The name of the audience model.</p>
753
+ * @public
754
754
  */
755
755
  name: string | undefined;
756
756
  /**
757
- * @public
758
757
  * <p>The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.</p>
758
+ * @public
759
759
  */
760
760
  trainingDatasetArn: string | undefined;
761
761
  /**
762
- * @public
763
762
  * <p>The status of the audience model.</p>
763
+ * @public
764
764
  */
765
765
  status: AudienceModelStatus | undefined;
766
766
  /**
767
- * @public
768
767
  * <p>Details about the status of the audience model.</p>
768
+ * @public
769
769
  */
770
770
  statusDetails?: StatusDetails;
771
771
  /**
772
- * @public
773
772
  * <p>Accuracy metrics for the model.</p>
773
+ * @public
774
774
  */
775
775
  metrics?: AudienceModelMetric[];
776
776
  /**
777
- * @public
778
777
  * <p>The KMS key ARN used for the audience model.</p>
778
+ * @public
779
779
  */
780
780
  kmsKeyArn?: string;
781
781
  /**
782
- * @public
783
782
  * <p>The tags that are assigned to the audience model.</p>
783
+ * @public
784
784
  */
785
785
  tags?: Record<string, string>;
786
786
  /**
787
- * @public
788
787
  * <p>The description of the audience model.</p>
788
+ * @public
789
789
  */
790
790
  description?: string;
791
791
  }
@@ -794,54 +794,54 @@ export interface GetAudienceModelResponse {
794
794
  */
795
795
  export interface ListAudienceModelsRequest {
796
796
  /**
797
- * @public
798
797
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
798
+ * @public
799
799
  */
800
800
  nextToken?: string;
801
801
  /**
802
- * @public
803
802
  * <p>The maximum size of the results that is returned per call.</p>
803
+ * @public
804
804
  */
805
805
  maxResults?: number;
806
806
  }
807
807
  /**
808
- * @public
809
808
  * <p>Information about the audience model.</p>
809
+ * @public
810
810
  */
811
811
  export interface AudienceModelSummary {
812
812
  /**
813
- * @public
814
813
  * <p>The time at which the audience model was created.</p>
814
+ * @public
815
815
  */
816
816
  createTime: Date | undefined;
817
817
  /**
818
- * @public
819
818
  * <p>The most recent time at which the audience model was updated.</p>
819
+ * @public
820
820
  */
821
821
  updateTime: Date | undefined;
822
822
  /**
823
- * @public
824
823
  * <p>The Amazon Resource Name (ARN) of the audience model.</p>
824
+ * @public
825
825
  */
826
826
  audienceModelArn: string | undefined;
827
827
  /**
828
- * @public
829
828
  * <p>The name of the audience model.</p>
829
+ * @public
830
830
  */
831
831
  name: string | undefined;
832
832
  /**
833
- * @public
834
833
  * <p>The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.</p>
834
+ * @public
835
835
  */
836
836
  trainingDatasetArn: string | undefined;
837
837
  /**
838
- * @public
839
838
  * <p>The status of the audience model.</p>
839
+ * @public
840
840
  */
841
841
  status: AudienceModelStatus | undefined;
842
842
  /**
843
- * @public
844
843
  * <p>The description of the audience model.</p>
844
+ * @public
845
845
  */
846
846
  description?: string;
847
847
  }
@@ -850,31 +850,31 @@ export interface AudienceModelSummary {
850
850
  */
851
851
  export interface ListAudienceModelsResponse {
852
852
  /**
853
- * @public
854
853
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
854
+ * @public
855
855
  */
856
856
  nextToken?: string;
857
857
  /**
858
- * @public
859
858
  * <p>The audience models that match the request.</p>
859
+ * @public
860
860
  */
861
861
  audienceModels: AudienceModelSummary[] | undefined;
862
862
  }
863
863
  /**
864
- * @public
865
864
  * <p>Configure the list of audience output sizes that can be created. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
866
865
  * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
867
866
  * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
867
+ * @public
868
868
  */
869
869
  export interface AudienceSizeConfig {
870
870
  /**
871
- * @public
872
871
  * <p>Whether the audience output sizes are defined as an absolute number or a percentage.</p>
872
+ * @public
873
873
  */
874
874
  audienceSizeType: AudienceSizeType | undefined;
875
875
  /**
876
- * @public
877
876
  * <p>An array of the different audience output sizes.</p>
877
+ * @public
878
878
  */
879
879
  audienceSizeBins: number[] | undefined;
880
880
  }
@@ -891,18 +891,18 @@ export declare const TagOnCreatePolicy: {
891
891
  */
892
892
  export type TagOnCreatePolicy = (typeof TagOnCreatePolicy)[keyof typeof TagOnCreatePolicy];
893
893
  /**
894
- * @public
895
894
  * <p>Configuration information necessary for the configure audience model output.</p>
895
+ * @public
896
896
  */
897
897
  export interface ConfiguredAudienceModelOutputConfig {
898
898
  /**
899
- * @public
900
899
  * <p>Defines the Amazon S3 bucket where the configured audience is stored.</p>
900
+ * @public
901
901
  */
902
902
  destination: AudienceDestination | undefined;
903
903
  /**
904
- * @public
905
904
  * <p>The ARN of the IAM role that can write the Amazon S3 bucket.</p>
905
+ * @public
906
906
  */
907
907
  roleArn: string | undefined;
908
908
  }
@@ -923,44 +923,43 @@ export type SharedAudienceMetrics = (typeof SharedAudienceMetrics)[keyof typeof
923
923
  */
924
924
  export interface CreateConfiguredAudienceModelRequest {
925
925
  /**
926
- * @public
927
926
  * <p>The name of the configured audience model.</p>
927
+ * @public
928
928
  */
929
929
  name: string | undefined;
930
930
  /**
931
- * @public
932
931
  * <p>The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.</p>
932
+ * @public
933
933
  */
934
934
  audienceModelArn: string | undefined;
935
935
  /**
936
- * @public
937
936
  * <p>Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have <code>s3:PutObject</code> permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.</p>
937
+ * @public
938
938
  */
939
939
  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
940
940
  /**
941
- * @public
942
941
  * <p>The description of the configured audience model.</p>
942
+ * @public
943
943
  */
944
944
  description?: string;
945
945
  /**
946
- * @public
947
946
  * <p>Whether audience metrics are shared.</p>
947
+ * @public
948
948
  */
949
949
  sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
950
950
  /**
951
- * @public
952
951
  * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
952
+ * @public
953
953
  */
954
954
  minMatchingSeedSize?: number;
955
955
  /**
956
- * @public
957
956
  * <p>Configure the list of output sizes of audiences that can be created using this configured audience model. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
958
957
  * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
959
958
  * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
959
+ * @public
960
960
  */
961
961
  audienceSizeConfig?: AudienceSizeConfig;
962
962
  /**
963
- * @public
964
963
  * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
965
964
  * <p>The following basic restrictions apply to tags:</p>
966
965
  * <ul>
@@ -986,12 +985,13 @@ export interface CreateConfiguredAudienceModelRequest {
986
985
  * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
987
986
  * </li>
988
987
  * </ul>
988
+ * @public
989
989
  */
990
990
  tags?: Record<string, string>;
991
991
  /**
992
- * @public
993
992
  * <p>Configure how the service tags audience generation jobs created using this configured audience model. If you specify <code>NONE</code>, the tags from the <a>StartAudienceGenerationJob</a> request determine the tags of the audience generation job. If you specify <code>FROM_PARENT_RESOURCE</code>, the audience generation job inherits the tags from the configured audience model, by default. Tags in the <a>StartAudienceGenerationJob</a> will override the default.</p>
994
993
  * <p>When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.</p>
994
+ * @public
995
995
  */
996
996
  childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
997
997
  }
@@ -1000,8 +1000,8 @@ export interface CreateConfiguredAudienceModelRequest {
1000
1000
  */
1001
1001
  export interface CreateConfiguredAudienceModelResponse {
1002
1002
  /**
1003
- * @public
1004
1003
  * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1004
+ * @public
1005
1005
  */
1006
1006
  configuredAudienceModelArn: string | undefined;
1007
1007
  }
@@ -1010,8 +1010,8 @@ export interface CreateConfiguredAudienceModelResponse {
1010
1010
  */
1011
1011
  export interface DeleteConfiguredAudienceModelRequest {
1012
1012
  /**
1013
- * @public
1014
1013
  * <p>The Amazon Resource Name (ARN) of the configured audience model that you want to delete.</p>
1014
+ * @public
1015
1015
  */
1016
1016
  configuredAudienceModelArn: string | undefined;
1017
1017
  }
@@ -1020,8 +1020,8 @@ export interface DeleteConfiguredAudienceModelRequest {
1020
1020
  */
1021
1021
  export interface GetConfiguredAudienceModelRequest {
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  configuredAudienceModelArn: string | undefined;
1027
1027
  }
@@ -1041,70 +1041,70 @@ export type ConfiguredAudienceModelStatus = (typeof ConfiguredAudienceModelStatu
1041
1041
  */
1042
1042
  export interface GetConfiguredAudienceModelResponse {
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>The time at which the configured audience model was created.</p>
1045
+ * @public
1046
1046
  */
1047
1047
  createTime: Date | undefined;
1048
1048
  /**
1049
- * @public
1050
1049
  * <p>The most recent time at which the configured audience model was updated.</p>
1050
+ * @public
1051
1051
  */
1052
1052
  updateTime: Date | undefined;
1053
1053
  /**
1054
- * @public
1055
1054
  * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1055
+ * @public
1056
1056
  */
1057
1057
  configuredAudienceModelArn: string | undefined;
1058
1058
  /**
1059
- * @public
1060
1059
  * <p>The name of the configured audience model.</p>
1060
+ * @public
1061
1061
  */
1062
1062
  name: string | undefined;
1063
1063
  /**
1064
- * @public
1065
1064
  * <p>The Amazon Resource Name (ARN) of the audience model used for this configured audience model.</p>
1065
+ * @public
1066
1066
  */
1067
1067
  audienceModelArn: string | undefined;
1068
1068
  /**
1069
- * @public
1070
1069
  * <p>The output configuration of the configured audience model</p>
1070
+ * @public
1071
1071
  */
1072
1072
  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
1073
1073
  /**
1074
- * @public
1075
1074
  * <p>The description of the configured audience model.</p>
1075
+ * @public
1076
1076
  */
1077
1077
  description?: string;
1078
1078
  /**
1079
- * @public
1080
1079
  * <p>The status of the configured audience model.</p>
1080
+ * @public
1081
1081
  */
1082
1082
  status: ConfiguredAudienceModelStatus | undefined;
1083
1083
  /**
1084
- * @public
1085
1084
  * <p>Whether audience metrics are shared.</p>
1085
+ * @public
1086
1086
  */
1087
1087
  sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
1088
1088
  /**
1089
- * @public
1090
1089
  * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
1090
+ * @public
1091
1091
  */
1092
1092
  minMatchingSeedSize?: number;
1093
1093
  /**
1094
- * @public
1095
1094
  * <p>The list of output sizes of audiences that can be created using this configured audience model. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
1096
1095
  * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
1097
1096
  * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
1097
+ * @public
1098
1098
  */
1099
1099
  audienceSizeConfig?: AudienceSizeConfig;
1100
1100
  /**
1101
- * @public
1102
1101
  * <p>The tags that are associated to this configured audience model.</p>
1102
+ * @public
1103
1103
  */
1104
1104
  tags?: Record<string, string>;
1105
1105
  /**
1106
- * @public
1107
1106
  * <p>Provides the <code>childResourceTagOnCreatePolicy</code> that was used for this configured audience model.</p>
1107
+ * @public
1108
1108
  */
1109
1109
  childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
1110
1110
  }
@@ -1113,59 +1113,59 @@ export interface GetConfiguredAudienceModelResponse {
1113
1113
  */
1114
1114
  export interface ListConfiguredAudienceModelsRequest {
1115
1115
  /**
1116
- * @public
1117
1116
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
1117
+ * @public
1118
1118
  */
1119
1119
  nextToken?: string;
1120
1120
  /**
1121
- * @public
1122
1121
  * <p>The maximum size of the results that is returned per call.</p>
1122
+ * @public
1123
1123
  */
1124
1124
  maxResults?: number;
1125
1125
  }
1126
1126
  /**
1127
- * @public
1128
1127
  * <p>Information about the configured audience model.</p>
1128
+ * @public
1129
1129
  */
1130
1130
  export interface ConfiguredAudienceModelSummary {
1131
1131
  /**
1132
- * @public
1133
1132
  * <p>The time at which the configured audience model was created.</p>
1133
+ * @public
1134
1134
  */
1135
1135
  createTime: Date | undefined;
1136
1136
  /**
1137
- * @public
1138
1137
  * <p>The most recent time at which the configured audience model was updated.</p>
1138
+ * @public
1139
1139
  */
1140
1140
  updateTime: Date | undefined;
1141
1141
  /**
1142
- * @public
1143
1142
  * <p>The name of the configured audience model.</p>
1143
+ * @public
1144
1144
  */
1145
1145
  name: string | undefined;
1146
1146
  /**
1147
- * @public
1148
1147
  * <p>The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  audienceModelArn: string | undefined;
1151
1151
  /**
1152
- * @public
1153
1152
  * <p>The output configuration of the configured audience model.</p>
1153
+ * @public
1154
1154
  */
1155
1155
  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
1156
1156
  /**
1157
- * @public
1158
1157
  * <p>The description of the configured audience model.</p>
1158
+ * @public
1159
1159
  */
1160
1160
  description?: string;
1161
1161
  /**
1162
- * @public
1163
1162
  * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1163
+ * @public
1164
1164
  */
1165
1165
  configuredAudienceModelArn: string | undefined;
1166
1166
  /**
1167
- * @public
1168
1167
  * <p>The status of the configured audience model.</p>
1168
+ * @public
1169
1169
  */
1170
1170
  status: ConfiguredAudienceModelStatus | undefined;
1171
1171
  }
@@ -1174,13 +1174,13 @@ export interface ConfiguredAudienceModelSummary {
1174
1174
  */
1175
1175
  export interface ListConfiguredAudienceModelsResponse {
1176
1176
  /**
1177
- * @public
1178
1177
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
1178
+ * @public
1179
1179
  */
1180
1180
  nextToken?: string;
1181
1181
  /**
1182
- * @public
1183
1182
  * <p>The configured audience models.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  configuredAudienceModels: ConfiguredAudienceModelSummary[] | undefined;
1186
1186
  }
@@ -1189,38 +1189,38 @@ export interface ListConfiguredAudienceModelsResponse {
1189
1189
  */
1190
1190
  export interface UpdateConfiguredAudienceModelRequest {
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The Amazon Resource Name (ARN) of the configured audience model that you want to update.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  configuredAudienceModelArn: string | undefined;
1196
1196
  /**
1197
- * @public
1198
1197
  * <p>The new output configuration.</p>
1198
+ * @public
1199
1199
  */
1200
1200
  outputConfig?: ConfiguredAudienceModelOutputConfig;
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>The Amazon Resource Name (ARN) of the new audience model that you want to use.</p>
1203
+ * @public
1204
1204
  */
1205
1205
  audienceModelArn?: string;
1206
1206
  /**
1207
- * @public
1208
1207
  * <p>The new value for whether to share audience metrics.</p>
1208
+ * @public
1209
1209
  */
1210
1210
  sharedAudienceMetrics?: SharedAudienceMetrics[];
1211
1211
  /**
1212
- * @public
1213
1212
  * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
1213
+ * @public
1214
1214
  */
1215
1215
  minMatchingSeedSize?: number;
1216
1216
  /**
1217
- * @public
1218
1217
  * <p>The new audience size configuration.</p>
1218
+ * @public
1219
1219
  */
1220
1220
  audienceSizeConfig?: AudienceSizeConfig;
1221
1221
  /**
1222
- * @public
1223
1222
  * <p>The new description of the configured audience model.</p>
1223
+ * @public
1224
1224
  */
1225
1225
  description?: string;
1226
1226
  }
@@ -1229,8 +1229,8 @@ export interface UpdateConfiguredAudienceModelRequest {
1229
1229
  */
1230
1230
  export interface UpdateConfiguredAudienceModelResponse {
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>The Amazon Resource Name (ARN) of the configured audience model that was updated.</p>
1233
+ * @public
1234
1234
  */
1235
1235
  configuredAudienceModelArn: string | undefined;
1236
1236
  }
@@ -1239,8 +1239,8 @@ export interface UpdateConfiguredAudienceModelResponse {
1239
1239
  */
1240
1240
  export interface DeleteConfiguredAudienceModelPolicyRequest {
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.</p>
1243
+ * @public
1244
1244
  */
1245
1245
  configuredAudienceModelArn: string | undefined;
1246
1246
  }
@@ -1249,8 +1249,8 @@ export interface DeleteConfiguredAudienceModelPolicyRequest {
1249
1249
  */
1250
1250
  export interface GetConfiguredAudienceModelPolicyRequest {
1251
1251
  /**
1252
- * @public
1253
1252
  * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1253
+ * @public
1254
1254
  */
1255
1255
  configuredAudienceModelArn: string | undefined;
1256
1256
  }
@@ -1259,18 +1259,18 @@ export interface GetConfiguredAudienceModelPolicyRequest {
1259
1259
  */
1260
1260
  export interface GetConfiguredAudienceModelPolicyResponse {
1261
1261
  /**
1262
- * @public
1263
1262
  * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1263
+ * @public
1264
1264
  */
1265
1265
  configuredAudienceModelArn: string | undefined;
1266
1266
  /**
1267
- * @public
1268
1267
  * <p>The configured audience model policy. This is a JSON IAM resource policy.</p>
1268
+ * @public
1269
1269
  */
1270
1270
  configuredAudienceModelPolicy: string | undefined;
1271
1271
  /**
1272
- * @public
1273
1272
  * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1273
+ * @public
1274
1274
  */
1275
1275
  policyHash: string | undefined;
1276
1276
  }
@@ -1291,23 +1291,23 @@ export type PolicyExistenceCondition = (typeof PolicyExistenceCondition)[keyof t
1291
1291
  */
1292
1292
  export interface PutConfiguredAudienceModelPolicyRequest {
1293
1293
  /**
1294
- * @public
1295
1294
  * <p>The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.</p>
1295
+ * @public
1296
1296
  */
1297
1297
  configuredAudienceModelArn: string | undefined;
1298
1298
  /**
1299
- * @public
1300
1299
  * <p>The IAM resource policy.</p>
1300
+ * @public
1301
1301
  */
1302
1302
  configuredAudienceModelPolicy: string | undefined;
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  previousPolicyHash?: string;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>Use this to prevent unexpected concurrent modification of the policy.</p>
1310
+ * @public
1311
1311
  */
1312
1312
  policyExistenceCondition?: PolicyExistenceCondition;
1313
1313
  }
@@ -1316,13 +1316,13 @@ export interface PutConfiguredAudienceModelPolicyRequest {
1316
1316
  */
1317
1317
  export interface PutConfiguredAudienceModelPolicyResponse {
1318
1318
  /**
1319
- * @public
1320
1319
  * <p>The IAM resource policy.</p>
1320
+ * @public
1321
1321
  */
1322
1322
  configuredAudienceModelPolicy: string | undefined;
1323
1323
  /**
1324
- * @public
1325
1324
  * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1325
+ * @public
1326
1326
  */
1327
1327
  policyHash: string | undefined;
1328
1328
  }
@@ -1331,8 +1331,8 @@ export interface PutConfiguredAudienceModelPolicyResponse {
1331
1331
  */
1332
1332
  export interface ListTagsForResourceRequest {
1333
1333
  /**
1334
- * @public
1335
1334
  * <p>The Amazon Resource Name (ARN) of the resource that you are interested in.</p>
1335
+ * @public
1336
1336
  */
1337
1337
  resourceArn: string | undefined;
1338
1338
  }
@@ -1341,8 +1341,8 @@ export interface ListTagsForResourceRequest {
1341
1341
  */
1342
1342
  export interface ListTagsForResourceResponse {
1343
1343
  /**
1344
- * @public
1345
1344
  * <p>The tags that are associated with the resource.</p>
1345
+ * @public
1346
1346
  */
1347
1347
  tags: Record<string, string> | undefined;
1348
1348
  }
@@ -1351,12 +1351,11 @@ export interface ListTagsForResourceResponse {
1351
1351
  */
1352
1352
  export interface TagResourceRequest {
1353
1353
  /**
1354
- * @public
1355
1354
  * <p>The Amazon Resource Name (ARN) of the resource that you want to assign tags.</p>
1355
+ * @public
1356
1356
  */
1357
1357
  resourceArn: string | undefined;
1358
1358
  /**
1359
- * @public
1360
1359
  * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
1361
1360
  * <p>The following basic restrictions apply to tags:</p>
1362
1361
  * <ul>
@@ -1382,6 +1381,7 @@ export interface TagResourceRequest {
1382
1381
  * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
1383
1382
  * </li>
1384
1383
  * </ul>
1384
+ * @public
1385
1385
  */
1386
1386
  tags: Record<string, string> | undefined;
1387
1387
  }
@@ -1391,34 +1391,34 @@ export interface TagResourceRequest {
1391
1391
  export interface TagResourceResponse {
1392
1392
  }
1393
1393
  /**
1394
- * @public
1395
1394
  * <p>Defines the Glue data source that contains the training data.</p>
1395
+ * @public
1396
1396
  */
1397
1397
  export interface GlueDataSource {
1398
1398
  /**
1399
- * @public
1400
1399
  * <p>The Glue table that contains the training data.</p>
1400
+ * @public
1401
1401
  */
1402
1402
  tableName: string | undefined;
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The Glue database that contains the training data.</p>
1405
+ * @public
1406
1406
  */
1407
1407
  databaseName: string | undefined;
1408
1408
  /**
1409
- * @public
1410
1409
  * <p>The Glue catalog that contains the training data.</p>
1410
+ * @public
1411
1411
  */
1412
1412
  catalogId?: string;
1413
1413
  }
1414
1414
  /**
1415
- * @public
1416
1415
  * <p>Defines information about the Glue data source that contains the training data.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  export interface DataSource {
1419
1419
  /**
1420
- * @public
1421
1420
  * <p>A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.</p>
1421
+ * @public
1422
1422
  */
1423
1423
  glueDataSource: GlueDataSource | undefined;
1424
1424
  }
@@ -1438,34 +1438,34 @@ export declare const ColumnType: {
1438
1438
  */
1439
1439
  export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
1440
1440
  /**
1441
- * @public
1442
1441
  * <p>Metadata for a column.</p>
1442
+ * @public
1443
1443
  */
1444
1444
  export interface ColumnSchema {
1445
1445
  /**
1446
- * @public
1447
1446
  * <p>The name of a column.</p>
1447
+ * @public
1448
1448
  */
1449
1449
  columnName: string | undefined;
1450
1450
  /**
1451
- * @public
1452
1451
  * <p>The data type of column.</p>
1452
+ * @public
1453
1453
  */
1454
1454
  columnTypes: ColumnType[] | undefined;
1455
1455
  }
1456
1456
  /**
1457
- * @public
1458
1457
  * <p>Defines the Glue data source and schema mapping information.</p>
1458
+ * @public
1459
1459
  */
1460
1460
  export interface DatasetInputConfig {
1461
1461
  /**
1462
- * @public
1463
1462
  * <p>The schema information for the training data.</p>
1463
+ * @public
1464
1464
  */
1465
1465
  schema: ColumnSchema[] | undefined;
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>A DataSource object that specifies the Glue data source for the training data.</p>
1468
+ * @public
1469
1469
  */
1470
1470
  dataSource: DataSource | undefined;
1471
1471
  }
@@ -1481,18 +1481,18 @@ export declare const DatasetType: {
1481
1481
  */
1482
1482
  export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
1483
1483
  /**
1484
- * @public
1485
1484
  * <p>Defines where the training dataset is located, what type of data it contains, and how to access the data.</p>
1485
+ * @public
1486
1486
  */
1487
1487
  export interface Dataset {
1488
1488
  /**
1489
- * @public
1490
1489
  * <p>What type of information is found in the dataset.</p>
1490
+ * @public
1491
1491
  */
1492
1492
  type: DatasetType | undefined;
1493
1493
  /**
1494
- * @public
1495
1494
  * <p>A DatasetInputConfig object that defines the data source and schema mapping.</p>
1495
+ * @public
1496
1496
  */
1497
1497
  inputConfig: DatasetInputConfig | undefined;
1498
1498
  }
@@ -1501,23 +1501,22 @@ export interface Dataset {
1501
1501
  */
1502
1502
  export interface CreateTrainingDatasetRequest {
1503
1503
  /**
1504
- * @public
1505
1504
  * <p>The name of the training dataset. This name must be unique in your account and region.</p>
1505
+ * @public
1506
1506
  */
1507
1507
  name: string | undefined;
1508
1508
  /**
1509
- * @public
1510
1509
  * <p>The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the <code>dataSource</code> field of each dataset.</p>
1511
1510
  * <p>Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an <code>AccessDeniedException</code> error.</p>
1511
+ * @public
1512
1512
  */
1513
1513
  roleArn: string | undefined;
1514
1514
  /**
1515
- * @public
1516
1515
  * <p>An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.</p>
1516
+ * @public
1517
1517
  */
1518
1518
  trainingData: Dataset[] | undefined;
1519
1519
  /**
1520
- * @public
1521
1520
  * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
1522
1521
  * <p>The following basic restrictions apply to tags:</p>
1523
1522
  * <ul>
@@ -1543,11 +1542,12 @@ export interface CreateTrainingDatasetRequest {
1543
1542
  * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
1544
1543
  * </li>
1545
1544
  * </ul>
1545
+ * @public
1546
1546
  */
1547
1547
  tags?: Record<string, string>;
1548
1548
  /**
1549
- * @public
1550
1549
  * <p>The description of the training dataset.</p>
1550
+ * @public
1551
1551
  */
1552
1552
  description?: string;
1553
1553
  }
@@ -1556,8 +1556,8 @@ export interface CreateTrainingDatasetRequest {
1556
1556
  */
1557
1557
  export interface CreateTrainingDatasetResponse {
1558
1558
  /**
1559
- * @public
1560
1559
  * <p>The Amazon Resource Name (ARN) of the training dataset resource.</p>
1560
+ * @public
1561
1561
  */
1562
1562
  trainingDatasetArn: string | undefined;
1563
1563
  }
@@ -1566,8 +1566,8 @@ export interface CreateTrainingDatasetResponse {
1566
1566
  */
1567
1567
  export interface DeleteTrainingDatasetRequest {
1568
1568
  /**
1569
- * @public
1570
1569
  * <p>The Amazon Resource Name (ARN) of the training dataset that you want to delete.</p>
1570
+ * @public
1571
1571
  */
1572
1572
  trainingDatasetArn: string | undefined;
1573
1573
  }
@@ -1576,8 +1576,8 @@ export interface DeleteTrainingDatasetRequest {
1576
1576
  */
1577
1577
  export interface GetTrainingDatasetRequest {
1578
1578
  /**
1579
- * @public
1580
1579
  * <p>The Amazon Resource Name (ARN) of the training dataset that you are interested in.</p>
1580
+ * @public
1581
1581
  */
1582
1582
  trainingDatasetArn: string | undefined;
1583
1583
  }
@@ -1597,48 +1597,48 @@ export type TrainingDatasetStatus = (typeof TrainingDatasetStatus)[keyof typeof
1597
1597
  */
1598
1598
  export interface GetTrainingDatasetResponse {
1599
1599
  /**
1600
- * @public
1601
1600
  * <p>The time at which the training dataset was created.</p>
1601
+ * @public
1602
1602
  */
1603
1603
  createTime: Date | undefined;
1604
1604
  /**
1605
- * @public
1606
1605
  * <p>The most recent time at which the training dataset was updated.</p>
1606
+ * @public
1607
1607
  */
1608
1608
  updateTime: Date | undefined;
1609
1609
  /**
1610
- * @public
1611
1610
  * <p>The Amazon Resource Name (ARN) of the training dataset.</p>
1611
+ * @public
1612
1612
  */
1613
1613
  trainingDatasetArn: string | undefined;
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>The name of the training dataset.</p>
1616
+ * @public
1617
1617
  */
1618
1618
  name: string | undefined;
1619
1619
  /**
1620
- * @public
1621
1620
  * <p>Metadata about the requested training data. </p>
1621
+ * @public
1622
1622
  */
1623
1623
  trainingData: Dataset[] | undefined;
1624
1624
  /**
1625
- * @public
1626
1625
  * <p>The status of the training dataset.</p>
1626
+ * @public
1627
1627
  */
1628
1628
  status: TrainingDatasetStatus | undefined;
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>The IAM role used to read the training data.</p>
1631
+ * @public
1632
1632
  */
1633
1633
  roleArn: string | undefined;
1634
1634
  /**
1635
- * @public
1636
1635
  * <p>The tags that are assigned to this training dataset.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  tags?: Record<string, string>;
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The description of the training dataset.</p>
1641
+ * @public
1642
1642
  */
1643
1643
  description?: string;
1644
1644
  }
@@ -1647,49 +1647,49 @@ export interface GetTrainingDatasetResponse {
1647
1647
  */
1648
1648
  export interface ListTrainingDatasetsRequest {
1649
1649
  /**
1650
- * @public
1651
1650
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
1651
+ * @public
1652
1652
  */
1653
1653
  nextToken?: string;
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>The maximum size of the results that is returned per call.</p>
1656
+ * @public
1657
1657
  */
1658
1658
  maxResults?: number;
1659
1659
  }
1660
1660
  /**
1661
- * @public
1662
1661
  * <p>Provides information about the training dataset.</p>
1662
+ * @public
1663
1663
  */
1664
1664
  export interface TrainingDatasetSummary {
1665
1665
  /**
1666
- * @public
1667
1666
  * <p>The time at which the training dataset was created.</p>
1667
+ * @public
1668
1668
  */
1669
1669
  createTime: Date | undefined;
1670
1670
  /**
1671
- * @public
1672
1671
  * <p>The most recent time at which the training dataset was updated.</p>
1672
+ * @public
1673
1673
  */
1674
1674
  updateTime: Date | undefined;
1675
1675
  /**
1676
- * @public
1677
1676
  * <p>The Amazon Resource Name (ARN) of the training dataset.</p>
1677
+ * @public
1678
1678
  */
1679
1679
  trainingDatasetArn: string | undefined;
1680
1680
  /**
1681
- * @public
1682
1681
  * <p>The name of the training dataset.</p>
1682
+ * @public
1683
1683
  */
1684
1684
  name: string | undefined;
1685
1685
  /**
1686
- * @public
1687
1686
  * <p>The status of the training dataset.</p>
1687
+ * @public
1688
1688
  */
1689
1689
  status: TrainingDatasetStatus | undefined;
1690
1690
  /**
1691
- * @public
1692
1691
  * <p>The description of the training dataset.</p>
1692
+ * @public
1693
1693
  */
1694
1694
  description?: string;
1695
1695
  }
@@ -1698,13 +1698,13 @@ export interface TrainingDatasetSummary {
1698
1698
  */
1699
1699
  export interface ListTrainingDatasetsResponse {
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>The token value retrieved from a previous call to access the next page of results.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  nextToken?: string;
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>The training datasets that match the request.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  trainingDatasets: TrainingDatasetSummary[] | undefined;
1710
1710
  }
@@ -1713,13 +1713,13 @@ export interface ListTrainingDatasetsResponse {
1713
1713
  */
1714
1714
  export interface UntagResourceRequest {
1715
1715
  /**
1716
- * @public
1717
1716
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  resourceArn: string | undefined;
1720
1720
  /**
1721
- * @public
1722
1721
  * <p>The key values of tags that you want to remove.</p>
1722
+ * @public
1723
1723
  */
1724
1724
  tagKeys: string[] | undefined;
1725
1725
  }