aws-sdk-cleanroomsml 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-cleanroomsml/client.rb +1730 -0
- data/lib/aws-sdk-cleanroomsml/client_api.rb +856 -0
- data/lib/aws-sdk-cleanroomsml/customizations.rb +0 -0
- data/lib/aws-sdk-cleanroomsml/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-cleanroomsml/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-cleanroomsml/endpoints.rb +366 -0
- data/lib/aws-sdk-cleanroomsml/errors.rb +118 -0
- data/lib/aws-sdk-cleanroomsml/plugins/endpoints.rb +119 -0
- data/lib/aws-sdk-cleanroomsml/resource.rb +26 -0
- data/lib/aws-sdk-cleanroomsml/types.rb +1876 -0
- data/lib/aws-sdk-cleanroomsml.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1876 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::CleanRoomsML
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Defines the Amazon S3 bucket where the configured audience is stored.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] s3_destination
|
29
|
+
# The Amazon S3 bucket and path for the configured audience.
|
30
|
+
# @return [Types::S3ConfigMap]
|
31
|
+
#
|
32
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceDestination AWS API Documentation
|
33
|
+
#
|
34
|
+
class AudienceDestination < Struct.new(
|
35
|
+
:s3_destination)
|
36
|
+
SENSITIVE = []
|
37
|
+
include Aws::Structure
|
38
|
+
end
|
39
|
+
|
40
|
+
# Provides information about the audience export job.
|
41
|
+
#
|
42
|
+
# @!attribute [rw] audience_generation_job_arn
|
43
|
+
# The Amazon Resource Name (ARN) of the audience generation job that
|
44
|
+
# was exported.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] audience_size
|
48
|
+
# The size of the generated audience. Must match one of the sizes in
|
49
|
+
# the configured audience model.
|
50
|
+
# @return [Types::AudienceSize]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] create_time
|
53
|
+
# The time at which the audience export job was created.
|
54
|
+
# @return [Time]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] description
|
57
|
+
# The description of the audience export job.
|
58
|
+
# @return [String]
|
59
|
+
#
|
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
|
+
# @!attribute [rw] status
|
69
|
+
# The status of the audience export job.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] status_details
|
73
|
+
# Details about the status of a resource.
|
74
|
+
# @return [Types::StatusDetails]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] update_time
|
77
|
+
# The most recent time at which the audience export job was updated.
|
78
|
+
# @return [Time]
|
79
|
+
#
|
80
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceExportJobSummary AWS API Documentation
|
81
|
+
#
|
82
|
+
class AudienceExportJobSummary < Struct.new(
|
83
|
+
:audience_generation_job_arn,
|
84
|
+
:audience_size,
|
85
|
+
:create_time,
|
86
|
+
:description,
|
87
|
+
:name,
|
88
|
+
:output_location,
|
89
|
+
:status,
|
90
|
+
:status_details,
|
91
|
+
:update_time)
|
92
|
+
SENSITIVE = []
|
93
|
+
include Aws::Structure
|
94
|
+
end
|
95
|
+
|
96
|
+
# Defines the Amazon S3 bucket where the training data for the
|
97
|
+
# configured audience is stored.
|
98
|
+
#
|
99
|
+
# @!attribute [rw] data_source
|
100
|
+
# The Amazon S3 bucket where the training data for the configured
|
101
|
+
# audience is stored.
|
102
|
+
# @return [Types::S3ConfigMap]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] role_arn
|
105
|
+
# The ARN of the IAM role that can read the Amazon S3 bucket where the
|
106
|
+
# training data is stored.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceGenerationJobDataSource AWS API Documentation
|
110
|
+
#
|
111
|
+
class AudienceGenerationJobDataSource < Struct.new(
|
112
|
+
:data_source,
|
113
|
+
:role_arn)
|
114
|
+
SENSITIVE = []
|
115
|
+
include Aws::Structure
|
116
|
+
end
|
117
|
+
|
118
|
+
# Provides information about the configured audience generation job.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] audience_generation_job_arn
|
121
|
+
# The Amazon Resource Name (ARN) of the audience generation job.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] collaboration_id
|
125
|
+
# The identifier of the collaboration that contains this audience
|
126
|
+
# generation job.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] configured_audience_model_arn
|
130
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
131
|
+
# was used for this audience generation job.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] create_time
|
135
|
+
# The time at which the audience generation job was created.
|
136
|
+
# @return [Time]
|
137
|
+
#
|
138
|
+
# @!attribute [rw] description
|
139
|
+
# The description of the audience generation job.
|
140
|
+
# @return [String]
|
141
|
+
#
|
142
|
+
# @!attribute [rw] name
|
143
|
+
# The name of the audience generation job.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] started_by
|
147
|
+
# The AWS Account that submitted the job.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] status
|
151
|
+
# The status of the audience generation job.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] update_time
|
155
|
+
# The most recent time at which the audience generation job was
|
156
|
+
# updated.
|
157
|
+
# @return [Time]
|
158
|
+
#
|
159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceGenerationJobSummary AWS API Documentation
|
160
|
+
#
|
161
|
+
class AudienceGenerationJobSummary < Struct.new(
|
162
|
+
:audience_generation_job_arn,
|
163
|
+
:collaboration_id,
|
164
|
+
:configured_audience_model_arn,
|
165
|
+
:create_time,
|
166
|
+
:description,
|
167
|
+
:name,
|
168
|
+
:started_by,
|
169
|
+
:status,
|
170
|
+
:update_time)
|
171
|
+
SENSITIVE = []
|
172
|
+
include Aws::Structure
|
173
|
+
end
|
174
|
+
|
175
|
+
# The audience model metrics.
|
176
|
+
#
|
177
|
+
# @!attribute [rw] for_top_k_item_predictions
|
178
|
+
# The number of users that were used to generate these model metrics.
|
179
|
+
# @return [Integer]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] type
|
182
|
+
# The audience model metric.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] value
|
186
|
+
# The value of the audience model metric
|
187
|
+
# @return [Float]
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceModelMetric AWS API Documentation
|
190
|
+
#
|
191
|
+
class AudienceModelMetric < Struct.new(
|
192
|
+
:for_top_k_item_predictions,
|
193
|
+
:type,
|
194
|
+
:value)
|
195
|
+
SENSITIVE = []
|
196
|
+
include Aws::Structure
|
197
|
+
end
|
198
|
+
|
199
|
+
# Information about the audience model.
|
200
|
+
#
|
201
|
+
# @!attribute [rw] audience_model_arn
|
202
|
+
# The Amazon Resource Name (ARN) of the audience model.
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] create_time
|
206
|
+
# The time at which the audience model was created.
|
207
|
+
# @return [Time]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] description
|
210
|
+
# The description of the audience model.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] name
|
214
|
+
# The name of the audience model.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] status
|
218
|
+
# The status of the audience model.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] training_dataset_arn
|
222
|
+
# The Amazon Resource Name (ARN) of the training dataset that was used
|
223
|
+
# for the audience model.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] update_time
|
227
|
+
# The most recent time at which the audience model was updated.
|
228
|
+
# @return [Time]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceModelSummary AWS API Documentation
|
231
|
+
#
|
232
|
+
class AudienceModelSummary < Struct.new(
|
233
|
+
:audience_model_arn,
|
234
|
+
:create_time,
|
235
|
+
:description,
|
236
|
+
:name,
|
237
|
+
:status,
|
238
|
+
:training_dataset_arn,
|
239
|
+
:update_time)
|
240
|
+
SENSITIVE = []
|
241
|
+
include Aws::Structure
|
242
|
+
end
|
243
|
+
|
244
|
+
# Metrics that describe the quality of the generated audience.
|
245
|
+
#
|
246
|
+
# @!attribute [rw] relevance_metrics
|
247
|
+
# The relevance scores of the generated audience.
|
248
|
+
# @return [Array<Types::RelevanceMetric>]
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceQualityMetrics AWS API Documentation
|
251
|
+
#
|
252
|
+
class AudienceQualityMetrics < Struct.new(
|
253
|
+
:relevance_metrics)
|
254
|
+
SENSITIVE = []
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# The size of the generated audience. Must match one of the sizes in the
|
259
|
+
# configured audience model.
|
260
|
+
#
|
261
|
+
# @!attribute [rw] type
|
262
|
+
# Whether the audience size is defined in absolute terms or as a
|
263
|
+
# percentage. You can use the `ABSOLUTE` AudienceSize to configure out
|
264
|
+
# audience sizes using the count of identifiers in the output. You can
|
265
|
+
# use the `Percentage` AudienceSize to configure sizes in the range
|
266
|
+
# 1-100 percent.
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] value
|
270
|
+
# Specify an audience size value.
|
271
|
+
# @return [Integer]
|
272
|
+
#
|
273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceSize AWS API Documentation
|
274
|
+
#
|
275
|
+
class AudienceSize < Struct.new(
|
276
|
+
:type,
|
277
|
+
:value)
|
278
|
+
SENSITIVE = []
|
279
|
+
include Aws::Structure
|
280
|
+
end
|
281
|
+
|
282
|
+
# Configure the list of audience output sizes that can be created. A
|
283
|
+
# request to StartAudienceGenerationJob that uses this configured
|
284
|
+
# audience model must have an `audienceSize` selected from this list.
|
285
|
+
# You can use the `ABSOLUTE` AudienceSize to configure out audience
|
286
|
+
# sizes using the count of identifiers in the output. You can use the
|
287
|
+
# `Percentage` AudienceSize to configure sizes in the range 1-100
|
288
|
+
# percent.
|
289
|
+
#
|
290
|
+
# @!attribute [rw] audience_size_bins
|
291
|
+
# An array of the different audience output sizes.
|
292
|
+
# @return [Array<Integer>]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] audience_size_type
|
295
|
+
# Whether the audience output sizes are defined as an absolute number
|
296
|
+
# or a percentage.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceSizeConfig AWS API Documentation
|
300
|
+
#
|
301
|
+
class AudienceSizeConfig < Struct.new(
|
302
|
+
:audience_size_bins,
|
303
|
+
:audience_size_type)
|
304
|
+
SENSITIVE = []
|
305
|
+
include Aws::Structure
|
306
|
+
end
|
307
|
+
|
308
|
+
# Metadata for a column.
|
309
|
+
#
|
310
|
+
# @!attribute [rw] column_name
|
311
|
+
# The name of a column.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] column_types
|
315
|
+
# The data type of column.
|
316
|
+
# @return [Array<String>]
|
317
|
+
#
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ColumnSchema AWS API Documentation
|
319
|
+
#
|
320
|
+
class ColumnSchema < Struct.new(
|
321
|
+
:column_name,
|
322
|
+
:column_types)
|
323
|
+
SENSITIVE = []
|
324
|
+
include Aws::Structure
|
325
|
+
end
|
326
|
+
|
327
|
+
# Configuration information necessary for the configure audience model
|
328
|
+
# output.
|
329
|
+
#
|
330
|
+
# @!attribute [rw] destination
|
331
|
+
# Defines the Amazon S3 bucket where the configured audience is
|
332
|
+
# stored.
|
333
|
+
# @return [Types::AudienceDestination]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] role_arn
|
336
|
+
# The ARN of the IAM role that can write the Amazon S3 bucket.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConfiguredAudienceModelOutputConfig AWS API Documentation
|
340
|
+
#
|
341
|
+
class ConfiguredAudienceModelOutputConfig < Struct.new(
|
342
|
+
:destination,
|
343
|
+
:role_arn)
|
344
|
+
SENSITIVE = []
|
345
|
+
include Aws::Structure
|
346
|
+
end
|
347
|
+
|
348
|
+
# Information about the configured audience model.
|
349
|
+
#
|
350
|
+
# @!attribute [rw] audience_model_arn
|
351
|
+
# The Amazon Resource Name (ARN) of the audience model that was used
|
352
|
+
# to create the configured audience model.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] configured_audience_model_arn
|
356
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
357
|
+
# you are interested in.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] create_time
|
361
|
+
# The time at which the configured audience model was created.
|
362
|
+
# @return [Time]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] description
|
365
|
+
# The description of the configured audience model.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] name
|
369
|
+
# The name of the configured audience model.
|
370
|
+
# @return [String]
|
371
|
+
#
|
372
|
+
# @!attribute [rw] output_config
|
373
|
+
# The output configuration of the configured audience model.
|
374
|
+
# @return [Types::ConfiguredAudienceModelOutputConfig]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] status
|
377
|
+
# The status of the configured audience model.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] update_time
|
381
|
+
# The most recent time at which the configured audience model was
|
382
|
+
# updated.
|
383
|
+
# @return [Time]
|
384
|
+
#
|
385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConfiguredAudienceModelSummary AWS API Documentation
|
386
|
+
#
|
387
|
+
class ConfiguredAudienceModelSummary < Struct.new(
|
388
|
+
:audience_model_arn,
|
389
|
+
:configured_audience_model_arn,
|
390
|
+
:create_time,
|
391
|
+
:description,
|
392
|
+
:name,
|
393
|
+
:output_config,
|
394
|
+
:status,
|
395
|
+
:update_time)
|
396
|
+
SENSITIVE = []
|
397
|
+
include Aws::Structure
|
398
|
+
end
|
399
|
+
|
400
|
+
# A resource with that name already exists in this region.
|
401
|
+
#
|
402
|
+
# @!attribute [rw] message
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConflictException AWS API Documentation
|
406
|
+
#
|
407
|
+
class ConflictException < Struct.new(
|
408
|
+
:message)
|
409
|
+
SENSITIVE = []
|
410
|
+
include Aws::Structure
|
411
|
+
end
|
412
|
+
|
413
|
+
# @!attribute [rw] description
|
414
|
+
# The description of the audience model.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @!attribute [rw] kms_key_arn
|
418
|
+
# The Amazon Resource Name (ARN) of the KMS key. This key is used to
|
419
|
+
# encrypt and decrypt customer-owned data in the trained ML model and
|
420
|
+
# the associated data.
|
421
|
+
# @return [String]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] name
|
424
|
+
# The name of the audience model resource.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] tags
|
428
|
+
# The optional metadata that you apply to the resource to help you
|
429
|
+
# categorize and organize them. Each tag consists of a key and an
|
430
|
+
# optional value, both of which you define.
|
431
|
+
#
|
432
|
+
# The following basic restrictions apply to tags:
|
433
|
+
#
|
434
|
+
# * Maximum number of tags per resource - 50.
|
435
|
+
#
|
436
|
+
# * For each resource, each tag key must be unique, and each tag key
|
437
|
+
# can have only one value.
|
438
|
+
#
|
439
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
440
|
+
#
|
441
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
442
|
+
#
|
443
|
+
# * If your tagging schema is used across multiple services and
|
444
|
+
# resources, remember that other services may have restrictions on
|
445
|
+
# allowed characters. Generally allowed characters are: letters,
|
446
|
+
# numbers, and spaces representable in UTF-8, and the following
|
447
|
+
# characters: + - = . \_ : / @.
|
448
|
+
#
|
449
|
+
# * Tag keys and values are case sensitive.
|
450
|
+
#
|
451
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of
|
452
|
+
# such as a prefix for keys as it is reserved for AWS use. You
|
453
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
454
|
+
# this prefix. If a tag value has aws as its prefix but the key does
|
455
|
+
# not, then Forecast considers it to be a user tag and will count
|
456
|
+
# against the limit of 50 tags. Tags with only the key prefix of aws
|
457
|
+
# do not count against your tags per resource limit.
|
458
|
+
# @return [Hash<String,String>]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] training_data_end_time
|
461
|
+
# The end date and time of the training window.
|
462
|
+
# @return [Time]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] training_data_start_time
|
465
|
+
# The start date and time of the training window.
|
466
|
+
# @return [Time]
|
467
|
+
#
|
468
|
+
# @!attribute [rw] training_dataset_arn
|
469
|
+
# The Amazon Resource Name (ARN) of the training dataset for this
|
470
|
+
# audience model.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateAudienceModelRequest AWS API Documentation
|
474
|
+
#
|
475
|
+
class CreateAudienceModelRequest < Struct.new(
|
476
|
+
:description,
|
477
|
+
:kms_key_arn,
|
478
|
+
:name,
|
479
|
+
:tags,
|
480
|
+
:training_data_end_time,
|
481
|
+
:training_data_start_time,
|
482
|
+
:training_dataset_arn)
|
483
|
+
SENSITIVE = []
|
484
|
+
include Aws::Structure
|
485
|
+
end
|
486
|
+
|
487
|
+
# @!attribute [rw] audience_model_arn
|
488
|
+
# The Amazon Resource Name (ARN) of the audience model.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateAudienceModelResponse AWS API Documentation
|
492
|
+
#
|
493
|
+
class CreateAudienceModelResponse < Struct.new(
|
494
|
+
:audience_model_arn)
|
495
|
+
SENSITIVE = []
|
496
|
+
include Aws::Structure
|
497
|
+
end
|
498
|
+
|
499
|
+
# @!attribute [rw] audience_model_arn
|
500
|
+
# The Amazon Resource Name (ARN) of the audience model to use for the
|
501
|
+
# configured audience model.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] audience_size_config
|
505
|
+
# Configure the list of output sizes of audiences that can be created
|
506
|
+
# using this configured audience model. A request to
|
507
|
+
# StartAudienceGenerationJob that uses this configured audience model
|
508
|
+
# must have an `audienceSize` selected from this list. You can use the
|
509
|
+
# `ABSOLUTE` AudienceSize to configure out audience sizes using the
|
510
|
+
# count of identifiers in the output. You can use the `Percentage`
|
511
|
+
# AudienceSize to configure sizes in the range 1-100 percent.
|
512
|
+
# @return [Types::AudienceSizeConfig]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] child_resource_tag_on_create_policy
|
515
|
+
# Configure how the service tags audience generation jobs created
|
516
|
+
# using this configured audience model. If you specify `NONE`, the
|
517
|
+
# tags from the StartAudienceGenerationJob request determine the tags
|
518
|
+
# of the audience generation job. If you specify
|
519
|
+
# `FROM_PARENT_RESOURCE`, the audience generation job inherits the
|
520
|
+
# tags from the configured audience model, by default. Tags in the
|
521
|
+
# StartAudienceGenerationJob will override the default.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] description
|
525
|
+
# The description of the configured audience model.
|
526
|
+
# @return [String]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] min_matching_seed_size
|
529
|
+
# The minimum number of users from the seed audience that must match
|
530
|
+
# with users in the training data of the audience model.
|
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
|
+
# @!attribute [rw] tags
|
551
|
+
# The optional metadata that you apply to the resource to help you
|
552
|
+
# categorize and organize them. Each tag consists of a key and an
|
553
|
+
# optional value, both of which you define.
|
554
|
+
#
|
555
|
+
# The following basic restrictions apply to tags:
|
556
|
+
#
|
557
|
+
# * Maximum number of tags per resource - 50.
|
558
|
+
#
|
559
|
+
# * For each resource, each tag key must be unique, and each tag key
|
560
|
+
# can have only one value.
|
561
|
+
#
|
562
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
563
|
+
#
|
564
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
565
|
+
#
|
566
|
+
# * If your tagging schema is used across multiple services and
|
567
|
+
# resources, remember that other services may have restrictions on
|
568
|
+
# allowed characters. Generally allowed characters are: letters,
|
569
|
+
# numbers, and spaces representable in UTF-8, and the following
|
570
|
+
# characters: + - = . \_ : / @.
|
571
|
+
#
|
572
|
+
# * Tag keys and values are case sensitive.
|
573
|
+
#
|
574
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of
|
575
|
+
# such as a prefix for keys as it is reserved for AWS use. You
|
576
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
577
|
+
# this prefix. If a tag value has aws as its prefix but the key does
|
578
|
+
# not, then Forecast considers it to be a user tag and will count
|
579
|
+
# against the limit of 50 tags. Tags with only the key prefix of aws
|
580
|
+
# do not count against your tags per resource limit.
|
581
|
+
# @return [Hash<String,String>]
|
582
|
+
#
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModelRequest AWS API Documentation
|
584
|
+
#
|
585
|
+
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
|
+
:name,
|
592
|
+
:output_config,
|
593
|
+
:shared_audience_metrics,
|
594
|
+
:tags)
|
595
|
+
SENSITIVE = []
|
596
|
+
include Aws::Structure
|
597
|
+
end
|
598
|
+
|
599
|
+
# @!attribute [rw] configured_audience_model_arn
|
600
|
+
# The Amazon Resource Name (ARN) of the configured audience model.
|
601
|
+
# @return [String]
|
602
|
+
#
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModelResponse AWS API Documentation
|
604
|
+
#
|
605
|
+
class CreateConfiguredAudienceModelResponse < Struct.new(
|
606
|
+
:configured_audience_model_arn)
|
607
|
+
SENSITIVE = []
|
608
|
+
include Aws::Structure
|
609
|
+
end
|
610
|
+
|
611
|
+
# @!attribute [rw] description
|
612
|
+
# The description of the training dataset.
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] name
|
616
|
+
# The name of the training dataset. This name must be unique in your
|
617
|
+
# account and region.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @!attribute [rw] role_arn
|
621
|
+
# The ARN of the IAM role that Clean Rooms ML can assume to read the
|
622
|
+
# data referred to in the `dataSource` field of each dataset.
|
623
|
+
#
|
624
|
+
# Passing a role across AWS accounts is not allowed. If you pass a
|
625
|
+
# role that isn't in your account, you get an `AccessDeniedException`
|
626
|
+
# error.
|
627
|
+
# @return [String]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] tags
|
630
|
+
# The optional metadata that you apply to the resource to help you
|
631
|
+
# categorize and organize them. Each tag consists of a key and an
|
632
|
+
# optional value, both of which you define.
|
633
|
+
#
|
634
|
+
# The following basic restrictions apply to tags:
|
635
|
+
#
|
636
|
+
# * Maximum number of tags per resource - 50.
|
637
|
+
#
|
638
|
+
# * For each resource, each tag key must be unique, and each tag key
|
639
|
+
# can have only one value.
|
640
|
+
#
|
641
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
642
|
+
#
|
643
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
644
|
+
#
|
645
|
+
# * If your tagging schema is used across multiple services and
|
646
|
+
# resources, remember that other services may have restrictions on
|
647
|
+
# allowed characters. Generally allowed characters are: letters,
|
648
|
+
# numbers, and spaces representable in UTF-8, and the following
|
649
|
+
# characters: + - = . \_ : / @.
|
650
|
+
#
|
651
|
+
# * Tag keys and values are case sensitive.
|
652
|
+
#
|
653
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of
|
654
|
+
# such as a prefix for keys as it is reserved for AWS use. You
|
655
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
656
|
+
# this prefix. If a tag value has aws as its prefix but the key does
|
657
|
+
# not, then Clean Rooms ML considers it to be a user tag and will
|
658
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
659
|
+
# of aws do not count against your tags per resource limit.
|
660
|
+
# @return [Hash<String,String>]
|
661
|
+
#
|
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>]
|
667
|
+
#
|
668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetRequest AWS API Documentation
|
669
|
+
#
|
670
|
+
class CreateTrainingDatasetRequest < Struct.new(
|
671
|
+
:description,
|
672
|
+
:name,
|
673
|
+
:role_arn,
|
674
|
+
:tags,
|
675
|
+
:training_data)
|
676
|
+
SENSITIVE = []
|
677
|
+
include Aws::Structure
|
678
|
+
end
|
679
|
+
|
680
|
+
# @!attribute [rw] training_dataset_arn
|
681
|
+
# The Amazon Resource Name (ARN) of the training dataset resource.
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetResponse AWS API Documentation
|
685
|
+
#
|
686
|
+
class CreateTrainingDatasetResponse < Struct.new(
|
687
|
+
:training_dataset_arn)
|
688
|
+
SENSITIVE = []
|
689
|
+
include Aws::Structure
|
690
|
+
end
|
691
|
+
|
692
|
+
# Defines information about the Glue data source that contains the
|
693
|
+
# training data.
|
694
|
+
#
|
695
|
+
# @!attribute [rw] glue_data_source
|
696
|
+
# A GlueDataSource object that defines the catalog ID, database name,
|
697
|
+
# and table name for the training data.
|
698
|
+
# @return [Types::GlueDataSource]
|
699
|
+
#
|
700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DataSource AWS API Documentation
|
701
|
+
#
|
702
|
+
class DataSource < Struct.new(
|
703
|
+
:glue_data_source)
|
704
|
+
SENSITIVE = []
|
705
|
+
include Aws::Structure
|
706
|
+
end
|
707
|
+
|
708
|
+
# Defines where the training dataset is located, what type of data it
|
709
|
+
# contains, and how to access the data.
|
710
|
+
#
|
711
|
+
# @!attribute [rw] input_config
|
712
|
+
# A DatasetInputConfig object that defines the data source and schema
|
713
|
+
# mapping.
|
714
|
+
# @return [Types::DatasetInputConfig]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] type
|
717
|
+
# What type of information is found in the dataset.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/Dataset AWS API Documentation
|
721
|
+
#
|
722
|
+
class Dataset < Struct.new(
|
723
|
+
:input_config,
|
724
|
+
:type)
|
725
|
+
SENSITIVE = []
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
729
|
+
# Defines the Glue data source and schema mapping information.
|
730
|
+
#
|
731
|
+
# @!attribute [rw] data_source
|
732
|
+
# A DataSource object that specifies the Glue data source for the
|
733
|
+
# training data.
|
734
|
+
# @return [Types::DataSource]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] schema
|
737
|
+
# The schema information for the training data.
|
738
|
+
# @return [Array<Types::ColumnSchema>]
|
739
|
+
#
|
740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DatasetInputConfig AWS API Documentation
|
741
|
+
#
|
742
|
+
class DatasetInputConfig < Struct.new(
|
743
|
+
:data_source,
|
744
|
+
:schema)
|
745
|
+
SENSITIVE = []
|
746
|
+
include Aws::Structure
|
747
|
+
end
|
748
|
+
|
749
|
+
# @!attribute [rw] audience_generation_job_arn
|
750
|
+
# The Amazon Resource Name (ARN) of the audience generation job that
|
751
|
+
# you want to delete.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJobRequest AWS API Documentation
|
755
|
+
#
|
756
|
+
class DeleteAudienceGenerationJobRequest < Struct.new(
|
757
|
+
:audience_generation_job_arn)
|
758
|
+
SENSITIVE = []
|
759
|
+
include Aws::Structure
|
760
|
+
end
|
761
|
+
|
762
|
+
# @!attribute [rw] audience_model_arn
|
763
|
+
# The Amazon Resource Name (ARN) of the audience model that you want
|
764
|
+
# to delete.
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModelRequest AWS API Documentation
|
768
|
+
#
|
769
|
+
class DeleteAudienceModelRequest < Struct.new(
|
770
|
+
:audience_model_arn)
|
771
|
+
SENSITIVE = []
|
772
|
+
include Aws::Structure
|
773
|
+
end
|
774
|
+
|
775
|
+
# @!attribute [rw] configured_audience_model_arn
|
776
|
+
# The Amazon Resource Name (ARN) of the configured audience model
|
777
|
+
# policy that you want to delete.
|
778
|
+
# @return [String]
|
779
|
+
#
|
780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicyRequest AWS API Documentation
|
781
|
+
#
|
782
|
+
class DeleteConfiguredAudienceModelPolicyRequest < Struct.new(
|
783
|
+
:configured_audience_model_arn)
|
784
|
+
SENSITIVE = []
|
785
|
+
include Aws::Structure
|
786
|
+
end
|
787
|
+
|
788
|
+
# @!attribute [rw] configured_audience_model_arn
|
789
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
790
|
+
# you want to delete.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelRequest AWS API Documentation
|
794
|
+
#
|
795
|
+
class DeleteConfiguredAudienceModelRequest < Struct.new(
|
796
|
+
:configured_audience_model_arn)
|
797
|
+
SENSITIVE = []
|
798
|
+
include Aws::Structure
|
799
|
+
end
|
800
|
+
|
801
|
+
# @!attribute [rw] training_dataset_arn
|
802
|
+
# The Amazon Resource Name (ARN) of the training dataset that you want
|
803
|
+
# to delete.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDatasetRequest AWS API Documentation
|
807
|
+
#
|
808
|
+
class DeleteTrainingDatasetRequest < Struct.new(
|
809
|
+
:training_dataset_arn)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# @!attribute [rw] audience_generation_job_arn
|
815
|
+
# The Amazon Resource Name (ARN) of the audience generation job that
|
816
|
+
# you are interested in.
|
817
|
+
# @return [String]
|
818
|
+
#
|
819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobRequest AWS API Documentation
|
820
|
+
#
|
821
|
+
class GetAudienceGenerationJobRequest < Struct.new(
|
822
|
+
:audience_generation_job_arn)
|
823
|
+
SENSITIVE = []
|
824
|
+
include Aws::Structure
|
825
|
+
end
|
826
|
+
|
827
|
+
# @!attribute [rw] audience_generation_job_arn
|
828
|
+
# The Amazon Resource Name (ARN) of the audience generation job.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] collaboration_id
|
832
|
+
# The identifier of the collaboration that this audience generation
|
833
|
+
# job is associated with.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] configured_audience_model_arn
|
837
|
+
# The Amazon Resource Name (ARN) of the configured audience model used
|
838
|
+
# for this audience generation job.
|
839
|
+
# @return [String]
|
840
|
+
#
|
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]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] include_seed_in_output
|
850
|
+
# Configure whether the seed users are included in the output
|
851
|
+
# audience. By default, Clean Rooms ML removes seed users from the
|
852
|
+
# output audience. If you specify `TRUE`, the seed users will appear
|
853
|
+
# first in the output. Clean Rooms ML does not explicitly reveal
|
854
|
+
# whether a user was in the seed, but the recipient of the audience
|
855
|
+
# will know that the first `minimumSeedSize` count of users are from
|
856
|
+
# the seed.
|
857
|
+
# @return [Boolean]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] metrics
|
860
|
+
# The relevance scores for different audience sizes.
|
861
|
+
# @return [Types::AudienceQualityMetrics]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] name
|
864
|
+
# The name of the audience generation job.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] seed_audience
|
868
|
+
# The seed audience that was used for this audience generation job.
|
869
|
+
# This field will be null if the account calling the API is the
|
870
|
+
# account that started this audience generation job.
|
871
|
+
# @return [Types::AudienceGenerationJobDataSource]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] started_by
|
874
|
+
# The AWS account that started this audience generation job.
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] status
|
878
|
+
# The status of the audience generation job.
|
879
|
+
# @return [String]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] status_details
|
882
|
+
# Details about the status of the audience generation job.
|
883
|
+
# @return [Types::StatusDetails]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] tags
|
886
|
+
# The tags that are associated to this audience generation job.
|
887
|
+
# @return [Hash<String,String>]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] update_time
|
890
|
+
# The most recent time at which the audience generation job was
|
891
|
+
# updated.
|
892
|
+
# @return [Time]
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobResponse AWS API Documentation
|
895
|
+
#
|
896
|
+
class GetAudienceGenerationJobResponse < Struct.new(
|
897
|
+
:audience_generation_job_arn,
|
898
|
+
:collaboration_id,
|
899
|
+
:configured_audience_model_arn,
|
900
|
+
:create_time,
|
901
|
+
:description,
|
902
|
+
:include_seed_in_output,
|
903
|
+
:metrics,
|
904
|
+
:name,
|
905
|
+
:seed_audience,
|
906
|
+
:started_by,
|
907
|
+
:status,
|
908
|
+
:status_details,
|
909
|
+
:tags,
|
910
|
+
:update_time)
|
911
|
+
SENSITIVE = []
|
912
|
+
include Aws::Structure
|
913
|
+
end
|
914
|
+
|
915
|
+
# @!attribute [rw] audience_model_arn
|
916
|
+
# The Amazon Resource Name (ARN) of the audience model that you are
|
917
|
+
# interested in.
|
918
|
+
# @return [String]
|
919
|
+
#
|
920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelRequest AWS API Documentation
|
921
|
+
#
|
922
|
+
class GetAudienceModelRequest < Struct.new(
|
923
|
+
:audience_model_arn)
|
924
|
+
SENSITIVE = []
|
925
|
+
include Aws::Structure
|
926
|
+
end
|
927
|
+
|
928
|
+
# @!attribute [rw] audience_model_arn
|
929
|
+
# The Amazon Resource Name (ARN) of the audience model.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] create_time
|
933
|
+
# The time at which the audience model was created.
|
934
|
+
# @return [Time]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] description
|
937
|
+
# The description of the audience model.
|
938
|
+
# @return [String]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] kms_key_arn
|
941
|
+
# The KMS key ARN used for the audience model.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] metrics
|
945
|
+
# Accuracy metrics for the model.
|
946
|
+
# @return [Array<Types::AudienceModelMetric>]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] name
|
949
|
+
# The name of the audience model.
|
950
|
+
# @return [String]
|
951
|
+
#
|
952
|
+
# @!attribute [rw] status
|
953
|
+
# The status of the audience model.
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @!attribute [rw] status_details
|
957
|
+
# Details about the status of the audience model.
|
958
|
+
# @return [Types::StatusDetails]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] tags
|
961
|
+
# The tags that are assigned to the audience model.
|
962
|
+
# @return [Hash<String,String>]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] training_data_end_time
|
965
|
+
# The end date specified for the training window.
|
966
|
+
# @return [Time]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] training_data_start_time
|
969
|
+
# The start date specified for the training window.
|
970
|
+
# @return [Time]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] training_dataset_arn
|
973
|
+
# The Amazon Resource Name (ARN) of the training dataset that was used
|
974
|
+
# for this audience model.
|
975
|
+
# @return [String]
|
976
|
+
#
|
977
|
+
# @!attribute [rw] update_time
|
978
|
+
# The most recent time at which the audience model was updated.
|
979
|
+
# @return [Time]
|
980
|
+
#
|
981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelResponse AWS API Documentation
|
982
|
+
#
|
983
|
+
class GetAudienceModelResponse < Struct.new(
|
984
|
+
:audience_model_arn,
|
985
|
+
:create_time,
|
986
|
+
:description,
|
987
|
+
:kms_key_arn,
|
988
|
+
:metrics,
|
989
|
+
:name,
|
990
|
+
:status,
|
991
|
+
:status_details,
|
992
|
+
:tags,
|
993
|
+
:training_data_end_time,
|
994
|
+
:training_data_start_time,
|
995
|
+
:training_dataset_arn,
|
996
|
+
:update_time)
|
997
|
+
SENSITIVE = []
|
998
|
+
include Aws::Structure
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# @!attribute [rw] configured_audience_model_arn
|
1002
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1003
|
+
# you are interested in.
|
1004
|
+
# @return [String]
|
1005
|
+
#
|
1006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyRequest AWS API Documentation
|
1007
|
+
#
|
1008
|
+
class GetConfiguredAudienceModelPolicyRequest < Struct.new(
|
1009
|
+
:configured_audience_model_arn)
|
1010
|
+
SENSITIVE = []
|
1011
|
+
include Aws::Structure
|
1012
|
+
end
|
1013
|
+
|
1014
|
+
# @!attribute [rw] configured_audience_model_arn
|
1015
|
+
# The Amazon Resource Name (ARN) of the configured audience model.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] configured_audience_model_policy
|
1019
|
+
# The configured audience model policy. This is a JSON IAM resource
|
1020
|
+
# policy.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] policy_hash
|
1024
|
+
# A cryptographic hash of the contents of the policy used to prevent
|
1025
|
+
# unexpected concurrent modification of the policy.
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyResponse AWS API Documentation
|
1029
|
+
#
|
1030
|
+
class GetConfiguredAudienceModelPolicyResponse < Struct.new(
|
1031
|
+
:configured_audience_model_arn,
|
1032
|
+
:configured_audience_model_policy,
|
1033
|
+
:policy_hash)
|
1034
|
+
SENSITIVE = []
|
1035
|
+
include Aws::Structure
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# @!attribute [rw] configured_audience_model_arn
|
1039
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1040
|
+
# you are interested in.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelRequest AWS API Documentation
|
1044
|
+
#
|
1045
|
+
class GetConfiguredAudienceModelRequest < Struct.new(
|
1046
|
+
:configured_audience_model_arn)
|
1047
|
+
SENSITIVE = []
|
1048
|
+
include Aws::Structure
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# @!attribute [rw] audience_model_arn
|
1052
|
+
# The Amazon Resource Name (ARN) of the audience model used for this
|
1053
|
+
# configured audience model.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] audience_size_config
|
1057
|
+
# The list of output sizes of audiences that can be created using this
|
1058
|
+
# configured audience model. A request to StartAudienceGenerationJob
|
1059
|
+
# that uses this configured audience model must have an `audienceSize`
|
1060
|
+
# selected from this list. You can use the `ABSOLUTE` AudienceSize to
|
1061
|
+
# configure out audience sizes using the count of identifiers in the
|
1062
|
+
# output. You can use the `Percentage` AudienceSize to configure sizes
|
1063
|
+
# in the range 1-100 percent.
|
1064
|
+
# @return [Types::AudienceSizeConfig]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] child_resource_tag_on_create_policy
|
1067
|
+
# Provides the `childResourceTagOnCreatePolicy` that was used for this
|
1068
|
+
# configured audience model.
|
1069
|
+
# @return [String]
|
1070
|
+
#
|
1071
|
+
# @!attribute [rw] configured_audience_model_arn
|
1072
|
+
# The Amazon Resource Name (ARN) of the configured audience model.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @!attribute [rw] create_time
|
1076
|
+
# The time at which the configured audience model was created.
|
1077
|
+
# @return [Time]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] description
|
1080
|
+
# The description of the configured audience model.
|
1081
|
+
# @return [String]
|
1082
|
+
#
|
1083
|
+
# @!attribute [rw] min_matching_seed_size
|
1084
|
+
# The minimum number of users from the seed audience that must match
|
1085
|
+
# with users in the training data of the audience model.
|
1086
|
+
# @return [Integer]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] name
|
1089
|
+
# The name of the configured audience model.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] output_config
|
1093
|
+
# The output configuration of the configured audience model
|
1094
|
+
# @return [Types::ConfiguredAudienceModelOutputConfig]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] shared_audience_metrics
|
1097
|
+
# Whether audience metrics are shared.
|
1098
|
+
# @return [Array<String>]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] status
|
1101
|
+
# The status of the configured audience model.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] tags
|
1105
|
+
# The tags that are associated to this configured audience model.
|
1106
|
+
# @return [Hash<String,String>]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] update_time
|
1109
|
+
# The most recent time at which the configured audience model was
|
1110
|
+
# updated.
|
1111
|
+
# @return [Time]
|
1112
|
+
#
|
1113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelResponse AWS API Documentation
|
1114
|
+
#
|
1115
|
+
class GetConfiguredAudienceModelResponse < Struct.new(
|
1116
|
+
:audience_model_arn,
|
1117
|
+
:audience_size_config,
|
1118
|
+
:child_resource_tag_on_create_policy,
|
1119
|
+
:configured_audience_model_arn,
|
1120
|
+
:create_time,
|
1121
|
+
:description,
|
1122
|
+
:min_matching_seed_size,
|
1123
|
+
:name,
|
1124
|
+
:output_config,
|
1125
|
+
:shared_audience_metrics,
|
1126
|
+
:status,
|
1127
|
+
:tags,
|
1128
|
+
:update_time)
|
1129
|
+
SENSITIVE = []
|
1130
|
+
include Aws::Structure
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# @!attribute [rw] training_dataset_arn
|
1134
|
+
# The Amazon Resource Name (ARN) of the training dataset that you are
|
1135
|
+
# interested in.
|
1136
|
+
# @return [String]
|
1137
|
+
#
|
1138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetRequest AWS API Documentation
|
1139
|
+
#
|
1140
|
+
class GetTrainingDatasetRequest < Struct.new(
|
1141
|
+
:training_dataset_arn)
|
1142
|
+
SENSITIVE = []
|
1143
|
+
include Aws::Structure
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
# @!attribute [rw] create_time
|
1147
|
+
# The time at which the training dataset was created.
|
1148
|
+
# @return [Time]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] description
|
1151
|
+
# The description of the training dataset.
|
1152
|
+
# @return [String]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] name
|
1155
|
+
# The name of the training dataset.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] role_arn
|
1159
|
+
# The IAM role used to read the training data.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] status
|
1163
|
+
# The status of the training dataset.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] tags
|
1167
|
+
# The tags that are assigned to this training dataset.
|
1168
|
+
# @return [Hash<String,String>]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] training_data
|
1171
|
+
# Metadata about the requested training data.
|
1172
|
+
# @return [Array<Types::Dataset>]
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] training_dataset_arn
|
1175
|
+
# The Amazon Resource Name (ARN) of the training dataset.
|
1176
|
+
# @return [String]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] update_time
|
1179
|
+
# The most recent time at which the training dataset was updated.
|
1180
|
+
# @return [Time]
|
1181
|
+
#
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetResponse AWS API Documentation
|
1183
|
+
#
|
1184
|
+
class GetTrainingDatasetResponse < Struct.new(
|
1185
|
+
:create_time,
|
1186
|
+
:description,
|
1187
|
+
:name,
|
1188
|
+
:role_arn,
|
1189
|
+
:status,
|
1190
|
+
:tags,
|
1191
|
+
:training_data,
|
1192
|
+
:training_dataset_arn,
|
1193
|
+
:update_time)
|
1194
|
+
SENSITIVE = []
|
1195
|
+
include Aws::Structure
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# Defines the Glue data source that contains the training data.
|
1199
|
+
#
|
1200
|
+
# @!attribute [rw] catalog_id
|
1201
|
+
# The Glue catalog that contains the training data.
|
1202
|
+
# @return [String]
|
1203
|
+
#
|
1204
|
+
# @!attribute [rw] database_name
|
1205
|
+
# The Glue database that contains the training data.
|
1206
|
+
# @return [String]
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] table_name
|
1209
|
+
# The Glue table that contains the training data.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GlueDataSource AWS API Documentation
|
1213
|
+
#
|
1214
|
+
class GlueDataSource < Struct.new(
|
1215
|
+
:catalog_id,
|
1216
|
+
:database_name,
|
1217
|
+
:table_name)
|
1218
|
+
SENSITIVE = []
|
1219
|
+
include Aws::Structure
|
1220
|
+
end
|
1221
|
+
|
1222
|
+
# @!attribute [rw] audience_generation_job_arn
|
1223
|
+
# The Amazon Resource Name (ARN) of the audience generation job that
|
1224
|
+
# you are interested in.
|
1225
|
+
# @return [String]
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] max_results
|
1228
|
+
# The maximum size of the results that is returned per call.
|
1229
|
+
# @return [Integer]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] next_token
|
1232
|
+
# The token value retrieved from a previous call to access the next
|
1233
|
+
# page of results.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsRequest AWS API Documentation
|
1237
|
+
#
|
1238
|
+
class ListAudienceExportJobsRequest < Struct.new(
|
1239
|
+
:audience_generation_job_arn,
|
1240
|
+
:max_results,
|
1241
|
+
:next_token)
|
1242
|
+
SENSITIVE = []
|
1243
|
+
include Aws::Structure
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# @!attribute [rw] audience_export_jobs
|
1247
|
+
# The audience export jobs that match the request.
|
1248
|
+
# @return [Array<Types::AudienceExportJobSummary>]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] next_token
|
1251
|
+
# The token value retrieved from a previous call to access the next
|
1252
|
+
# page of results.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsResponse AWS API Documentation
|
1256
|
+
#
|
1257
|
+
class ListAudienceExportJobsResponse < Struct.new(
|
1258
|
+
:audience_export_jobs,
|
1259
|
+
:next_token)
|
1260
|
+
SENSITIVE = []
|
1261
|
+
include Aws::Structure
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
# @!attribute [rw] collaboration_id
|
1265
|
+
# The identifier of the collaboration that contains the audience
|
1266
|
+
# generation jobs that you are interested in.
|
1267
|
+
# @return [String]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] configured_audience_model_arn
|
1270
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1271
|
+
# was used for the audience generation jobs that you are interested
|
1272
|
+
# in.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] max_results
|
1276
|
+
# The maximum size of the results that is returned per call.
|
1277
|
+
# @return [Integer]
|
1278
|
+
#
|
1279
|
+
# @!attribute [rw] next_token
|
1280
|
+
# The token value retrieved from a previous call to access the next
|
1281
|
+
# page of results.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsRequest AWS API Documentation
|
1285
|
+
#
|
1286
|
+
class ListAudienceGenerationJobsRequest < Struct.new(
|
1287
|
+
:collaboration_id,
|
1288
|
+
:configured_audience_model_arn,
|
1289
|
+
:max_results,
|
1290
|
+
:next_token)
|
1291
|
+
SENSITIVE = []
|
1292
|
+
include Aws::Structure
|
1293
|
+
end
|
1294
|
+
|
1295
|
+
# @!attribute [rw] audience_generation_jobs
|
1296
|
+
# The audience generation jobs that match the request.
|
1297
|
+
# @return [Array<Types::AudienceGenerationJobSummary>]
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] next_token
|
1300
|
+
# The token value retrieved from a previous call to access the next
|
1301
|
+
# page of results.
|
1302
|
+
# @return [String]
|
1303
|
+
#
|
1304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsResponse AWS API Documentation
|
1305
|
+
#
|
1306
|
+
class ListAudienceGenerationJobsResponse < Struct.new(
|
1307
|
+
:audience_generation_jobs,
|
1308
|
+
:next_token)
|
1309
|
+
SENSITIVE = []
|
1310
|
+
include Aws::Structure
|
1311
|
+
end
|
1312
|
+
|
1313
|
+
# @!attribute [rw] max_results
|
1314
|
+
# The maximum size of the results that is returned per call.
|
1315
|
+
# @return [Integer]
|
1316
|
+
#
|
1317
|
+
# @!attribute [rw] next_token
|
1318
|
+
# The token value retrieved from a previous call to access the next
|
1319
|
+
# page of results.
|
1320
|
+
# @return [String]
|
1321
|
+
#
|
1322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsRequest AWS API Documentation
|
1323
|
+
#
|
1324
|
+
class ListAudienceModelsRequest < Struct.new(
|
1325
|
+
:max_results,
|
1326
|
+
:next_token)
|
1327
|
+
SENSITIVE = []
|
1328
|
+
include Aws::Structure
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# @!attribute [rw] audience_models
|
1332
|
+
# The audience models that match the request.
|
1333
|
+
# @return [Array<Types::AudienceModelSummary>]
|
1334
|
+
#
|
1335
|
+
# @!attribute [rw] next_token
|
1336
|
+
# The token value retrieved from a previous call to access the next
|
1337
|
+
# page of results.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsResponse AWS API Documentation
|
1341
|
+
#
|
1342
|
+
class ListAudienceModelsResponse < Struct.new(
|
1343
|
+
:audience_models,
|
1344
|
+
:next_token)
|
1345
|
+
SENSITIVE = []
|
1346
|
+
include Aws::Structure
|
1347
|
+
end
|
1348
|
+
|
1349
|
+
# @!attribute [rw] max_results
|
1350
|
+
# The maximum size of the results that is returned per call.
|
1351
|
+
# @return [Integer]
|
1352
|
+
#
|
1353
|
+
# @!attribute [rw] next_token
|
1354
|
+
# The token value retrieved from a previous call to access the next
|
1355
|
+
# page of results.
|
1356
|
+
# @return [String]
|
1357
|
+
#
|
1358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsRequest AWS API Documentation
|
1359
|
+
#
|
1360
|
+
class ListConfiguredAudienceModelsRequest < Struct.new(
|
1361
|
+
:max_results,
|
1362
|
+
:next_token)
|
1363
|
+
SENSITIVE = []
|
1364
|
+
include Aws::Structure
|
1365
|
+
end
|
1366
|
+
|
1367
|
+
# @!attribute [rw] configured_audience_models
|
1368
|
+
# The configured audience models.
|
1369
|
+
# @return [Array<Types::ConfiguredAudienceModelSummary>]
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] next_token
|
1372
|
+
# The token value retrieved from a previous call to access the next
|
1373
|
+
# page of results.
|
1374
|
+
# @return [String]
|
1375
|
+
#
|
1376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsResponse AWS API Documentation
|
1377
|
+
#
|
1378
|
+
class ListConfiguredAudienceModelsResponse < Struct.new(
|
1379
|
+
:configured_audience_models,
|
1380
|
+
:next_token)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# @!attribute [rw] resource_arn
|
1386
|
+
# The Amazon Resource Name (ARN) of the resource that you are
|
1387
|
+
# interested in.
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceRequest AWS API Documentation
|
1391
|
+
#
|
1392
|
+
class ListTagsForResourceRequest < Struct.new(
|
1393
|
+
:resource_arn)
|
1394
|
+
SENSITIVE = []
|
1395
|
+
include Aws::Structure
|
1396
|
+
end
|
1397
|
+
|
1398
|
+
# @!attribute [rw] tags
|
1399
|
+
# The tags that are associated with the resource.
|
1400
|
+
# @return [Hash<String,String>]
|
1401
|
+
#
|
1402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceResponse AWS API Documentation
|
1403
|
+
#
|
1404
|
+
class ListTagsForResourceResponse < Struct.new(
|
1405
|
+
:tags)
|
1406
|
+
SENSITIVE = []
|
1407
|
+
include Aws::Structure
|
1408
|
+
end
|
1409
|
+
|
1410
|
+
# @!attribute [rw] max_results
|
1411
|
+
# The maximum size of the results that is returned per call.
|
1412
|
+
# @return [Integer]
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] next_token
|
1415
|
+
# The token value retrieved from a previous call to access the next
|
1416
|
+
# page of results.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsRequest AWS API Documentation
|
1420
|
+
#
|
1421
|
+
class ListTrainingDatasetsRequest < Struct.new(
|
1422
|
+
:max_results,
|
1423
|
+
:next_token)
|
1424
|
+
SENSITIVE = []
|
1425
|
+
include Aws::Structure
|
1426
|
+
end
|
1427
|
+
|
1428
|
+
# @!attribute [rw] next_token
|
1429
|
+
# The token value retrieved from a previous call to access the next
|
1430
|
+
# page of results.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] training_datasets
|
1434
|
+
# The training datasets that match the request.
|
1435
|
+
# @return [Array<Types::TrainingDatasetSummary>]
|
1436
|
+
#
|
1437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsResponse AWS API Documentation
|
1438
|
+
#
|
1439
|
+
class ListTrainingDatasetsResponse < Struct.new(
|
1440
|
+
:next_token,
|
1441
|
+
:training_datasets)
|
1442
|
+
SENSITIVE = []
|
1443
|
+
include Aws::Structure
|
1444
|
+
end
|
1445
|
+
|
1446
|
+
# @!attribute [rw] configured_audience_model_arn
|
1447
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1448
|
+
# the resource policy will govern.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] configured_audience_model_policy
|
1452
|
+
# The IAM resource policy.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] policy_existence_condition
|
1456
|
+
# Use this to prevent unexpected concurrent modification of the
|
1457
|
+
# policy.
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] previous_policy_hash
|
1461
|
+
# A cryptographic hash of the contents of the policy used to prevent
|
1462
|
+
# unexpected concurrent modification of the policy.
|
1463
|
+
# @return [String]
|
1464
|
+
#
|
1465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutConfiguredAudienceModelPolicyRequest AWS API Documentation
|
1466
|
+
#
|
1467
|
+
class PutConfiguredAudienceModelPolicyRequest < Struct.new(
|
1468
|
+
:configured_audience_model_arn,
|
1469
|
+
:configured_audience_model_policy,
|
1470
|
+
:policy_existence_condition,
|
1471
|
+
:previous_policy_hash)
|
1472
|
+
SENSITIVE = []
|
1473
|
+
include Aws::Structure
|
1474
|
+
end
|
1475
|
+
|
1476
|
+
# @!attribute [rw] configured_audience_model_policy
|
1477
|
+
# The IAM resource policy.
|
1478
|
+
# @return [String]
|
1479
|
+
#
|
1480
|
+
# @!attribute [rw] policy_hash
|
1481
|
+
# A cryptographic hash of the contents of the policy used to prevent
|
1482
|
+
# unexpected concurrent modification of the policy.
|
1483
|
+
# @return [String]
|
1484
|
+
#
|
1485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutConfiguredAudienceModelPolicyResponse AWS API Documentation
|
1486
|
+
#
|
1487
|
+
class PutConfiguredAudienceModelPolicyResponse < Struct.new(
|
1488
|
+
:configured_audience_model_policy,
|
1489
|
+
:policy_hash)
|
1490
|
+
SENSITIVE = []
|
1491
|
+
include Aws::Structure
|
1492
|
+
end
|
1493
|
+
|
1494
|
+
# The relevance score of a generated audience.
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] audience_size
|
1497
|
+
# The size of the generated audience. Must match one of the sizes in
|
1498
|
+
# the configured audience model.
|
1499
|
+
# @return [Types::AudienceSize]
|
1500
|
+
#
|
1501
|
+
# @!attribute [rw] score
|
1502
|
+
# The relevance score of the generated audience.
|
1503
|
+
# @return [Float]
|
1504
|
+
#
|
1505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/RelevanceMetric AWS API Documentation
|
1506
|
+
#
|
1507
|
+
class RelevanceMetric < Struct.new(
|
1508
|
+
:audience_size,
|
1509
|
+
:score)
|
1510
|
+
SENSITIVE = []
|
1511
|
+
include Aws::Structure
|
1512
|
+
end
|
1513
|
+
|
1514
|
+
# The resource you are requesting does not exist.
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] message
|
1517
|
+
# @return [String]
|
1518
|
+
#
|
1519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ResourceNotFoundException AWS API Documentation
|
1520
|
+
#
|
1521
|
+
class ResourceNotFoundException < Struct.new(
|
1522
|
+
:message)
|
1523
|
+
SENSITIVE = []
|
1524
|
+
include Aws::Structure
|
1525
|
+
end
|
1526
|
+
|
1527
|
+
# Provides information about an Amazon S3 bucket and path.
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] s3_uri
|
1530
|
+
# The Amazon S3 location URI.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/S3ConfigMap AWS API Documentation
|
1534
|
+
#
|
1535
|
+
class S3ConfigMap < Struct.new(
|
1536
|
+
:s3_uri)
|
1537
|
+
SENSITIVE = []
|
1538
|
+
include Aws::Structure
|
1539
|
+
end
|
1540
|
+
|
1541
|
+
# You have exceeded your service quota.
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] message
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ServiceQuotaExceededException AWS API Documentation
|
1547
|
+
#
|
1548
|
+
class ServiceQuotaExceededException < Struct.new(
|
1549
|
+
:message)
|
1550
|
+
SENSITIVE = []
|
1551
|
+
include Aws::Structure
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# @!attribute [rw] audience_generation_job_arn
|
1555
|
+
# The Amazon Resource Name (ARN) of the audience generation job that
|
1556
|
+
# you want to export.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] audience_size
|
1560
|
+
# The size of the generated audience. Must match one of the sizes in
|
1561
|
+
# the configured audience model.
|
1562
|
+
# @return [Types::AudienceSize]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] description
|
1565
|
+
# The description of the audience export job.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] name
|
1569
|
+
# The name of the audience export job.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceExportJobRequest AWS API Documentation
|
1573
|
+
#
|
1574
|
+
class StartAudienceExportJobRequest < Struct.new(
|
1575
|
+
:audience_generation_job_arn,
|
1576
|
+
:audience_size,
|
1577
|
+
:description,
|
1578
|
+
:name)
|
1579
|
+
SENSITIVE = []
|
1580
|
+
include Aws::Structure
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
# @!attribute [rw] collaboration_id
|
1584
|
+
# The identifier of the collaboration that contains the audience
|
1585
|
+
# generation job.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] configured_audience_model_arn
|
1589
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1590
|
+
# is used for this audience generation job.
|
1591
|
+
# @return [String]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] description
|
1594
|
+
# The description of the audience generation job.
|
1595
|
+
# @return [String]
|
1596
|
+
#
|
1597
|
+
# @!attribute [rw] include_seed_in_output
|
1598
|
+
# Whether the seed audience is included in the audience generation
|
1599
|
+
# output.
|
1600
|
+
# @return [Boolean]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] name
|
1603
|
+
# The name of the audience generation job.
|
1604
|
+
# @return [String]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] seed_audience
|
1607
|
+
# The seed audience that is used to generate the audience.
|
1608
|
+
# @return [Types::AudienceGenerationJobDataSource]
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] tags
|
1611
|
+
# The optional metadata that you apply to the resource to help you
|
1612
|
+
# categorize and organize them. Each tag consists of a key and an
|
1613
|
+
# optional value, both of which you define.
|
1614
|
+
#
|
1615
|
+
# The following basic restrictions apply to tags:
|
1616
|
+
#
|
1617
|
+
# * Maximum number of tags per resource - 50.
|
1618
|
+
#
|
1619
|
+
# * For each resource, each tag key must be unique, and each tag key
|
1620
|
+
# can have only one value.
|
1621
|
+
#
|
1622
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1623
|
+
#
|
1624
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1625
|
+
#
|
1626
|
+
# * If your tagging schema is used across multiple services and
|
1627
|
+
# resources, remember that other services may have restrictions on
|
1628
|
+
# allowed characters. Generally allowed characters are: letters,
|
1629
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1630
|
+
# characters: + - = . \_ : / @.
|
1631
|
+
#
|
1632
|
+
# * Tag keys and values are case sensitive.
|
1633
|
+
#
|
1634
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of
|
1635
|
+
# such as a prefix for keys as it is reserved for AWS use. You
|
1636
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
1637
|
+
# this prefix. If a tag value has aws as its prefix but the key does
|
1638
|
+
# not, then Forecast considers it to be a user tag and will count
|
1639
|
+
# against the limit of 50 tags. Tags with only the key prefix of aws
|
1640
|
+
# do not count against your tags per resource limit.
|
1641
|
+
# @return [Hash<String,String>]
|
1642
|
+
#
|
1643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJobRequest AWS API Documentation
|
1644
|
+
#
|
1645
|
+
class StartAudienceGenerationJobRequest < Struct.new(
|
1646
|
+
:collaboration_id,
|
1647
|
+
:configured_audience_model_arn,
|
1648
|
+
:description,
|
1649
|
+
:include_seed_in_output,
|
1650
|
+
:name,
|
1651
|
+
:seed_audience,
|
1652
|
+
:tags)
|
1653
|
+
SENSITIVE = []
|
1654
|
+
include Aws::Structure
|
1655
|
+
end
|
1656
|
+
|
1657
|
+
# @!attribute [rw] audience_generation_job_arn
|
1658
|
+
# The Amazon Resource Name (ARN) of the audience generation job.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJobResponse AWS API Documentation
|
1662
|
+
#
|
1663
|
+
class StartAudienceGenerationJobResponse < Struct.new(
|
1664
|
+
:audience_generation_job_arn)
|
1665
|
+
SENSITIVE = []
|
1666
|
+
include Aws::Structure
|
1667
|
+
end
|
1668
|
+
|
1669
|
+
# Details about the status of a resource.
|
1670
|
+
#
|
1671
|
+
# @!attribute [rw] message
|
1672
|
+
# The error message that was returned. The message is intended for
|
1673
|
+
# human consumption and can change at any time. Use the `statusCode`
|
1674
|
+
# for programmatic error handling.
|
1675
|
+
# @return [String]
|
1676
|
+
#
|
1677
|
+
# @!attribute [rw] status_code
|
1678
|
+
# The status code that was returned. The status code is intended for
|
1679
|
+
# programmatic error handling. Clean Rooms ML will not change the
|
1680
|
+
# status code for existing error conditions.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StatusDetails AWS API Documentation
|
1684
|
+
#
|
1685
|
+
class StatusDetails < Struct.new(
|
1686
|
+
:message,
|
1687
|
+
:status_code)
|
1688
|
+
SENSITIVE = []
|
1689
|
+
include Aws::Structure
|
1690
|
+
end
|
1691
|
+
|
1692
|
+
# @!attribute [rw] resource_arn
|
1693
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
1694
|
+
# assign tags.
|
1695
|
+
# @return [String]
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] tags
|
1698
|
+
# The optional metadata that you apply to the resource to help you
|
1699
|
+
# categorize and organize them. Each tag consists of a key and an
|
1700
|
+
# optional value, both of which you define.
|
1701
|
+
#
|
1702
|
+
# The following basic restrictions apply to tags:
|
1703
|
+
#
|
1704
|
+
# * Maximum number of tags per resource - 50.
|
1705
|
+
#
|
1706
|
+
# * For each resource, each tag key must be unique, and each tag key
|
1707
|
+
# can have only one value.
|
1708
|
+
#
|
1709
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1710
|
+
#
|
1711
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1712
|
+
#
|
1713
|
+
# * If your tagging schema is used across multiple services and
|
1714
|
+
# resources, remember that other services may have restrictions on
|
1715
|
+
# allowed characters. Generally allowed characters are: letters,
|
1716
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1717
|
+
# characters: + - = . \_ : / @.
|
1718
|
+
#
|
1719
|
+
# * Tag keys and values are case sensitive.
|
1720
|
+
#
|
1721
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of
|
1722
|
+
# such as a prefix for keys as it is reserved for AWS use. You
|
1723
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
1724
|
+
# this prefix. If a tag value has aws as its prefix but the key does
|
1725
|
+
# not, then Forecast considers it to be a user tag and will count
|
1726
|
+
# against the limit of 50 tags. Tags with only the key prefix of aws
|
1727
|
+
# do not count against your tags per resource limit.
|
1728
|
+
# @return [Hash<String,String>]
|
1729
|
+
#
|
1730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TagResourceRequest AWS API Documentation
|
1731
|
+
#
|
1732
|
+
class TagResourceRequest < Struct.new(
|
1733
|
+
:resource_arn,
|
1734
|
+
:tags)
|
1735
|
+
SENSITIVE = []
|
1736
|
+
include Aws::Structure
|
1737
|
+
end
|
1738
|
+
|
1739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TagResourceResponse AWS API Documentation
|
1740
|
+
#
|
1741
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1742
|
+
|
1743
|
+
# Provides information about the training dataset.
|
1744
|
+
#
|
1745
|
+
# @!attribute [rw] create_time
|
1746
|
+
# The time at which the training dataset was created.
|
1747
|
+
# @return [Time]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] description
|
1750
|
+
# The description of the training dataset.
|
1751
|
+
# @return [String]
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] name
|
1754
|
+
# The name of the training dataset.
|
1755
|
+
# @return [String]
|
1756
|
+
#
|
1757
|
+
# @!attribute [rw] status
|
1758
|
+
# The status of the training dataset.
|
1759
|
+
# @return [String]
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] training_dataset_arn
|
1762
|
+
# The Amazon Resource Name (ARN) of the training dataset.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] update_time
|
1766
|
+
# The most recent time at which the training dataset was updated.
|
1767
|
+
# @return [Time]
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainingDatasetSummary AWS API Documentation
|
1770
|
+
#
|
1771
|
+
class TrainingDatasetSummary < Struct.new(
|
1772
|
+
:create_time,
|
1773
|
+
:description,
|
1774
|
+
:name,
|
1775
|
+
:status,
|
1776
|
+
:training_dataset_arn,
|
1777
|
+
:update_time)
|
1778
|
+
SENSITIVE = []
|
1779
|
+
include Aws::Structure
|
1780
|
+
end
|
1781
|
+
|
1782
|
+
# @!attribute [rw] resource_arn
|
1783
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
1784
|
+
# remove tags from.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] tag_keys
|
1788
|
+
# The key values of tags that you want to remove.
|
1789
|
+
# @return [Array<String>]
|
1790
|
+
#
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UntagResourceRequest AWS API Documentation
|
1792
|
+
#
|
1793
|
+
class UntagResourceRequest < Struct.new(
|
1794
|
+
:resource_arn,
|
1795
|
+
:tag_keys)
|
1796
|
+
SENSITIVE = []
|
1797
|
+
include Aws::Structure
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UntagResourceResponse AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1803
|
+
|
1804
|
+
# @!attribute [rw] audience_model_arn
|
1805
|
+
# The Amazon Resource Name (ARN) of the new audience model that you
|
1806
|
+
# want to use.
|
1807
|
+
# @return [String]
|
1808
|
+
#
|
1809
|
+
# @!attribute [rw] audience_size_config
|
1810
|
+
# The new audience size configuration.
|
1811
|
+
# @return [Types::AudienceSizeConfig]
|
1812
|
+
#
|
1813
|
+
# @!attribute [rw] configured_audience_model_arn
|
1814
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1815
|
+
# you want to update.
|
1816
|
+
# @return [String]
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] description
|
1819
|
+
# The new description of the configured audience model.
|
1820
|
+
# @return [String]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] min_matching_seed_size
|
1823
|
+
# The minimum number of users from the seed audience that must match
|
1824
|
+
# with users in the training data of the audience model.
|
1825
|
+
# @return [Integer]
|
1826
|
+
#
|
1827
|
+
# @!attribute [rw] output_config
|
1828
|
+
# The new output configuration.
|
1829
|
+
# @return [Types::ConfiguredAudienceModelOutputConfig]
|
1830
|
+
#
|
1831
|
+
# @!attribute [rw] shared_audience_metrics
|
1832
|
+
# The new value for whether to share audience metrics.
|
1833
|
+
# @return [Array<String>]
|
1834
|
+
#
|
1835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModelRequest AWS API Documentation
|
1836
|
+
#
|
1837
|
+
class UpdateConfiguredAudienceModelRequest < Struct.new(
|
1838
|
+
:audience_model_arn,
|
1839
|
+
:audience_size_config,
|
1840
|
+
:configured_audience_model_arn,
|
1841
|
+
:description,
|
1842
|
+
:min_matching_seed_size,
|
1843
|
+
:output_config,
|
1844
|
+
:shared_audience_metrics)
|
1845
|
+
SENSITIVE = []
|
1846
|
+
include Aws::Structure
|
1847
|
+
end
|
1848
|
+
|
1849
|
+
# @!attribute [rw] configured_audience_model_arn
|
1850
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1851
|
+
# was updated.
|
1852
|
+
# @return [String]
|
1853
|
+
#
|
1854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModelResponse AWS API Documentation
|
1855
|
+
#
|
1856
|
+
class UpdateConfiguredAudienceModelResponse < Struct.new(
|
1857
|
+
:configured_audience_model_arn)
|
1858
|
+
SENSITIVE = []
|
1859
|
+
include Aws::Structure
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
# The request parameters for this request are incorrect.
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] message
|
1865
|
+
# @return [String]
|
1866
|
+
#
|
1867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ValidationException AWS API Documentation
|
1868
|
+
#
|
1869
|
+
class ValidationException < Struct.new(
|
1870
|
+
:message)
|
1871
|
+
SENSITIVE = []
|
1872
|
+
include Aws::Structure
|
1873
|
+
end
|
1874
|
+
|
1875
|
+
end
|
1876
|
+
end
|