aws-sdk-cleanroomsml 1.9.0 → 1.10.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.
@@ -39,6 +39,18 @@ module Aws::CleanRoomsML
39
39
 
40
40
  # Provides information about the audience export job.
41
41
  #
42
+ # @!attribute [rw] create_time
43
+ # The time at which the audience export job was created.
44
+ # @return [Time]
45
+ #
46
+ # @!attribute [rw] update_time
47
+ # The most recent time at which the audience export job was updated.
48
+ # @return [Time]
49
+ #
50
+ # @!attribute [rw] name
51
+ # The name of the audience export job.
52
+ # @return [String]
53
+ #
42
54
  # @!attribute [rw] audience_generation_job_arn
43
55
  # The Amazon Resource Name (ARN) of the audience generation job that
44
56
  # was exported.
@@ -49,22 +61,10 @@ module Aws::CleanRoomsML
49
61
  # the configured audience model.
50
62
  # @return [Types::AudienceSize]
51
63
  #
52
- # @!attribute [rw] create_time
53
- # The time at which the audience export job was created.
54
- # @return [Time]
55
- #
56
64
  # @!attribute [rw] description
57
65
  # The description of the audience export job.
58
66
  # @return [String]
59
67
  #
60
- # @!attribute [rw] name
61
- # The name of the audience export job.
62
- # @return [String]
63
- #
64
- # @!attribute [rw] output_location
65
- # The Amazon S3 bucket where the audience export is stored.
66
- # @return [String]
67
- #
68
68
  # @!attribute [rw] status
69
69
  # The status of the audience export job.
70
70
  # @return [String]
@@ -73,22 +73,22 @@ module Aws::CleanRoomsML
73
73
  # Details about the status of a resource.
74
74
  # @return [Types::StatusDetails]
75
75
  #
76
- # @!attribute [rw] update_time
77
- # The most recent time at which the audience export job was updated.
78
- # @return [Time]
76
+ # @!attribute [rw] output_location
77
+ # The Amazon S3 bucket where the audience export is stored.
78
+ # @return [String]
79
79
  #
80
80
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceExportJobSummary AWS API Documentation
81
81
  #
82
82
  class AudienceExportJobSummary < Struct.new(
83
+ :create_time,
84
+ :update_time,
85
+ :name,
83
86
  :audience_generation_job_arn,
84
87
  :audience_size,
85
- :create_time,
86
88
  :description,
87
- :name,
88
- :output_location,
89
89
  :status,
90
90
  :status_details,
91
- :update_time)
91
+ :output_location)
92
92
  SENSITIVE = []
93
93
  include Aws::Structure
94
94
  end
@@ -110,122 +110,131 @@ module Aws::CleanRoomsML
110
110
  #
111
111
  # @!attribute [rw] role_arn
112
112
  # The ARN of the IAM role that can read the Amazon S3 bucket where the
113
- # training data is stored.
113
+ # seed audience is stored.
114
114
  # @return [String]
115
115
  #
116
+ # @!attribute [rw] sql_parameters
117
+ # The protected SQL query parameters.
118
+ # @return [Types::ProtectedQuerySQLParameters]
119
+ #
116
120
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceGenerationJobDataSource AWS API Documentation
117
121
  #
118
122
  class AudienceGenerationJobDataSource < Struct.new(
119
123
  :data_source,
120
- :role_arn)
121
- SENSITIVE = []
124
+ :role_arn,
125
+ :sql_parameters)
126
+ SENSITIVE = [:sql_parameters]
122
127
  include Aws::Structure
123
128
  end
124
129
 
125
130
  # Provides information about the configured audience generation job.
126
131
  #
127
- # @!attribute [rw] audience_generation_job_arn
128
- # The Amazon Resource Name (ARN) of the audience generation job.
129
- # @return [String]
130
- #
131
- # @!attribute [rw] collaboration_id
132
- # The identifier of the collaboration that contains this audience
133
- # generation job.
134
- # @return [String]
135
- #
136
- # @!attribute [rw] configured_audience_model_arn
137
- # The Amazon Resource Name (ARN) of the configured audience model that
138
- # was used for this audience generation job.
139
- # @return [String]
140
- #
141
132
  # @!attribute [rw] create_time
142
133
  # The time at which the audience generation job was created.
143
134
  # @return [Time]
144
135
  #
145
- # @!attribute [rw] description
146
- # The description of the audience generation job.
136
+ # @!attribute [rw] update_time
137
+ # The most recent time at which the audience generation job was
138
+ # updated.
139
+ # @return [Time]
140
+ #
141
+ # @!attribute [rw] audience_generation_job_arn
142
+ # The Amazon Resource Name (ARN) of the audience generation job.
147
143
  # @return [String]
148
144
  #
149
145
  # @!attribute [rw] name
150
146
  # The name of the audience generation job.
151
147
  # @return [String]
152
148
  #
153
- # @!attribute [rw] started_by
154
- # The AWS Account that submitted the job.
149
+ # @!attribute [rw] description
150
+ # The description of the audience generation job.
155
151
  # @return [String]
156
152
  #
157
153
  # @!attribute [rw] status
158
154
  # The status of the audience generation job.
159
155
  # @return [String]
160
156
  #
161
- # @!attribute [rw] update_time
162
- # The most recent time at which the audience generation job was
163
- # updated.
164
- # @return [Time]
157
+ # @!attribute [rw] configured_audience_model_arn
158
+ # The Amazon Resource Name (ARN) of the configured audience model that
159
+ # was used for this audience generation job.
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] collaboration_id
163
+ # The identifier of the collaboration that contains this audience
164
+ # generation job.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] started_by
168
+ # The AWS Account that submitted the job.
169
+ # @return [String]
165
170
  #
166
171
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceGenerationJobSummary AWS API Documentation
167
172
  #
168
173
  class AudienceGenerationJobSummary < Struct.new(
169
- :audience_generation_job_arn,
170
- :collaboration_id,
171
- :configured_audience_model_arn,
172
174
  :create_time,
173
- :description,
175
+ :update_time,
176
+ :audience_generation_job_arn,
174
177
  :name,
175
- :started_by,
178
+ :description,
176
179
  :status,
177
- :update_time)
180
+ :configured_audience_model_arn,
181
+ :collaboration_id,
182
+ :started_by)
178
183
  SENSITIVE = []
179
184
  include Aws::Structure
180
185
  end
181
186
 
182
187
  # Information about the audience model.
183
188
  #
184
- # @!attribute [rw] audience_model_arn
185
- # The Amazon Resource Name (ARN) of the audience model.
186
- # @return [String]
187
- #
188
189
  # @!attribute [rw] create_time
189
190
  # The time at which the audience model was created.
190
191
  # @return [Time]
191
192
  #
192
- # @!attribute [rw] description
193
- # The description of the audience model.
193
+ # @!attribute [rw] update_time
194
+ # The most recent time at which the audience model was updated.
195
+ # @return [Time]
196
+ #
197
+ # @!attribute [rw] audience_model_arn
198
+ # The Amazon Resource Name (ARN) of the audience model.
194
199
  # @return [String]
195
200
  #
196
201
  # @!attribute [rw] name
197
202
  # The name of the audience model.
198
203
  # @return [String]
199
204
  #
200
- # @!attribute [rw] status
201
- # The status of the audience model.
202
- # @return [String]
203
- #
204
205
  # @!attribute [rw] training_dataset_arn
205
206
  # The Amazon Resource Name (ARN) of the training dataset that was used
206
207
  # for the audience model.
207
208
  # @return [String]
208
209
  #
209
- # @!attribute [rw] update_time
210
- # The most recent time at which the audience model was updated.
211
- # @return [Time]
210
+ # @!attribute [rw] status
211
+ # The status of the audience model.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] description
215
+ # The description of the audience model.
216
+ # @return [String]
212
217
  #
213
218
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceModelSummary AWS API Documentation
214
219
  #
215
220
  class AudienceModelSummary < Struct.new(
216
- :audience_model_arn,
217
221
  :create_time,
218
- :description,
222
+ :update_time,
223
+ :audience_model_arn,
219
224
  :name,
220
- :status,
221
225
  :training_dataset_arn,
222
- :update_time)
226
+ :status,
227
+ :description)
223
228
  SENSITIVE = []
224
229
  include Aws::Structure
225
230
  end
226
231
 
227
232
  # Metrics that describe the quality of the generated audience.
228
233
  #
234
+ # @!attribute [rw] relevance_metrics
235
+ # The relevance scores of the generated audience.
236
+ # @return [Array<Types::RelevanceMetric>]
237
+ #
229
238
  # @!attribute [rw] recall_metric
230
239
  # The recall score of the generated audience. Recall is the percentage
231
240
  # of the most similar users (by default, the most similar 20%) from a
@@ -236,15 +245,11 @@ module Aws::CleanRoomsML
236
245
  # to random selection.
237
246
  # @return [Float]
238
247
  #
239
- # @!attribute [rw] relevance_metrics
240
- # The relevance scores of the generated audience.
241
- # @return [Array<Types::RelevanceMetric>]
242
- #
243
248
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceQualityMetrics AWS API Documentation
244
249
  #
245
250
  class AudienceQualityMetrics < Struct.new(
246
- :recall_metric,
247
- :relevance_metrics)
251
+ :relevance_metrics,
252
+ :recall_metric)
248
253
  SENSITIVE = []
249
254
  include Aws::Structure
250
255
  end
@@ -273,28 +278,30 @@ module Aws::CleanRoomsML
273
278
  include Aws::Structure
274
279
  end
275
280
 
276
- # Configure the list of audience output sizes that can be created. A
277
- # request to StartAudienceGenerationJob that uses this configured
278
- # audience model must have an `audienceSize` selected from this list.
279
- # You can use the `ABSOLUTE` AudienceSize to configure out audience
280
- # sizes using the count of identifiers in the output. You can use the
281
- # `Percentage` AudienceSize to configure sizes in the range 1-100
282
- # percent.
281
+ # Returns the relevance scores at these audience sizes when used in the
282
+ # GetAudienceGenerationJob for a specified audience generation job and
283
+ # configured audience model.
283
284
  #
284
- # @!attribute [rw] audience_size_bins
285
- # An array of the different audience output sizes.
286
- # @return [Array<Integer>]
285
+ # Specifies the list of allowed `audienceSize` values when used in the
286
+ # StartAudienceExportJob for an audience generation job. You can use the
287
+ # `ABSOLUTE` AudienceSize to configure out audience sizes using the
288
+ # count of identifiers in the output. You can use the `Percentage`
289
+ # AudienceSize to configure sizes in the range 1-100 percent.
287
290
  #
288
291
  # @!attribute [rw] audience_size_type
289
292
  # Whether the audience output sizes are defined as an absolute number
290
293
  # or a percentage.
291
294
  # @return [String]
292
295
  #
296
+ # @!attribute [rw] audience_size_bins
297
+ # An array of the different audience output sizes.
298
+ # @return [Array<Integer>]
299
+ #
293
300
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceSizeConfig AWS API Documentation
294
301
  #
295
302
  class AudienceSizeConfig < Struct.new(
296
- :audience_size_bins,
297
- :audience_size_type)
303
+ :audience_size_type,
304
+ :audience_size_bins)
298
305
  SENSITIVE = []
299
306
  include Aws::Structure
300
307
  end
@@ -341,52 +348,52 @@ module Aws::CleanRoomsML
341
348
 
342
349
  # Information about the configured audience model.
343
350
  #
344
- # @!attribute [rw] audience_model_arn
345
- # The Amazon Resource Name (ARN) of the audience model that was used
346
- # to create the configured audience model.
347
- # @return [String]
348
- #
349
- # @!attribute [rw] configured_audience_model_arn
350
- # The Amazon Resource Name (ARN) of the configured audience model that
351
- # you are interested in.
352
- # @return [String]
353
- #
354
351
  # @!attribute [rw] create_time
355
352
  # The time at which the configured audience model was created.
356
353
  # @return [Time]
357
354
  #
358
- # @!attribute [rw] description
359
- # The description of the configured audience model.
360
- # @return [String]
355
+ # @!attribute [rw] update_time
356
+ # The most recent time at which the configured audience model was
357
+ # updated.
358
+ # @return [Time]
361
359
  #
362
360
  # @!attribute [rw] name
363
361
  # The name of the configured audience model.
364
362
  # @return [String]
365
363
  #
364
+ # @!attribute [rw] audience_model_arn
365
+ # The Amazon Resource Name (ARN) of the audience model that was used
366
+ # to create the configured audience model.
367
+ # @return [String]
368
+ #
366
369
  # @!attribute [rw] output_config
367
370
  # The output configuration of the configured audience model.
368
371
  # @return [Types::ConfiguredAudienceModelOutputConfig]
369
372
  #
373
+ # @!attribute [rw] description
374
+ # The description of the configured audience model.
375
+ # @return [String]
376
+ #
377
+ # @!attribute [rw] configured_audience_model_arn
378
+ # The Amazon Resource Name (ARN) of the configured audience model that
379
+ # you are interested in.
380
+ # @return [String]
381
+ #
370
382
  # @!attribute [rw] status
371
383
  # The status of the configured audience model.
372
384
  # @return [String]
373
385
  #
374
- # @!attribute [rw] update_time
375
- # The most recent time at which the configured audience model was
376
- # updated.
377
- # @return [Time]
378
- #
379
386
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConfiguredAudienceModelSummary AWS API Documentation
380
387
  #
381
388
  class ConfiguredAudienceModelSummary < Struct.new(
382
- :audience_model_arn,
383
- :configured_audience_model_arn,
384
389
  :create_time,
385
- :description,
390
+ :update_time,
386
391
  :name,
392
+ :audience_model_arn,
387
393
  :output_config,
388
- :status,
389
- :update_time)
394
+ :description,
395
+ :configured_audience_model_arn,
396
+ :status)
390
397
  SENSITIVE = []
391
398
  include Aws::Structure
392
399
  end
@@ -405,8 +412,21 @@ module Aws::CleanRoomsML
405
412
  include Aws::Structure
406
413
  end
407
414
 
408
- # @!attribute [rw] description
409
- # The description of the audience model.
415
+ # @!attribute [rw] training_data_start_time
416
+ # The start date and time of the training window.
417
+ # @return [Time]
418
+ #
419
+ # @!attribute [rw] training_data_end_time
420
+ # The end date and time of the training window.
421
+ # @return [Time]
422
+ #
423
+ # @!attribute [rw] name
424
+ # The name of the audience model resource.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] training_dataset_arn
428
+ # The Amazon Resource Name (ARN) of the training dataset for this
429
+ # audience model.
410
430
  # @return [String]
411
431
  #
412
432
  # @!attribute [rw] kms_key_arn
@@ -415,10 +435,6 @@ module Aws::CleanRoomsML
415
435
  # the associated data.
416
436
  # @return [String]
417
437
  #
418
- # @!attribute [rw] name
419
- # The name of the audience model resource.
420
- # @return [String]
421
- #
422
438
  # @!attribute [rw] tags
423
439
  # The optional metadata that you apply to the resource to help you
424
440
  # categorize and organize them. Each tag consists of a key and an
@@ -452,29 +468,20 @@ module Aws::CleanRoomsML
452
468
  # of aws do not count against your tags per resource limit.
453
469
  # @return [Hash<String,String>]
454
470
  #
455
- # @!attribute [rw] training_data_end_time
456
- # The end date and time of the training window.
457
- # @return [Time]
458
- #
459
- # @!attribute [rw] training_data_start_time
460
- # The start date and time of the training window.
461
- # @return [Time]
462
- #
463
- # @!attribute [rw] training_dataset_arn
464
- # The Amazon Resource Name (ARN) of the training dataset for this
465
- # audience model.
471
+ # @!attribute [rw] description
472
+ # The description of the audience model.
466
473
  # @return [String]
467
474
  #
468
475
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateAudienceModelRequest AWS API Documentation
469
476
  #
470
477
  class CreateAudienceModelRequest < Struct.new(
471
- :description,
472
- :kms_key_arn,
478
+ :training_data_start_time,
479
+ :training_data_end_time,
473
480
  :name,
481
+ :training_dataset_arn,
482
+ :kms_key_arn,
474
483
  :tags,
475
- :training_data_end_time,
476
- :training_data_start_time,
477
- :training_dataset_arn)
484
+ :description)
478
485
  SENSITIVE = []
479
486
  include Aws::Structure
480
487
  end
@@ -491,11 +498,38 @@ module Aws::CleanRoomsML
491
498
  include Aws::Structure
492
499
  end
493
500
 
501
+ # @!attribute [rw] name
502
+ # The name of the configured audience model.
503
+ # @return [String]
504
+ #
494
505
  # @!attribute [rw] audience_model_arn
495
506
  # The Amazon Resource Name (ARN) of the audience model to use for the
496
507
  # configured audience model.
497
508
  # @return [String]
498
509
  #
510
+ # @!attribute [rw] output_config
511
+ # Configure the Amazon S3 location and IAM Role for audiences created
512
+ # using this configured audience model. Each audience will have a
513
+ # unique location. The IAM Role must have `s3:PutObject` permission on
514
+ # the destination Amazon S3 location. If the destination is protected
515
+ # with Amazon S3 KMS-SSE, then the Role must also have the required
516
+ # KMS permissions.
517
+ # @return [Types::ConfiguredAudienceModelOutputConfig]
518
+ #
519
+ # @!attribute [rw] description
520
+ # The description of the configured audience model.
521
+ # @return [String]
522
+ #
523
+ # @!attribute [rw] shared_audience_metrics
524
+ # Whether audience metrics are shared.
525
+ # @return [Array<String>]
526
+ #
527
+ # @!attribute [rw] min_matching_seed_size
528
+ # The minimum number of users from the seed audience that must match
529
+ # with users in the training data of the audience model. The default
530
+ # value is 500.
531
+ # @return [Integer]
532
+ #
499
533
  # @!attribute [rw] audience_size_config
500
534
  # Configure the list of output sizes of audiences that can be created
501
535
  # using this configured audience model. A request to
@@ -506,47 +540,6 @@ module Aws::CleanRoomsML
506
540
  # AudienceSize to configure sizes in the range 1-100 percent.
507
541
  # @return [Types::AudienceSizeConfig]
508
542
  #
509
- # @!attribute [rw] child_resource_tag_on_create_policy
510
- # Configure how the service tags audience generation jobs created
511
- # using this configured audience model. If you specify `NONE`, the
512
- # tags from the StartAudienceGenerationJob request determine the tags
513
- # of the audience generation job. If you specify
514
- # `FROM_PARENT_RESOURCE`, the audience generation job inherits the
515
- # tags from the configured audience model, by default. Tags in the
516
- # StartAudienceGenerationJob will override the default.
517
- #
518
- # When the client is in a different account than the configured
519
- # audience model, the tags from the client are never applied to a
520
- # resource in the caller's account.
521
- # @return [String]
522
- #
523
- # @!attribute [rw] description
524
- # The description of the configured audience model.
525
- # @return [String]
526
- #
527
- # @!attribute [rw] min_matching_seed_size
528
- # The minimum number of users from the seed audience that must match
529
- # with users in the training data of the audience model. The default
530
- # value is 500.
531
- # @return [Integer]
532
- #
533
- # @!attribute [rw] name
534
- # The name of the configured audience model.
535
- # @return [String]
536
- #
537
- # @!attribute [rw] output_config
538
- # Configure the Amazon S3 location and IAM Role for audiences created
539
- # using this configured audience model. Each audience will have a
540
- # unique location. The IAM Role must have `s3:PutObject` permission on
541
- # the destination Amazon S3 location. If the destination is protected
542
- # with Amazon S3 KMS-SSE, then the Role must also have the required
543
- # KMS permissions.
544
- # @return [Types::ConfiguredAudienceModelOutputConfig]
545
- #
546
- # @!attribute [rw] shared_audience_metrics
547
- # Whether audience metrics are shared.
548
- # @return [Array<String>]
549
- #
550
543
  # @!attribute [rw] tags
551
544
  # The optional metadata that you apply to the resource to help you
552
545
  # categorize and organize them. Each tag consists of a key and an
@@ -580,18 +573,32 @@ module Aws::CleanRoomsML
580
573
  # of aws do not count against your tags per resource limit.
581
574
  # @return [Hash<String,String>]
582
575
  #
576
+ # @!attribute [rw] child_resource_tag_on_create_policy
577
+ # Configure how the service tags audience generation jobs created
578
+ # using this configured audience model. If you specify `NONE`, the
579
+ # tags from the StartAudienceGenerationJob request determine the tags
580
+ # of the audience generation job. If you specify
581
+ # `FROM_PARENT_RESOURCE`, the audience generation job inherits the
582
+ # tags from the configured audience model, by default. Tags in the
583
+ # StartAudienceGenerationJob will override the default.
584
+ #
585
+ # When the client is in a different account than the configured
586
+ # audience model, the tags from the client are never applied to a
587
+ # resource in the caller's account.
588
+ # @return [String]
589
+ #
583
590
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModelRequest AWS API Documentation
584
591
  #
585
592
  class CreateConfiguredAudienceModelRequest < Struct.new(
586
- :audience_model_arn,
587
- :audience_size_config,
588
- :child_resource_tag_on_create_policy,
589
- :description,
590
- :min_matching_seed_size,
591
593
  :name,
594
+ :audience_model_arn,
592
595
  :output_config,
596
+ :description,
593
597
  :shared_audience_metrics,
594
- :tags)
598
+ :min_matching_seed_size,
599
+ :audience_size_config,
600
+ :tags,
601
+ :child_resource_tag_on_create_policy)
595
602
  SENSITIVE = []
596
603
  include Aws::Structure
597
604
  end
@@ -608,10 +615,6 @@ module Aws::CleanRoomsML
608
615
  include Aws::Structure
609
616
  end
610
617
 
611
- # @!attribute [rw] description
612
- # The description of the training dataset.
613
- # @return [String]
614
- #
615
618
  # @!attribute [rw] name
616
619
  # The name of the training dataset. This name must be unique in your
617
620
  # account and region.
@@ -626,6 +629,12 @@ module Aws::CleanRoomsML
626
629
  # error.
627
630
  # @return [String]
628
631
  #
632
+ # @!attribute [rw] training_data
633
+ # An array of information that lists the Dataset objects, which
634
+ # specifies the dataset type and details on its location and schema.
635
+ # You must provide a role that has read access to these tables.
636
+ # @return [Array<Types::Dataset>]
637
+ #
629
638
  # @!attribute [rw] tags
630
639
  # The optional metadata that you apply to the resource to help you
631
640
  # categorize and organize them. Each tag consists of a key and an
@@ -659,20 +668,18 @@ module Aws::CleanRoomsML
659
668
  # of aws do not count against your tags per resource limit.
660
669
  # @return [Hash<String,String>]
661
670
  #
662
- # @!attribute [rw] training_data
663
- # An array of information that lists the Dataset objects, which
664
- # specifies the dataset type and details on its location and schema.
665
- # You must provide a role that has read access to these tables.
666
- # @return [Array<Types::Dataset>]
671
+ # @!attribute [rw] description
672
+ # The description of the training dataset.
673
+ # @return [String]
667
674
  #
668
675
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetRequest AWS API Documentation
669
676
  #
670
677
  class CreateTrainingDatasetRequest < Struct.new(
671
- :description,
672
678
  :name,
673
679
  :role_arn,
680
+ :training_data,
674
681
  :tags,
675
- :training_data)
682
+ :description)
676
683
  SENSITIVE = []
677
684
  include Aws::Structure
678
685
  end
@@ -708,40 +715,40 @@ module Aws::CleanRoomsML
708
715
  # Defines where the training dataset is located, what type of data it
709
716
  # contains, and how to access the data.
710
717
  #
718
+ # @!attribute [rw] type
719
+ # What type of information is found in the dataset.
720
+ # @return [String]
721
+ #
711
722
  # @!attribute [rw] input_config
712
723
  # A DatasetInputConfig object that defines the data source and schema
713
724
  # mapping.
714
725
  # @return [Types::DatasetInputConfig]
715
726
  #
716
- # @!attribute [rw] type
717
- # What type of information is found in the dataset.
718
- # @return [String]
719
- #
720
727
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/Dataset AWS API Documentation
721
728
  #
722
729
  class Dataset < Struct.new(
723
- :input_config,
724
- :type)
730
+ :type,
731
+ :input_config)
725
732
  SENSITIVE = []
726
733
  include Aws::Structure
727
734
  end
728
735
 
729
736
  # Defines the Glue data source and schema mapping information.
730
737
  #
738
+ # @!attribute [rw] schema
739
+ # The schema information for the training data.
740
+ # @return [Array<Types::ColumnSchema>]
741
+ #
731
742
  # @!attribute [rw] data_source
732
743
  # A DataSource object that specifies the Glue data source for the
733
744
  # training data.
734
745
  # @return [Types::DataSource]
735
746
  #
736
- # @!attribute [rw] schema
737
- # The schema information for the training data.
738
- # @return [Array<Types::ColumnSchema>]
739
- #
740
747
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DatasetInputConfig AWS API Documentation
741
748
  #
742
749
  class DatasetInputConfig < Struct.new(
743
- :data_source,
744
- :schema)
750
+ :schema,
751
+ :data_source)
745
752
  SENSITIVE = []
746
753
  include Aws::Structure
747
754
  end
@@ -824,27 +831,45 @@ module Aws::CleanRoomsML
824
831
  include Aws::Structure
825
832
  end
826
833
 
834
+ # @!attribute [rw] create_time
835
+ # The time at which the audience generation job was created.
836
+ # @return [Time]
837
+ #
838
+ # @!attribute [rw] update_time
839
+ # The most recent time at which the audience generation job was
840
+ # updated.
841
+ # @return [Time]
842
+ #
827
843
  # @!attribute [rw] audience_generation_job_arn
828
844
  # The Amazon Resource Name (ARN) of the audience generation job.
829
845
  # @return [String]
830
846
  #
831
- # @!attribute [rw] collaboration_id
832
- # The identifier of the collaboration that this audience generation
833
- # job is associated with.
847
+ # @!attribute [rw] name
848
+ # The name of the audience generation job.
834
849
  # @return [String]
835
850
  #
851
+ # @!attribute [rw] description
852
+ # The description of the audience generation job.
853
+ # @return [String]
854
+ #
855
+ # @!attribute [rw] status
856
+ # The status of the audience generation job.
857
+ # @return [String]
858
+ #
859
+ # @!attribute [rw] status_details
860
+ # Details about the status of the audience generation job.
861
+ # @return [Types::StatusDetails]
862
+ #
836
863
  # @!attribute [rw] configured_audience_model_arn
837
864
  # The Amazon Resource Name (ARN) of the configured audience model used
838
865
  # for this audience generation job.
839
866
  # @return [String]
840
867
  #
841
- # @!attribute [rw] create_time
842
- # The time at which the audience generation job was created.
843
- # @return [Time]
844
- #
845
- # @!attribute [rw] description
846
- # The description of the audience generation job.
847
- # @return [String]
868
+ # @!attribute [rw] seed_audience
869
+ # The seed audience that was used for this audience generation job.
870
+ # This field will be null if the account calling the API is the
871
+ # account that started this audience generation job.
872
+ # @return [Types::AudienceGenerationJobDataSource]
848
873
  #
849
874
  # @!attribute [rw] include_seed_in_output
850
875
  # Configure whether the seed users are included in the output
@@ -856,59 +881,47 @@ module Aws::CleanRoomsML
856
881
  # the seed.
857
882
  # @return [Boolean]
858
883
  #
884
+ # @!attribute [rw] collaboration_id
885
+ # The identifier of the collaboration that this audience generation
886
+ # job is associated with.
887
+ # @return [String]
888
+ #
859
889
  # @!attribute [rw] metrics
860
890
  # The relevance scores for different audience sizes and the recall
861
891
  # score of the generated audience.
862
892
  # @return [Types::AudienceQualityMetrics]
863
893
  #
864
- # @!attribute [rw] name
865
- # The name of the audience generation job.
866
- # @return [String]
867
- #
868
- # @!attribute [rw] seed_audience
869
- # The seed audience that was used for this audience generation job.
870
- # This field will be null if the account calling the API is the
871
- # account that started this audience generation job.
872
- # @return [Types::AudienceGenerationJobDataSource]
873
- #
874
894
  # @!attribute [rw] started_by
875
895
  # The AWS account that started this audience generation job.
876
896
  # @return [String]
877
897
  #
878
- # @!attribute [rw] status
879
- # The status of the audience generation job.
880
- # @return [String]
881
- #
882
- # @!attribute [rw] status_details
883
- # Details about the status of the audience generation job.
884
- # @return [Types::StatusDetails]
885
- #
886
898
  # @!attribute [rw] tags
887
899
  # The tags that are associated to this audience generation job.
888
900
  # @return [Hash<String,String>]
889
901
  #
890
- # @!attribute [rw] update_time
891
- # The most recent time at which the audience generation job was
892
- # updated.
893
- # @return [Time]
902
+ # @!attribute [rw] protected_query_identifier
903
+ # The unique identifier of the protected query for this audience
904
+ # generation job.
905
+ # @return [String]
894
906
  #
895
907
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobResponse AWS API Documentation
896
908
  #
897
909
  class GetAudienceGenerationJobResponse < Struct.new(
898
- :audience_generation_job_arn,
899
- :collaboration_id,
900
- :configured_audience_model_arn,
901
910
  :create_time,
911
+ :update_time,
912
+ :audience_generation_job_arn,
913
+ :name,
902
914
  :description,
915
+ :status,
916
+ :status_details,
917
+ :configured_audience_model_arn,
918
+ :seed_audience,
903
919
  :include_seed_in_output,
920
+ :collaboration_id,
904
921
  :metrics,
905
- :name,
906
- :seed_audience,
907
922
  :started_by,
908
- :status,
909
- :status_details,
910
923
  :tags,
911
- :update_time)
924
+ :protected_query_identifier)
912
925
  SENSITIVE = []
913
926
  include Aws::Structure
914
927
  end
@@ -926,26 +939,35 @@ module Aws::CleanRoomsML
926
939
  include Aws::Structure
927
940
  end
928
941
 
929
- # @!attribute [rw] audience_model_arn
930
- # The Amazon Resource Name (ARN) of the audience model.
931
- # @return [String]
932
- #
933
942
  # @!attribute [rw] create_time
934
943
  # The time at which the audience model was created.
935
944
  # @return [Time]
936
945
  #
937
- # @!attribute [rw] description
938
- # The description of the audience model.
939
- # @return [String]
946
+ # @!attribute [rw] update_time
947
+ # The most recent time at which the audience model was updated.
948
+ # @return [Time]
940
949
  #
941
- # @!attribute [rw] kms_key_arn
942
- # The KMS key ARN used for the audience model.
950
+ # @!attribute [rw] training_data_start_time
951
+ # The start date specified for the training window.
952
+ # @return [Time]
953
+ #
954
+ # @!attribute [rw] training_data_end_time
955
+ # The end date specified for the training window.
956
+ # @return [Time]
957
+ #
958
+ # @!attribute [rw] audience_model_arn
959
+ # The Amazon Resource Name (ARN) of the audience model.
943
960
  # @return [String]
944
961
  #
945
962
  # @!attribute [rw] name
946
963
  # The name of the audience model.
947
964
  # @return [String]
948
965
  #
966
+ # @!attribute [rw] training_dataset_arn
967
+ # The Amazon Resource Name (ARN) of the training dataset that was used
968
+ # for this audience model.
969
+ # @return [String]
970
+ #
949
971
  # @!attribute [rw] status
950
972
  # The status of the audience model.
951
973
  # @return [String]
@@ -954,42 +976,33 @@ module Aws::CleanRoomsML
954
976
  # Details about the status of the audience model.
955
977
  # @return [Types::StatusDetails]
956
978
  #
979
+ # @!attribute [rw] kms_key_arn
980
+ # The KMS key ARN used for the audience model.
981
+ # @return [String]
982
+ #
957
983
  # @!attribute [rw] tags
958
984
  # The tags that are assigned to the audience model.
959
985
  # @return [Hash<String,String>]
960
986
  #
961
- # @!attribute [rw] training_data_end_time
962
- # The end date specified for the training window.
963
- # @return [Time]
964
- #
965
- # @!attribute [rw] training_data_start_time
966
- # The start date specified for the training window.
967
- # @return [Time]
968
- #
969
- # @!attribute [rw] training_dataset_arn
970
- # The Amazon Resource Name (ARN) of the training dataset that was used
971
- # for this audience model.
987
+ # @!attribute [rw] description
988
+ # The description of the audience model.
972
989
  # @return [String]
973
990
  #
974
- # @!attribute [rw] update_time
975
- # The most recent time at which the audience model was updated.
976
- # @return [Time]
977
- #
978
991
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelResponse AWS API Documentation
979
992
  #
980
993
  class GetAudienceModelResponse < Struct.new(
981
- :audience_model_arn,
982
994
  :create_time,
983
- :description,
984
- :kms_key_arn,
995
+ :update_time,
996
+ :training_data_start_time,
997
+ :training_data_end_time,
998
+ :audience_model_arn,
985
999
  :name,
1000
+ :training_dataset_arn,
986
1001
  :status,
987
1002
  :status_details,
1003
+ :kms_key_arn,
988
1004
  :tags,
989
- :training_data_end_time,
990
- :training_data_start_time,
991
- :training_dataset_arn,
992
- :update_time)
1005
+ :description)
993
1006
  SENSITIVE = []
994
1007
  include Aws::Structure
995
1008
  end
@@ -1044,84 +1057,84 @@ module Aws::CleanRoomsML
1044
1057
  include Aws::Structure
1045
1058
  end
1046
1059
 
1047
- # @!attribute [rw] audience_model_arn
1048
- # The Amazon Resource Name (ARN) of the audience model used for this
1049
- # configured audience model.
1050
- # @return [String]
1051
- #
1052
- # @!attribute [rw] audience_size_config
1053
- # The list of output sizes of audiences that can be created using this
1054
- # configured audience model. A request to StartAudienceGenerationJob
1055
- # that uses this configured audience model must have an `audienceSize`
1056
- # selected from this list. You can use the `ABSOLUTE` AudienceSize to
1057
- # configure out audience sizes using the count of identifiers in the
1058
- # output. You can use the `Percentage` AudienceSize to configure sizes
1059
- # in the range 1-100 percent.
1060
- # @return [Types::AudienceSizeConfig]
1061
- #
1062
- # @!attribute [rw] child_resource_tag_on_create_policy
1063
- # Provides the `childResourceTagOnCreatePolicy` that was used for this
1064
- # configured audience model.
1065
- # @return [String]
1066
- #
1067
- # @!attribute [rw] configured_audience_model_arn
1068
- # The Amazon Resource Name (ARN) of the configured audience model.
1069
- # @return [String]
1070
- #
1071
1060
  # @!attribute [rw] create_time
1072
1061
  # The time at which the configured audience model was created.
1073
1062
  # @return [Time]
1074
1063
  #
1075
- # @!attribute [rw] description
1076
- # The description of the configured audience model.
1077
- # @return [String]
1064
+ # @!attribute [rw] update_time
1065
+ # The most recent time at which the configured audience model was
1066
+ # updated.
1067
+ # @return [Time]
1078
1068
  #
1079
- # @!attribute [rw] min_matching_seed_size
1080
- # The minimum number of users from the seed audience that must match
1081
- # with users in the training data of the audience model.
1082
- # @return [Integer]
1069
+ # @!attribute [rw] configured_audience_model_arn
1070
+ # The Amazon Resource Name (ARN) of the configured audience model.
1071
+ # @return [String]
1083
1072
  #
1084
1073
  # @!attribute [rw] name
1085
1074
  # The name of the configured audience model.
1086
1075
  # @return [String]
1087
1076
  #
1077
+ # @!attribute [rw] audience_model_arn
1078
+ # The Amazon Resource Name (ARN) of the audience model used for this
1079
+ # configured audience model.
1080
+ # @return [String]
1081
+ #
1088
1082
  # @!attribute [rw] output_config
1089
1083
  # The output configuration of the configured audience model
1090
1084
  # @return [Types::ConfiguredAudienceModelOutputConfig]
1091
1085
  #
1092
- # @!attribute [rw] shared_audience_metrics
1093
- # Whether audience metrics are shared.
1094
- # @return [Array<String>]
1086
+ # @!attribute [rw] description
1087
+ # The description of the configured audience model.
1088
+ # @return [String]
1095
1089
  #
1096
1090
  # @!attribute [rw] status
1097
1091
  # The status of the configured audience model.
1098
1092
  # @return [String]
1099
1093
  #
1094
+ # @!attribute [rw] shared_audience_metrics
1095
+ # Whether audience metrics are shared.
1096
+ # @return [Array<String>]
1097
+ #
1098
+ # @!attribute [rw] min_matching_seed_size
1099
+ # The minimum number of users from the seed audience that must match
1100
+ # with users in the training data of the audience model.
1101
+ # @return [Integer]
1102
+ #
1103
+ # @!attribute [rw] audience_size_config
1104
+ # The list of output sizes of audiences that can be created using this
1105
+ # configured audience model. A request to StartAudienceGenerationJob
1106
+ # that uses this configured audience model must have an `audienceSize`
1107
+ # selected from this list. You can use the `ABSOLUTE` AudienceSize to
1108
+ # configure out audience sizes using the count of identifiers in the
1109
+ # output. You can use the `Percentage` AudienceSize to configure sizes
1110
+ # in the range 1-100 percent.
1111
+ # @return [Types::AudienceSizeConfig]
1112
+ #
1100
1113
  # @!attribute [rw] tags
1101
1114
  # The tags that are associated to this configured audience model.
1102
1115
  # @return [Hash<String,String>]
1103
1116
  #
1104
- # @!attribute [rw] update_time
1105
- # The most recent time at which the configured audience model was
1106
- # updated.
1107
- # @return [Time]
1117
+ # @!attribute [rw] child_resource_tag_on_create_policy
1118
+ # Provides the `childResourceTagOnCreatePolicy` that was used for this
1119
+ # configured audience model.
1120
+ # @return [String]
1108
1121
  #
1109
1122
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelResponse AWS API Documentation
1110
1123
  #
1111
1124
  class GetConfiguredAudienceModelResponse < Struct.new(
1112
- :audience_model_arn,
1113
- :audience_size_config,
1114
- :child_resource_tag_on_create_policy,
1115
- :configured_audience_model_arn,
1116
1125
  :create_time,
1117
- :description,
1118
- :min_matching_seed_size,
1126
+ :update_time,
1127
+ :configured_audience_model_arn,
1119
1128
  :name,
1129
+ :audience_model_arn,
1120
1130
  :output_config,
1121
- :shared_audience_metrics,
1131
+ :description,
1122
1132
  :status,
1133
+ :shared_audience_metrics,
1134
+ :min_matching_seed_size,
1135
+ :audience_size_config,
1123
1136
  :tags,
1124
- :update_time)
1137
+ :child_resource_tag_on_create_policy)
1125
1138
  SENSITIVE = []
1126
1139
  include Aws::Structure
1127
1140
  end
@@ -1143,237 +1156,237 @@ module Aws::CleanRoomsML
1143
1156
  # The time at which the training dataset was created.
1144
1157
  # @return [Time]
1145
1158
  #
1146
- # @!attribute [rw] description
1147
- # The description of the training dataset.
1159
+ # @!attribute [rw] update_time
1160
+ # The most recent time at which the training dataset was updated.
1161
+ # @return [Time]
1162
+ #
1163
+ # @!attribute [rw] training_dataset_arn
1164
+ # The Amazon Resource Name (ARN) of the training dataset.
1148
1165
  # @return [String]
1149
1166
  #
1150
1167
  # @!attribute [rw] name
1151
1168
  # The name of the training dataset.
1152
1169
  # @return [String]
1153
1170
  #
1154
- # @!attribute [rw] role_arn
1155
- # The IAM role used to read the training data.
1156
- # @return [String]
1171
+ # @!attribute [rw] training_data
1172
+ # Metadata about the requested training data.
1173
+ # @return [Array<Types::Dataset>]
1157
1174
  #
1158
1175
  # @!attribute [rw] status
1159
1176
  # The status of the training dataset.
1160
1177
  # @return [String]
1161
1178
  #
1179
+ # @!attribute [rw] role_arn
1180
+ # The IAM role used to read the training data.
1181
+ # @return [String]
1182
+ #
1162
1183
  # @!attribute [rw] tags
1163
1184
  # The tags that are assigned to this training dataset.
1164
1185
  # @return [Hash<String,String>]
1165
1186
  #
1166
- # @!attribute [rw] training_data
1167
- # Metadata about the requested training data.
1168
- # @return [Array<Types::Dataset>]
1169
- #
1170
- # @!attribute [rw] training_dataset_arn
1171
- # The Amazon Resource Name (ARN) of the training dataset.
1187
+ # @!attribute [rw] description
1188
+ # The description of the training dataset.
1172
1189
  # @return [String]
1173
1190
  #
1174
- # @!attribute [rw] update_time
1175
- # The most recent time at which the training dataset was updated.
1176
- # @return [Time]
1177
- #
1178
1191
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetResponse AWS API Documentation
1179
1192
  #
1180
1193
  class GetTrainingDatasetResponse < Struct.new(
1181
1194
  :create_time,
1182
- :description,
1195
+ :update_time,
1196
+ :training_dataset_arn,
1183
1197
  :name,
1184
- :role_arn,
1198
+ :training_data,
1185
1199
  :status,
1200
+ :role_arn,
1186
1201
  :tags,
1187
- :training_data,
1188
- :training_dataset_arn,
1189
- :update_time)
1202
+ :description)
1190
1203
  SENSITIVE = []
1191
1204
  include Aws::Structure
1192
1205
  end
1193
1206
 
1194
1207
  # Defines the Glue data source that contains the training data.
1195
1208
  #
1196
- # @!attribute [rw] catalog_id
1197
- # The Glue catalog that contains the training data.
1209
+ # @!attribute [rw] table_name
1210
+ # The Glue table that contains the training data.
1198
1211
  # @return [String]
1199
1212
  #
1200
1213
  # @!attribute [rw] database_name
1201
1214
  # The Glue database that contains the training data.
1202
1215
  # @return [String]
1203
1216
  #
1204
- # @!attribute [rw] table_name
1205
- # The Glue table that contains the training data.
1217
+ # @!attribute [rw] catalog_id
1218
+ # The Glue catalog that contains the training data.
1206
1219
  # @return [String]
1207
1220
  #
1208
1221
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GlueDataSource AWS API Documentation
1209
1222
  #
1210
1223
  class GlueDataSource < Struct.new(
1211
- :catalog_id,
1224
+ :table_name,
1212
1225
  :database_name,
1213
- :table_name)
1226
+ :catalog_id)
1214
1227
  SENSITIVE = []
1215
1228
  include Aws::Structure
1216
1229
  end
1217
1230
 
1218
- # @!attribute [rw] audience_generation_job_arn
1219
- # The Amazon Resource Name (ARN) of the audience generation job that
1220
- # you are interested in.
1231
+ # @!attribute [rw] next_token
1232
+ # The token value retrieved from a previous call to access the next
1233
+ # page of results.
1221
1234
  # @return [String]
1222
1235
  #
1223
1236
  # @!attribute [rw] max_results
1224
1237
  # The maximum size of the results that is returned per call.
1225
1238
  # @return [Integer]
1226
1239
  #
1227
- # @!attribute [rw] next_token
1228
- # The token value retrieved from a previous call to access the next
1229
- # page of results.
1240
+ # @!attribute [rw] audience_generation_job_arn
1241
+ # The Amazon Resource Name (ARN) of the audience generation job that
1242
+ # you are interested in.
1230
1243
  # @return [String]
1231
1244
  #
1232
1245
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsRequest AWS API Documentation
1233
1246
  #
1234
1247
  class ListAudienceExportJobsRequest < Struct.new(
1235
- :audience_generation_job_arn,
1248
+ :next_token,
1236
1249
  :max_results,
1237
- :next_token)
1250
+ :audience_generation_job_arn)
1238
1251
  SENSITIVE = []
1239
1252
  include Aws::Structure
1240
1253
  end
1241
1254
 
1242
- # @!attribute [rw] audience_export_jobs
1243
- # The audience export jobs that match the request.
1244
- # @return [Array<Types::AudienceExportJobSummary>]
1245
- #
1246
1255
  # @!attribute [rw] next_token
1247
1256
  # The token value retrieved from a previous call to access the next
1248
1257
  # page of results.
1249
1258
  # @return [String]
1250
1259
  #
1260
+ # @!attribute [rw] audience_export_jobs
1261
+ # The audience export jobs that match the request.
1262
+ # @return [Array<Types::AudienceExportJobSummary>]
1263
+ #
1251
1264
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsResponse AWS API Documentation
1252
1265
  #
1253
1266
  class ListAudienceExportJobsResponse < Struct.new(
1254
- :audience_export_jobs,
1255
- :next_token)
1267
+ :next_token,
1268
+ :audience_export_jobs)
1256
1269
  SENSITIVE = []
1257
1270
  include Aws::Structure
1258
1271
  end
1259
1272
 
1260
- # @!attribute [rw] collaboration_id
1261
- # The identifier of the collaboration that contains the audience
1262
- # generation jobs that you are interested in.
1273
+ # @!attribute [rw] next_token
1274
+ # The token value retrieved from a previous call to access the next
1275
+ # page of results.
1263
1276
  # @return [String]
1264
1277
  #
1278
+ # @!attribute [rw] max_results
1279
+ # The maximum size of the results that is returned per call.
1280
+ # @return [Integer]
1281
+ #
1265
1282
  # @!attribute [rw] configured_audience_model_arn
1266
1283
  # The Amazon Resource Name (ARN) of the configured audience model that
1267
1284
  # was used for the audience generation jobs that you are interested
1268
1285
  # in.
1269
1286
  # @return [String]
1270
1287
  #
1271
- # @!attribute [rw] max_results
1272
- # The maximum size of the results that is returned per call.
1273
- # @return [Integer]
1274
- #
1275
- # @!attribute [rw] next_token
1276
- # The token value retrieved from a previous call to access the next
1277
- # page of results.
1288
+ # @!attribute [rw] collaboration_id
1289
+ # The identifier of the collaboration that contains the audience
1290
+ # generation jobs that you are interested in.
1278
1291
  # @return [String]
1279
1292
  #
1280
1293
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsRequest AWS API Documentation
1281
1294
  #
1282
1295
  class ListAudienceGenerationJobsRequest < Struct.new(
1283
- :collaboration_id,
1284
- :configured_audience_model_arn,
1296
+ :next_token,
1285
1297
  :max_results,
1286
- :next_token)
1298
+ :configured_audience_model_arn,
1299
+ :collaboration_id)
1287
1300
  SENSITIVE = []
1288
1301
  include Aws::Structure
1289
1302
  end
1290
1303
 
1291
- # @!attribute [rw] audience_generation_jobs
1292
- # The audience generation jobs that match the request.
1293
- # @return [Array<Types::AudienceGenerationJobSummary>]
1294
- #
1295
1304
  # @!attribute [rw] next_token
1296
1305
  # The token value retrieved from a previous call to access the next
1297
1306
  # page of results.
1298
1307
  # @return [String]
1299
1308
  #
1309
+ # @!attribute [rw] audience_generation_jobs
1310
+ # The audience generation jobs that match the request.
1311
+ # @return [Array<Types::AudienceGenerationJobSummary>]
1312
+ #
1300
1313
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsResponse AWS API Documentation
1301
1314
  #
1302
1315
  class ListAudienceGenerationJobsResponse < Struct.new(
1303
- :audience_generation_jobs,
1304
- :next_token)
1316
+ :next_token,
1317
+ :audience_generation_jobs)
1305
1318
  SENSITIVE = []
1306
1319
  include Aws::Structure
1307
1320
  end
1308
1321
 
1309
- # @!attribute [rw] max_results
1310
- # The maximum size of the results that is returned per call.
1311
- # @return [Integer]
1312
- #
1313
1322
  # @!attribute [rw] next_token
1314
1323
  # The token value retrieved from a previous call to access the next
1315
1324
  # page of results.
1316
1325
  # @return [String]
1317
1326
  #
1327
+ # @!attribute [rw] max_results
1328
+ # The maximum size of the results that is returned per call.
1329
+ # @return [Integer]
1330
+ #
1318
1331
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsRequest AWS API Documentation
1319
1332
  #
1320
1333
  class ListAudienceModelsRequest < Struct.new(
1321
- :max_results,
1322
- :next_token)
1334
+ :next_token,
1335
+ :max_results)
1323
1336
  SENSITIVE = []
1324
1337
  include Aws::Structure
1325
1338
  end
1326
1339
 
1327
- # @!attribute [rw] audience_models
1328
- # The audience models that match the request.
1329
- # @return [Array<Types::AudienceModelSummary>]
1330
- #
1331
1340
  # @!attribute [rw] next_token
1332
1341
  # The token value retrieved from a previous call to access the next
1333
1342
  # page of results.
1334
1343
  # @return [String]
1335
1344
  #
1345
+ # @!attribute [rw] audience_models
1346
+ # The audience models that match the request.
1347
+ # @return [Array<Types::AudienceModelSummary>]
1348
+ #
1336
1349
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsResponse AWS API Documentation
1337
1350
  #
1338
1351
  class ListAudienceModelsResponse < Struct.new(
1339
- :audience_models,
1340
- :next_token)
1352
+ :next_token,
1353
+ :audience_models)
1341
1354
  SENSITIVE = []
1342
1355
  include Aws::Structure
1343
1356
  end
1344
1357
 
1345
- # @!attribute [rw] max_results
1346
- # The maximum size of the results that is returned per call.
1347
- # @return [Integer]
1348
- #
1349
1358
  # @!attribute [rw] next_token
1350
1359
  # The token value retrieved from a previous call to access the next
1351
1360
  # page of results.
1352
1361
  # @return [String]
1353
1362
  #
1363
+ # @!attribute [rw] max_results
1364
+ # The maximum size of the results that is returned per call.
1365
+ # @return [Integer]
1366
+ #
1354
1367
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsRequest AWS API Documentation
1355
1368
  #
1356
1369
  class ListConfiguredAudienceModelsRequest < Struct.new(
1357
- :max_results,
1358
- :next_token)
1370
+ :next_token,
1371
+ :max_results)
1359
1372
  SENSITIVE = []
1360
1373
  include Aws::Structure
1361
1374
  end
1362
1375
 
1363
- # @!attribute [rw] configured_audience_models
1364
- # The configured audience models.
1365
- # @return [Array<Types::ConfiguredAudienceModelSummary>]
1366
- #
1367
1376
  # @!attribute [rw] next_token
1368
1377
  # The token value retrieved from a previous call to access the next
1369
1378
  # page of results.
1370
1379
  # @return [String]
1371
1380
  #
1381
+ # @!attribute [rw] configured_audience_models
1382
+ # The configured audience models.
1383
+ # @return [Array<Types::ConfiguredAudienceModelSummary>]
1384
+ #
1372
1385
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsResponse AWS API Documentation
1373
1386
  #
1374
1387
  class ListConfiguredAudienceModelsResponse < Struct.new(
1375
- :configured_audience_models,
1376
- :next_token)
1388
+ :next_token,
1389
+ :configured_audience_models)
1377
1390
  SENSITIVE = []
1378
1391
  include Aws::Structure
1379
1392
  end
@@ -1403,20 +1416,20 @@ module Aws::CleanRoomsML
1403
1416
  include Aws::Structure
1404
1417
  end
1405
1418
 
1406
- # @!attribute [rw] max_results
1407
- # The maximum size of the results that is returned per call.
1408
- # @return [Integer]
1409
- #
1410
1419
  # @!attribute [rw] next_token
1411
1420
  # The token value retrieved from a previous call to access the next
1412
1421
  # page of results.
1413
1422
  # @return [String]
1414
1423
  #
1424
+ # @!attribute [rw] max_results
1425
+ # The maximum size of the results that is returned per call.
1426
+ # @return [Integer]
1427
+ #
1415
1428
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsRequest AWS API Documentation
1416
1429
  #
1417
1430
  class ListTrainingDatasetsRequest < Struct.new(
1418
- :max_results,
1419
- :next_token)
1431
+ :next_token,
1432
+ :max_results)
1420
1433
  SENSITIVE = []
1421
1434
  include Aws::Structure
1422
1435
  end
@@ -1439,6 +1452,31 @@ module Aws::CleanRoomsML
1439
1452
  include Aws::Structure
1440
1453
  end
1441
1454
 
1455
+ # The parameters for the SQL type Protected Query.
1456
+ #
1457
+ # @!attribute [rw] query_string
1458
+ # The query string to be submitted.
1459
+ # @return [String]
1460
+ #
1461
+ # @!attribute [rw] analysis_template_arn
1462
+ # The Amazon Resource Name (ARN) associated with the analysis template
1463
+ # within a collaboration.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] parameters
1467
+ # The protected query SQL parameters.
1468
+ # @return [Hash<String,String>]
1469
+ #
1470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ProtectedQuerySQLParameters AWS API Documentation
1471
+ #
1472
+ class ProtectedQuerySQLParameters < Struct.new(
1473
+ :query_string,
1474
+ :analysis_template_arn,
1475
+ :parameters)
1476
+ SENSITIVE = []
1477
+ include Aws::Structure
1478
+ end
1479
+
1442
1480
  # @!attribute [rw] configured_audience_model_arn
1443
1481
  # The Amazon Resource Name (ARN) of the configured audience model that
1444
1482
  # the resource policy will govern.
@@ -1448,23 +1486,23 @@ module Aws::CleanRoomsML
1448
1486
  # The IAM resource policy.
1449
1487
  # @return [String]
1450
1488
  #
1451
- # @!attribute [rw] policy_existence_condition
1452
- # Use this to prevent unexpected concurrent modification of the
1453
- # policy.
1454
- # @return [String]
1455
- #
1456
1489
  # @!attribute [rw] previous_policy_hash
1457
1490
  # A cryptographic hash of the contents of the policy used to prevent
1458
1491
  # unexpected concurrent modification of the policy.
1459
1492
  # @return [String]
1460
1493
  #
1494
+ # @!attribute [rw] policy_existence_condition
1495
+ # Use this to prevent unexpected concurrent modification of the
1496
+ # policy.
1497
+ # @return [String]
1498
+ #
1461
1499
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutConfiguredAudienceModelPolicyRequest AWS API Documentation
1462
1500
  #
1463
1501
  class PutConfiguredAudienceModelPolicyRequest < Struct.new(
1464
1502
  :configured_audience_model_arn,
1465
1503
  :configured_audience_model_policy,
1466
- :policy_existence_condition,
1467
- :previous_policy_hash)
1504
+ :previous_policy_hash,
1505
+ :policy_existence_condition)
1468
1506
  SENSITIVE = []
1469
1507
  include Aws::Structure
1470
1508
  end
@@ -1547,6 +1585,10 @@ module Aws::CleanRoomsML
1547
1585
  include Aws::Structure
1548
1586
  end
1549
1587
 
1588
+ # @!attribute [rw] name
1589
+ # The name of the audience export job.
1590
+ # @return [String]
1591
+ #
1550
1592
  # @!attribute [rw] audience_generation_job_arn
1551
1593
  # The Amazon Resource Name (ARN) of the audience generation job that
1552
1594
  # you want to export.
@@ -1561,24 +1603,19 @@ module Aws::CleanRoomsML
1561
1603
  # The description of the audience export job.
1562
1604
  # @return [String]
1563
1605
  #
1564
- # @!attribute [rw] name
1565
- # The name of the audience export job.
1566
- # @return [String]
1567
- #
1568
1606
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceExportJobRequest AWS API Documentation
1569
1607
  #
1570
1608
  class StartAudienceExportJobRequest < Struct.new(
1609
+ :name,
1571
1610
  :audience_generation_job_arn,
1572
1611
  :audience_size,
1573
- :description,
1574
- :name)
1612
+ :description)
1575
1613
  SENSITIVE = []
1576
1614
  include Aws::Structure
1577
1615
  end
1578
1616
 
1579
- # @!attribute [rw] collaboration_id
1580
- # The identifier of the collaboration that contains the audience
1581
- # generation job.
1617
+ # @!attribute [rw] name
1618
+ # The name of the audience generation job.
1582
1619
  # @return [String]
1583
1620
  #
1584
1621
  # @!attribute [rw] configured_audience_model_arn
@@ -1586,22 +1623,23 @@ module Aws::CleanRoomsML
1586
1623
  # is used for this audience generation job.
1587
1624
  # @return [String]
1588
1625
  #
1589
- # @!attribute [rw] description
1590
- # The description of the audience generation job.
1591
- # @return [String]
1626
+ # @!attribute [rw] seed_audience
1627
+ # The seed audience that is used to generate the audience.
1628
+ # @return [Types::AudienceGenerationJobDataSource]
1592
1629
  #
1593
1630
  # @!attribute [rw] include_seed_in_output
1594
1631
  # Whether the seed audience is included in the audience generation
1595
1632
  # output.
1596
1633
  # @return [Boolean]
1597
1634
  #
1598
- # @!attribute [rw] name
1599
- # The name of the audience generation job.
1635
+ # @!attribute [rw] collaboration_id
1636
+ # The identifier of the collaboration that contains the audience
1637
+ # generation job.
1600
1638
  # @return [String]
1601
1639
  #
1602
- # @!attribute [rw] seed_audience
1603
- # The seed audience that is used to generate the audience.
1604
- # @return [Types::AudienceGenerationJobDataSource]
1640
+ # @!attribute [rw] description
1641
+ # The description of the audience generation job.
1642
+ # @return [String]
1605
1643
  #
1606
1644
  # @!attribute [rw] tags
1607
1645
  # The optional metadata that you apply to the resource to help you
@@ -1639,12 +1677,12 @@ module Aws::CleanRoomsML
1639
1677
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJobRequest AWS API Documentation
1640
1678
  #
1641
1679
  class StartAudienceGenerationJobRequest < Struct.new(
1642
- :collaboration_id,
1643
- :configured_audience_model_arn,
1644
- :description,
1645
- :include_seed_in_output,
1646
1680
  :name,
1681
+ :configured_audience_model_arn,
1647
1682
  :seed_audience,
1683
+ :include_seed_in_output,
1684
+ :collaboration_id,
1685
+ :description,
1648
1686
  :tags)
1649
1687
  SENSITIVE = []
1650
1688
  include Aws::Structure
@@ -1664,23 +1702,23 @@ module Aws::CleanRoomsML
1664
1702
 
1665
1703
  # Details about the status of a resource.
1666
1704
  #
1667
- # @!attribute [rw] message
1668
- # The error message that was returned. The message is intended for
1669
- # human consumption and can change at any time. Use the `statusCode`
1670
- # for programmatic error handling.
1671
- # @return [String]
1672
- #
1673
1705
  # @!attribute [rw] status_code
1674
1706
  # The status code that was returned. The status code is intended for
1675
1707
  # programmatic error handling. Clean Rooms ML will not change the
1676
1708
  # status code for existing error conditions.
1677
1709
  # @return [String]
1678
1710
  #
1711
+ # @!attribute [rw] message
1712
+ # The error message that was returned. The message is intended for
1713
+ # human consumption and can change at any time. Use the `statusCode`
1714
+ # for programmatic error handling.
1715
+ # @return [String]
1716
+ #
1679
1717
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StatusDetails AWS API Documentation
1680
1718
  #
1681
1719
  class StatusDetails < Struct.new(
1682
- :message,
1683
- :status_code)
1720
+ :status_code,
1721
+ :message)
1684
1722
  SENSITIVE = []
1685
1723
  include Aws::Structure
1686
1724
  end
@@ -1742,8 +1780,12 @@ module Aws::CleanRoomsML
1742
1780
  # The time at which the training dataset was created.
1743
1781
  # @return [Time]
1744
1782
  #
1745
- # @!attribute [rw] description
1746
- # The description of the training dataset.
1783
+ # @!attribute [rw] update_time
1784
+ # The most recent time at which the training dataset was updated.
1785
+ # @return [Time]
1786
+ #
1787
+ # @!attribute [rw] training_dataset_arn
1788
+ # The Amazon Resource Name (ARN) of the training dataset.
1747
1789
  # @return [String]
1748
1790
  #
1749
1791
  # @!attribute [rw] name
@@ -1754,23 +1796,19 @@ module Aws::CleanRoomsML
1754
1796
  # The status of the training dataset.
1755
1797
  # @return [String]
1756
1798
  #
1757
- # @!attribute [rw] training_dataset_arn
1758
- # The Amazon Resource Name (ARN) of the training dataset.
1799
+ # @!attribute [rw] description
1800
+ # The description of the training dataset.
1759
1801
  # @return [String]
1760
1802
  #
1761
- # @!attribute [rw] update_time
1762
- # The most recent time at which the training dataset was updated.
1763
- # @return [Time]
1764
- #
1765
1803
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainingDatasetSummary AWS API Documentation
1766
1804
  #
1767
1805
  class TrainingDatasetSummary < Struct.new(
1768
1806
  :create_time,
1769
- :description,
1807
+ :update_time,
1808
+ :training_dataset_arn,
1770
1809
  :name,
1771
1810
  :status,
1772
- :training_dataset_arn,
1773
- :update_time)
1811
+ :description)
1774
1812
  SENSITIVE = []
1775
1813
  include Aws::Structure
1776
1814
  end
@@ -1797,47 +1835,47 @@ module Aws::CleanRoomsML
1797
1835
  #
1798
1836
  class UntagResourceResponse < Aws::EmptyStructure; end
1799
1837
 
1800
- # @!attribute [rw] audience_model_arn
1801
- # The Amazon Resource Name (ARN) of the new audience model that you
1802
- # want to use.
1803
- # @return [String]
1804
- #
1805
- # @!attribute [rw] audience_size_config
1806
- # The new audience size configuration.
1807
- # @return [Types::AudienceSizeConfig]
1808
- #
1809
1838
  # @!attribute [rw] configured_audience_model_arn
1810
1839
  # The Amazon Resource Name (ARN) of the configured audience model that
1811
1840
  # you want to update.
1812
1841
  # @return [String]
1813
1842
  #
1814
- # @!attribute [rw] description
1815
- # The new description of the configured audience model.
1843
+ # @!attribute [rw] output_config
1844
+ # The new output configuration.
1845
+ # @return [Types::ConfiguredAudienceModelOutputConfig]
1846
+ #
1847
+ # @!attribute [rw] audience_model_arn
1848
+ # The Amazon Resource Name (ARN) of the new audience model that you
1849
+ # want to use.
1816
1850
  # @return [String]
1817
1851
  #
1852
+ # @!attribute [rw] shared_audience_metrics
1853
+ # The new value for whether to share audience metrics.
1854
+ # @return [Array<String>]
1855
+ #
1818
1856
  # @!attribute [rw] min_matching_seed_size
1819
1857
  # The minimum number of users from the seed audience that must match
1820
1858
  # with users in the training data of the audience model.
1821
1859
  # @return [Integer]
1822
1860
  #
1823
- # @!attribute [rw] output_config
1824
- # The new output configuration.
1825
- # @return [Types::ConfiguredAudienceModelOutputConfig]
1861
+ # @!attribute [rw] audience_size_config
1862
+ # The new audience size configuration.
1863
+ # @return [Types::AudienceSizeConfig]
1826
1864
  #
1827
- # @!attribute [rw] shared_audience_metrics
1828
- # The new value for whether to share audience metrics.
1829
- # @return [Array<String>]
1865
+ # @!attribute [rw] description
1866
+ # The new description of the configured audience model.
1867
+ # @return [String]
1830
1868
  #
1831
1869
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModelRequest AWS API Documentation
1832
1870
  #
1833
1871
  class UpdateConfiguredAudienceModelRequest < Struct.new(
1834
- :audience_model_arn,
1835
- :audience_size_config,
1836
1872
  :configured_audience_model_arn,
1837
- :description,
1838
- :min_matching_seed_size,
1839
1873
  :output_config,
1840
- :shared_audience_metrics)
1874
+ :audience_model_arn,
1875
+ :shared_audience_metrics,
1876
+ :min_matching_seed_size,
1877
+ :audience_size_config,
1878
+ :description)
1841
1879
  SENSITIVE = []
1842
1880
  include Aws::Structure
1843
1881
  end