aws-sdk-cleanrooms 1.7.0 → 1.9.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanrooms/client.rb +479 -18
- data/lib/aws-sdk-cleanrooms/client_api.rb +333 -0
- data/lib/aws-sdk-cleanrooms/endpoints.rb +112 -0
- data/lib/aws-sdk-cleanrooms/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-cleanrooms/types.rb +726 -16
- data/lib/aws-sdk-cleanrooms.rb +2 -2
- metadata +2 -2
@@ -80,6 +80,35 @@ module Aws::CleanRooms
|
|
80
80
|
include Aws::Structure
|
81
81
|
end
|
82
82
|
|
83
|
+
# Optional. The member who can query can provide this placeholder for a
|
84
|
+
# literal data value in an analysis template.
|
85
|
+
#
|
86
|
+
# @!attribute [rw] name
|
87
|
+
# The name of the parameter. The name must use only alphanumeric,
|
88
|
+
# underscore (\_), or hyphen (-) characters but cannot start or end
|
89
|
+
# with a hyphen.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] type
|
93
|
+
# The type of parameter.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] default_value
|
97
|
+
# Optional. The default value that is applied in the analysis
|
98
|
+
# template. The member who can query can override this value in the
|
99
|
+
# query editor.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisParameter AWS API Documentation
|
103
|
+
#
|
104
|
+
class AnalysisParameter < Struct.new(
|
105
|
+
:name,
|
106
|
+
:type,
|
107
|
+
:default_value)
|
108
|
+
SENSITIVE = []
|
109
|
+
include Aws::Structure
|
110
|
+
end
|
111
|
+
|
83
112
|
# A specification about how data from the configured table can be used
|
84
113
|
# in a query.
|
85
114
|
#
|
@@ -88,8 +117,7 @@ module Aws::CleanRooms
|
|
88
117
|
# @return [String]
|
89
118
|
#
|
90
119
|
# @!attribute [rw] type
|
91
|
-
# The type of analysis rule.
|
92
|
-
# `LIST`.
|
120
|
+
# The type of analysis rule.
|
93
121
|
# @return [String]
|
94
122
|
#
|
95
123
|
# @!attribute [rw] name
|
@@ -121,8 +149,8 @@ module Aws::CleanRooms
|
|
121
149
|
include Aws::Structure
|
122
150
|
end
|
123
151
|
|
124
|
-
#
|
125
|
-
# statistics.
|
152
|
+
# A type of analysis rule that enables query structure and specified
|
153
|
+
# queries that produce aggregate statistics.
|
126
154
|
#
|
127
155
|
# @!attribute [rw] aggregate_columns
|
128
156
|
# The columns that query runners are allowed to use in aggregation
|
@@ -174,6 +202,28 @@ module Aws::CleanRooms
|
|
174
202
|
include Aws::Structure
|
175
203
|
end
|
176
204
|
|
205
|
+
# A type of analysis rule that enables the table owner to approve custom
|
206
|
+
# SQL queries on their configured tables.
|
207
|
+
#
|
208
|
+
# @!attribute [rw] allowed_analyses
|
209
|
+
# The analysis templates that are allowed by the custom analysis rule.
|
210
|
+
# @return [Array<String>]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] allowed_analysis_providers
|
213
|
+
# The Amazon Web Services accounts that are allowed to query by the
|
214
|
+
# custom analysis rule. Required when `allowedAnalyses` is
|
215
|
+
# `ANY_QUERY`.
|
216
|
+
# @return [Array<String>]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRuleCustom AWS API Documentation
|
219
|
+
#
|
220
|
+
class AnalysisRuleCustom < Struct.new(
|
221
|
+
:allowed_analyses,
|
222
|
+
:allowed_analysis_providers)
|
223
|
+
SENSITIVE = []
|
224
|
+
include Aws::Structure
|
225
|
+
end
|
226
|
+
|
177
227
|
# A type of analysis rule that enables row-level analysis.
|
178
228
|
#
|
179
229
|
# @!attribute [rw] join_columns
|
@@ -182,7 +232,7 @@ module Aws::CleanRooms
|
|
182
232
|
# @return [Array<String>]
|
183
233
|
#
|
184
234
|
# @!attribute [rw] allowed_join_operators
|
185
|
-
#
|
235
|
+
# The logical operators (if any) that are to be used in an INNER JOIN
|
186
236
|
# match condition. Default is `AND`.
|
187
237
|
# @return [Array<String>]
|
188
238
|
#
|
@@ -201,13 +251,13 @@ module Aws::CleanRooms
|
|
201
251
|
end
|
202
252
|
|
203
253
|
# Controls on the query specifications that can be run on configured
|
204
|
-
# table
|
254
|
+
# table.
|
205
255
|
#
|
206
256
|
# @note AnalysisRulePolicy is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AnalysisRulePolicy corresponding to the set member.
|
207
257
|
#
|
208
258
|
# @!attribute [rw] v1
|
209
259
|
# Controls on the query specifications that can be run on configured
|
210
|
-
# table
|
260
|
+
# table.
|
211
261
|
# @return [Types::AnalysisRulePolicyV1]
|
212
262
|
#
|
213
263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRulePolicy AWS API Documentation
|
@@ -224,7 +274,7 @@ module Aws::CleanRooms
|
|
224
274
|
end
|
225
275
|
|
226
276
|
# Controls on the query specifications that can be run on configured
|
227
|
-
# table
|
277
|
+
# table.
|
228
278
|
#
|
229
279
|
# @note AnalysisRulePolicyV1 is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AnalysisRulePolicyV1 corresponding to the set member.
|
230
280
|
#
|
@@ -238,11 +288,17 @@ module Aws::CleanRooms
|
|
238
288
|
# configured table.
|
239
289
|
# @return [Types::AnalysisRuleAggregation]
|
240
290
|
#
|
291
|
+
# @!attribute [rw] custom
|
292
|
+
# Analysis rule type that enables custom SQL queries on a configured
|
293
|
+
# table.
|
294
|
+
# @return [Types::AnalysisRuleCustom]
|
295
|
+
#
|
241
296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRulePolicyV1 AWS API Documentation
|
242
297
|
#
|
243
298
|
class AnalysisRulePolicyV1 < Struct.new(
|
244
299
|
:list,
|
245
300
|
:aggregation,
|
301
|
+
:custom,
|
246
302
|
:unknown)
|
247
303
|
SENSITIVE = []
|
248
304
|
include Aws::Structure
|
@@ -250,9 +306,253 @@ module Aws::CleanRooms
|
|
250
306
|
|
251
307
|
class List < AnalysisRulePolicyV1; end
|
252
308
|
class Aggregation < AnalysisRulePolicyV1; end
|
309
|
+
class Custom < AnalysisRulePolicyV1; end
|
253
310
|
class Unknown < AnalysisRulePolicyV1; end
|
254
311
|
end
|
255
312
|
|
313
|
+
# A relation within an analysis.
|
314
|
+
#
|
315
|
+
# @!attribute [rw] referenced_tables
|
316
|
+
# The tables referenced in the analysis schema.
|
317
|
+
# @return [Array<String>]
|
318
|
+
#
|
319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisSchema AWS API Documentation
|
320
|
+
#
|
321
|
+
class AnalysisSchema < Struct.new(
|
322
|
+
:referenced_tables)
|
323
|
+
SENSITIVE = []
|
324
|
+
include Aws::Structure
|
325
|
+
end
|
326
|
+
|
327
|
+
# The structure that defines the body of the analysis template.
|
328
|
+
#
|
329
|
+
# @note AnalysisSource is a union - when making an API calls you must set exactly one of the members.
|
330
|
+
#
|
331
|
+
# @note AnalysisSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AnalysisSource corresponding to the set member.
|
332
|
+
#
|
333
|
+
# @!attribute [rw] text
|
334
|
+
# The query text.
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisSource AWS API Documentation
|
338
|
+
#
|
339
|
+
class AnalysisSource < Struct.new(
|
340
|
+
:text,
|
341
|
+
:unknown)
|
342
|
+
SENSITIVE = []
|
343
|
+
include Aws::Structure
|
344
|
+
include Aws::Structure::Union
|
345
|
+
|
346
|
+
class Text < AnalysisSource; end
|
347
|
+
class Unknown < AnalysisSource; end
|
348
|
+
end
|
349
|
+
|
350
|
+
# The analysis template.
|
351
|
+
#
|
352
|
+
# @!attribute [rw] id
|
353
|
+
# The identifier for the analysis template.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] arn
|
357
|
+
# The Amazon Resource Name (ARN) of the analysis template.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] collaboration_id
|
361
|
+
# The unique ID for the associated collaboration of the analysis
|
362
|
+
# template.
|
363
|
+
# @return [String]
|
364
|
+
#
|
365
|
+
# @!attribute [rw] collaboration_arn
|
366
|
+
# The unique ARN for the analysis template’s associated collaboration.
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] membership_id
|
370
|
+
# The identifier of a member who created the analysis template.
|
371
|
+
# @return [String]
|
372
|
+
#
|
373
|
+
# @!attribute [rw] membership_arn
|
374
|
+
# The Amazon Resource Name (ARN) of the member who created the
|
375
|
+
# analysis template.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] description
|
379
|
+
# The description of the analysis template.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] name
|
383
|
+
# The name of the analysis template.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] create_time
|
387
|
+
# The time that the analysis template was created.
|
388
|
+
# @return [Time]
|
389
|
+
#
|
390
|
+
# @!attribute [rw] update_time
|
391
|
+
# The time that the analysis template was last updated.
|
392
|
+
# @return [Time]
|
393
|
+
#
|
394
|
+
# @!attribute [rw] schema
|
395
|
+
# The entire schema object.
|
396
|
+
# @return [Types::AnalysisSchema]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] format
|
399
|
+
# The format of the analysis template.
|
400
|
+
# @return [String]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] source
|
403
|
+
# The source of the analysis template.
|
404
|
+
# @return [Types::AnalysisSource]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] analysis_parameters
|
407
|
+
# The parameters of the analysis template.
|
408
|
+
# @return [Array<Types::AnalysisParameter>]
|
409
|
+
#
|
410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisTemplate AWS API Documentation
|
411
|
+
#
|
412
|
+
class AnalysisTemplate < Struct.new(
|
413
|
+
:id,
|
414
|
+
:arn,
|
415
|
+
:collaboration_id,
|
416
|
+
:collaboration_arn,
|
417
|
+
:membership_id,
|
418
|
+
:membership_arn,
|
419
|
+
:description,
|
420
|
+
:name,
|
421
|
+
:create_time,
|
422
|
+
:update_time,
|
423
|
+
:schema,
|
424
|
+
:format,
|
425
|
+
:source,
|
426
|
+
:analysis_parameters)
|
427
|
+
SENSITIVE = [:source]
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
431
|
+
# The metadata of the analysis template.
|
432
|
+
#
|
433
|
+
# @!attribute [rw] arn
|
434
|
+
# The Amazon Resource Name (ARN) of the analysis template.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] create_time
|
438
|
+
# The time that the analysis template summary was created.
|
439
|
+
# @return [Time]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] id
|
442
|
+
# The identifier of the analysis template.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] name
|
446
|
+
# The name of the analysis template.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] update_time
|
450
|
+
# The time that the analysis template summary was last updated.
|
451
|
+
# @return [Time]
|
452
|
+
#
|
453
|
+
# @!attribute [rw] membership_arn
|
454
|
+
# The Amazon Resource Name (ARN) of the member who created the
|
455
|
+
# analysis template.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] membership_id
|
459
|
+
# The identifier for a membership resource.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] collaboration_arn
|
463
|
+
# The unique ARN for the analysis template summary’s associated
|
464
|
+
# collaboration.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] collaboration_id
|
468
|
+
# A unique identifier for the collaboration that the analysis template
|
469
|
+
# summary belongs to. Currently accepts collaboration ID.
|
470
|
+
# @return [String]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] description
|
473
|
+
# The description of the analysis template.
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisTemplateSummary AWS API Documentation
|
477
|
+
#
|
478
|
+
class AnalysisTemplateSummary < Struct.new(
|
479
|
+
:arn,
|
480
|
+
:create_time,
|
481
|
+
:id,
|
482
|
+
:name,
|
483
|
+
:update_time,
|
484
|
+
:membership_arn,
|
485
|
+
:membership_id,
|
486
|
+
:collaboration_arn,
|
487
|
+
:collaboration_id,
|
488
|
+
:description)
|
489
|
+
SENSITIVE = []
|
490
|
+
include Aws::Structure
|
491
|
+
end
|
492
|
+
|
493
|
+
# Details of errors thrown by the call to retrieve multiple analysis
|
494
|
+
# templates within a collaboration by their identifiers.
|
495
|
+
#
|
496
|
+
# @!attribute [rw] arn
|
497
|
+
# The Amazon Resource Name (ARN) of the analysis template.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] code
|
501
|
+
# An error code for the error.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] message
|
505
|
+
# A description of why the call failed.
|
506
|
+
# @return [String]
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateError AWS API Documentation
|
509
|
+
#
|
510
|
+
class BatchGetCollaborationAnalysisTemplateError < Struct.new(
|
511
|
+
:arn,
|
512
|
+
:code,
|
513
|
+
:message)
|
514
|
+
SENSITIVE = []
|
515
|
+
include Aws::Structure
|
516
|
+
end
|
517
|
+
|
518
|
+
# @!attribute [rw] collaboration_identifier
|
519
|
+
# A unique identifier for the collaboration that the analysis
|
520
|
+
# templates belong to. Currently accepts collaboration ID.
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] analysis_template_arns
|
524
|
+
# The Amazon Resource Name (ARN) associated with the analysis template
|
525
|
+
# within a collaboration.
|
526
|
+
# @return [Array<String>]
|
527
|
+
#
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateInput AWS API Documentation
|
529
|
+
#
|
530
|
+
class BatchGetCollaborationAnalysisTemplateInput < Struct.new(
|
531
|
+
:collaboration_identifier,
|
532
|
+
:analysis_template_arns)
|
533
|
+
SENSITIVE = []
|
534
|
+
include Aws::Structure
|
535
|
+
end
|
536
|
+
|
537
|
+
# @!attribute [rw] collaboration_analysis_templates
|
538
|
+
# The retrieved list of analysis templates within a collaboration.
|
539
|
+
# @return [Array<Types::CollaborationAnalysisTemplate>]
|
540
|
+
#
|
541
|
+
# @!attribute [rw] errors
|
542
|
+
# Error reasons for collaboration analysis templates that could not be
|
543
|
+
# retrieved. One error is returned for every collaboration analysis
|
544
|
+
# template that could not be retrieved.
|
545
|
+
# @return [Array<Types::BatchGetCollaborationAnalysisTemplateError>]
|
546
|
+
#
|
547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateOutput AWS API Documentation
|
548
|
+
#
|
549
|
+
class BatchGetCollaborationAnalysisTemplateOutput < Struct.new(
|
550
|
+
:collaboration_analysis_templates,
|
551
|
+
:errors)
|
552
|
+
SENSITIVE = []
|
553
|
+
include Aws::Structure
|
554
|
+
end
|
555
|
+
|
256
556
|
# An error describing why a schema could not be fetched.
|
257
557
|
#
|
258
558
|
# @!attribute [rw] name
|
@@ -392,6 +692,143 @@ module Aws::CleanRooms
|
|
392
692
|
include Aws::Structure
|
393
693
|
end
|
394
694
|
|
695
|
+
# The analysis template within a collaboration.
|
696
|
+
#
|
697
|
+
# @!attribute [rw] id
|
698
|
+
# The identifier of the analysis template.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] arn
|
702
|
+
# The Amazon Resource Name (ARN) of the analysis template.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] collaboration_id
|
706
|
+
# A unique identifier for the collaboration that the analysis
|
707
|
+
# templates belong to. Currently accepts collaboration ID.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] collaboration_arn
|
711
|
+
# The unique ARN for the analysis template’s associated collaboration.
|
712
|
+
# @return [String]
|
713
|
+
#
|
714
|
+
# @!attribute [rw] description
|
715
|
+
# The description of the analysis template.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] creator_account_id
|
719
|
+
# The identifier used to reference members of the collaboration.
|
720
|
+
# Currently only supports Amazon Web Services account ID.
|
721
|
+
# @return [String]
|
722
|
+
#
|
723
|
+
# @!attribute [rw] name
|
724
|
+
# The name of the analysis template.
|
725
|
+
# @return [String]
|
726
|
+
#
|
727
|
+
# @!attribute [rw] create_time
|
728
|
+
# The time that the analysis template within a collaboration was
|
729
|
+
# created.
|
730
|
+
# @return [Time]
|
731
|
+
#
|
732
|
+
# @!attribute [rw] update_time
|
733
|
+
# The time that the analysis template in the collaboration was last
|
734
|
+
# updated.
|
735
|
+
# @return [Time]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] schema
|
738
|
+
# The entire schema object.
|
739
|
+
# @return [Types::AnalysisSchema]
|
740
|
+
#
|
741
|
+
# @!attribute [rw] format
|
742
|
+
# The format of the analysis template in the collaboration.
|
743
|
+
# @return [String]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] source
|
746
|
+
# The source of the analysis template within a collaboration.
|
747
|
+
# @return [Types::AnalysisSource]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] analysis_parameters
|
750
|
+
# The analysis parameters that have been specified in the analysis
|
751
|
+
# template.
|
752
|
+
# @return [Array<Types::AnalysisParameter>]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CollaborationAnalysisTemplate AWS API Documentation
|
755
|
+
#
|
756
|
+
class CollaborationAnalysisTemplate < Struct.new(
|
757
|
+
:id,
|
758
|
+
:arn,
|
759
|
+
:collaboration_id,
|
760
|
+
:collaboration_arn,
|
761
|
+
:description,
|
762
|
+
:creator_account_id,
|
763
|
+
:name,
|
764
|
+
:create_time,
|
765
|
+
:update_time,
|
766
|
+
:schema,
|
767
|
+
:format,
|
768
|
+
:source,
|
769
|
+
:analysis_parameters)
|
770
|
+
SENSITIVE = [:source]
|
771
|
+
include Aws::Structure
|
772
|
+
end
|
773
|
+
|
774
|
+
# The metadata of the analysis template within a collaboration.
|
775
|
+
#
|
776
|
+
# @!attribute [rw] arn
|
777
|
+
# The Amazon Resource Name (ARN) of the analysis template.
|
778
|
+
# @return [String]
|
779
|
+
#
|
780
|
+
# @!attribute [rw] create_time
|
781
|
+
# The time that the summary of the analysis template in a
|
782
|
+
# collaboration was created.
|
783
|
+
# @return [Time]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] id
|
786
|
+
# The identifier of the analysis template.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] name
|
790
|
+
# The name of the analysis template.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] update_time
|
794
|
+
# The time that the summary of the analysis template in the
|
795
|
+
# collaboration was last updated.
|
796
|
+
# @return [Time]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] collaboration_arn
|
799
|
+
# The unique ARN for the analysis template’s associated collaboration.
|
800
|
+
# @return [String]
|
801
|
+
#
|
802
|
+
# @!attribute [rw] collaboration_id
|
803
|
+
# A unique identifier for the collaboration that the analysis
|
804
|
+
# templates belong to. Currently accepts collaboration ID.
|
805
|
+
# @return [String]
|
806
|
+
#
|
807
|
+
# @!attribute [rw] creator_account_id
|
808
|
+
# The identifier used to reference members of the collaboration.
|
809
|
+
# Currently only supports Amazon Web Services account ID.
|
810
|
+
# @return [String]
|
811
|
+
#
|
812
|
+
# @!attribute [rw] description
|
813
|
+
# The description of the analysis template.
|
814
|
+
# @return [String]
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CollaborationAnalysisTemplateSummary AWS API Documentation
|
817
|
+
#
|
818
|
+
class CollaborationAnalysisTemplateSummary < Struct.new(
|
819
|
+
:arn,
|
820
|
+
:create_time,
|
821
|
+
:id,
|
822
|
+
:name,
|
823
|
+
:update_time,
|
824
|
+
:collaboration_arn,
|
825
|
+
:collaboration_id,
|
826
|
+
:creator_account_id,
|
827
|
+
:description)
|
828
|
+
SENSITIVE = []
|
829
|
+
include Aws::Structure
|
830
|
+
end
|
831
|
+
|
395
832
|
# The metadata of the collaboration.
|
396
833
|
#
|
397
834
|
# @!attribute [rw] id
|
@@ -505,8 +942,8 @@ module Aws::CleanRooms
|
|
505
942
|
#
|
506
943
|
# @!attribute [rw] analysis_rule_types
|
507
944
|
# The types of analysis rules associated with this configured table.
|
508
|
-
#
|
509
|
-
#
|
945
|
+
# Currently, only one analysis rule may be associated with a
|
946
|
+
# configured table.
|
510
947
|
# @return [Array<String>]
|
511
948
|
#
|
512
949
|
# @!attribute [rw] analysis_method
|
@@ -552,8 +989,7 @@ module Aws::CleanRooms
|
|
552
989
|
# @return [Types::ConfiguredTableAnalysisRulePolicy]
|
553
990
|
#
|
554
991
|
# @!attribute [rw] type
|
555
|
-
# The type of configured table analysis rule.
|
556
|
-
# `AGGREGATION` and `LIST`.
|
992
|
+
# The type of configured table analysis rule.
|
557
993
|
# @return [String]
|
558
994
|
#
|
559
995
|
# @!attribute [rw] create_time
|
@@ -619,11 +1055,17 @@ module Aws::CleanRooms
|
|
619
1055
|
# configured table.
|
620
1056
|
# @return [Types::AnalysisRuleAggregation]
|
621
1057
|
#
|
1058
|
+
# @!attribute [rw] custom
|
1059
|
+
# A type of analysis rule that enables the table owner to approve
|
1060
|
+
# custom SQL queries on their configured tables.
|
1061
|
+
# @return [Types::AnalysisRuleCustom]
|
1062
|
+
#
|
622
1063
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicyV1 AWS API Documentation
|
623
1064
|
#
|
624
1065
|
class ConfiguredTableAnalysisRulePolicyV1 < Struct.new(
|
625
1066
|
:list,
|
626
1067
|
:aggregation,
|
1068
|
+
:custom,
|
627
1069
|
:unknown)
|
628
1070
|
SENSITIVE = []
|
629
1071
|
include Aws::Structure
|
@@ -631,6 +1073,7 @@ module Aws::CleanRooms
|
|
631
1073
|
|
632
1074
|
class List < ConfiguredTableAnalysisRulePolicyV1; end
|
633
1075
|
class Aggregation < ConfiguredTableAnalysisRulePolicyV1; end
|
1076
|
+
class Custom < ConfiguredTableAnalysisRulePolicyV1; end
|
634
1077
|
class Unknown < ConfiguredTableAnalysisRulePolicyV1; end
|
635
1078
|
end
|
636
1079
|
|
@@ -834,6 +1277,64 @@ module Aws::CleanRooms
|
|
834
1277
|
include Aws::Structure
|
835
1278
|
end
|
836
1279
|
|
1280
|
+
# @!attribute [rw] description
|
1281
|
+
# The description of the analysis template.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] membership_identifier
|
1285
|
+
# The identifier for a membership resource.
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] name
|
1289
|
+
# The name of the analysis template.
|
1290
|
+
# @return [String]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] format
|
1293
|
+
# The format of the analysis template.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] source
|
1297
|
+
# The information in the analysis template. Currently supports `text`,
|
1298
|
+
# the query text for the analysis template.
|
1299
|
+
# @return [Types::AnalysisSource]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] tags
|
1302
|
+
# An optional label that you can assign to a resource when you create
|
1303
|
+
# it. Each tag consists of a key and an optional value, both of which
|
1304
|
+
# you define. When you use tagging, you can also use tag-based access
|
1305
|
+
# control in IAM policies to control access to this resource.
|
1306
|
+
# @return [Hash<String,String>]
|
1307
|
+
#
|
1308
|
+
# @!attribute [rw] analysis_parameters
|
1309
|
+
# The parameters of the analysis template.
|
1310
|
+
# @return [Array<Types::AnalysisParameter>]
|
1311
|
+
#
|
1312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateAnalysisTemplateInput AWS API Documentation
|
1313
|
+
#
|
1314
|
+
class CreateAnalysisTemplateInput < Struct.new(
|
1315
|
+
:description,
|
1316
|
+
:membership_identifier,
|
1317
|
+
:name,
|
1318
|
+
:format,
|
1319
|
+
:source,
|
1320
|
+
:tags,
|
1321
|
+
:analysis_parameters)
|
1322
|
+
SENSITIVE = [:source]
|
1323
|
+
include Aws::Structure
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# @!attribute [rw] analysis_template
|
1327
|
+
# The analysis template.
|
1328
|
+
# @return [Types::AnalysisTemplate]
|
1329
|
+
#
|
1330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateAnalysisTemplateOutput AWS API Documentation
|
1331
|
+
#
|
1332
|
+
class CreateAnalysisTemplateOutput < Struct.new(
|
1333
|
+
:analysis_template)
|
1334
|
+
SENSITIVE = []
|
1335
|
+
include Aws::Structure
|
1336
|
+
end
|
1337
|
+
|
837
1338
|
# @!attribute [rw] members
|
838
1339
|
# A list of initial members, not including the creator. This list is
|
839
1340
|
# immutable.
|
@@ -906,7 +1407,7 @@ module Aws::CleanRooms
|
|
906
1407
|
# @return [String]
|
907
1408
|
#
|
908
1409
|
# @!attribute [rw] analysis_rule_type
|
909
|
-
# The type of analysis rule.
|
1410
|
+
# The type of analysis rule.
|
910
1411
|
# @return [String]
|
911
1412
|
#
|
912
1413
|
# @!attribute [rw] analysis_rule_policy
|
@@ -1118,6 +1619,27 @@ module Aws::CleanRooms
|
|
1118
1619
|
include Aws::Structure
|
1119
1620
|
end
|
1120
1621
|
|
1622
|
+
# @!attribute [rw] membership_identifier
|
1623
|
+
# The identifier for a membership resource.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] analysis_template_identifier
|
1627
|
+
# The identifier for the analysis template resource.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteAnalysisTemplateInput AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class DeleteAnalysisTemplateInput < Struct.new(
|
1633
|
+
:membership_identifier,
|
1634
|
+
:analysis_template_identifier)
|
1635
|
+
SENSITIVE = []
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteAnalysisTemplateOutput AWS API Documentation
|
1640
|
+
#
|
1641
|
+
class DeleteAnalysisTemplateOutput < Aws::EmptyStructure; end
|
1642
|
+
|
1121
1643
|
# @!attribute [rw] collaboration_identifier
|
1122
1644
|
# The identifier for the collaboration.
|
1123
1645
|
# @return [String]
|
@@ -1238,6 +1760,66 @@ module Aws::CleanRooms
|
|
1238
1760
|
#
|
1239
1761
|
class DeleteMembershipOutput < Aws::EmptyStructure; end
|
1240
1762
|
|
1763
|
+
# @!attribute [rw] membership_identifier
|
1764
|
+
# The identifier for a membership resource.
|
1765
|
+
# @return [String]
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] analysis_template_identifier
|
1768
|
+
# The identifier for the analysis template resource.
|
1769
|
+
# @return [String]
|
1770
|
+
#
|
1771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetAnalysisTemplateInput AWS API Documentation
|
1772
|
+
#
|
1773
|
+
class GetAnalysisTemplateInput < Struct.new(
|
1774
|
+
:membership_identifier,
|
1775
|
+
:analysis_template_identifier)
|
1776
|
+
SENSITIVE = []
|
1777
|
+
include Aws::Structure
|
1778
|
+
end
|
1779
|
+
|
1780
|
+
# @!attribute [rw] analysis_template
|
1781
|
+
# The analysis template.
|
1782
|
+
# @return [Types::AnalysisTemplate]
|
1783
|
+
#
|
1784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetAnalysisTemplateOutput AWS API Documentation
|
1785
|
+
#
|
1786
|
+
class GetAnalysisTemplateOutput < Struct.new(
|
1787
|
+
:analysis_template)
|
1788
|
+
SENSITIVE = []
|
1789
|
+
include Aws::Structure
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
# @!attribute [rw] collaboration_identifier
|
1793
|
+
# A unique identifier for the collaboration that the analysis
|
1794
|
+
# templates belong to. Currently accepts collaboration ID.
|
1795
|
+
# @return [String]
|
1796
|
+
#
|
1797
|
+
# @!attribute [rw] analysis_template_arn
|
1798
|
+
# The Amazon Resource Name (ARN) associated with the analysis template
|
1799
|
+
# within a collaboration.
|
1800
|
+
# @return [String]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplateInput AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class GetCollaborationAnalysisTemplateInput < Struct.new(
|
1805
|
+
:collaboration_identifier,
|
1806
|
+
:analysis_template_arn)
|
1807
|
+
SENSITIVE = []
|
1808
|
+
include Aws::Structure
|
1809
|
+
end
|
1810
|
+
|
1811
|
+
# @!attribute [rw] collaboration_analysis_template
|
1812
|
+
# The analysis template within a collaboration.
|
1813
|
+
# @return [Types::CollaborationAnalysisTemplate]
|
1814
|
+
#
|
1815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplateOutput AWS API Documentation
|
1816
|
+
#
|
1817
|
+
class GetCollaborationAnalysisTemplateOutput < Struct.new(
|
1818
|
+
:collaboration_analysis_template)
|
1819
|
+
SENSITIVE = []
|
1820
|
+
include Aws::Structure
|
1821
|
+
end
|
1822
|
+
|
1241
1823
|
# @!attribute [rw] collaboration_identifier
|
1242
1824
|
# The identifier for the collaboration.
|
1243
1825
|
# @return [String]
|
@@ -1502,6 +2084,89 @@ module Aws::CleanRooms
|
|
1502
2084
|
include Aws::Structure
|
1503
2085
|
end
|
1504
2086
|
|
2087
|
+
# @!attribute [rw] membership_identifier
|
2088
|
+
# The identifier for a membership resource.
|
2089
|
+
# @return [String]
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] next_token
|
2092
|
+
# The token value retrieved from a previous call to access the next
|
2093
|
+
# page of results.
|
2094
|
+
# @return [String]
|
2095
|
+
#
|
2096
|
+
# @!attribute [rw] max_results
|
2097
|
+
# The maximum size of the results that is returned per call.
|
2098
|
+
# @return [Integer]
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListAnalysisTemplatesInput AWS API Documentation
|
2101
|
+
#
|
2102
|
+
class ListAnalysisTemplatesInput < Struct.new(
|
2103
|
+
:membership_identifier,
|
2104
|
+
:next_token,
|
2105
|
+
:max_results)
|
2106
|
+
SENSITIVE = []
|
2107
|
+
include Aws::Structure
|
2108
|
+
end
|
2109
|
+
|
2110
|
+
# @!attribute [rw] next_token
|
2111
|
+
# The token value retrieved from a previous call to access the next
|
2112
|
+
# page of results.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] analysis_template_summaries
|
2116
|
+
# Lists analysis template metadata.
|
2117
|
+
# @return [Array<Types::AnalysisTemplateSummary>]
|
2118
|
+
#
|
2119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListAnalysisTemplatesOutput AWS API Documentation
|
2120
|
+
#
|
2121
|
+
class ListAnalysisTemplatesOutput < Struct.new(
|
2122
|
+
:next_token,
|
2123
|
+
:analysis_template_summaries)
|
2124
|
+
SENSITIVE = []
|
2125
|
+
include Aws::Structure
|
2126
|
+
end
|
2127
|
+
|
2128
|
+
# @!attribute [rw] collaboration_identifier
|
2129
|
+
# A unique identifier for the collaboration that the analysis
|
2130
|
+
# templates belong to. Currently accepts collaboration ID.
|
2131
|
+
# @return [String]
|
2132
|
+
#
|
2133
|
+
# @!attribute [rw] next_token
|
2134
|
+
# The token value retrieved from a previous call to access the next
|
2135
|
+
# page of results.
|
2136
|
+
# @return [String]
|
2137
|
+
#
|
2138
|
+
# @!attribute [rw] max_results
|
2139
|
+
# The maximum size of the results that is returned per call.
|
2140
|
+
# @return [Integer]
|
2141
|
+
#
|
2142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplatesInput AWS API Documentation
|
2143
|
+
#
|
2144
|
+
class ListCollaborationAnalysisTemplatesInput < Struct.new(
|
2145
|
+
:collaboration_identifier,
|
2146
|
+
:next_token,
|
2147
|
+
:max_results)
|
2148
|
+
SENSITIVE = []
|
2149
|
+
include Aws::Structure
|
2150
|
+
end
|
2151
|
+
|
2152
|
+
# @!attribute [rw] next_token
|
2153
|
+
# The token value retrieved from a previous call to access the next
|
2154
|
+
# page of results.
|
2155
|
+
# @return [String]
|
2156
|
+
#
|
2157
|
+
# @!attribute [rw] collaboration_analysis_template_summaries
|
2158
|
+
# The metadata of the analysis template within a collaboration.
|
2159
|
+
# @return [Array<Types::CollaborationAnalysisTemplateSummary>]
|
2160
|
+
#
|
2161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplatesOutput AWS API Documentation
|
2162
|
+
#
|
2163
|
+
class ListCollaborationAnalysisTemplatesOutput < Struct.new(
|
2164
|
+
:next_token,
|
2165
|
+
:collaboration_analysis_template_summaries)
|
2166
|
+
SENSITIVE = []
|
2167
|
+
include Aws::Structure
|
2168
|
+
end
|
2169
|
+
|
1505
2170
|
# @!attribute [rw] next_token
|
1506
2171
|
# The token value retrieved from a previous call to access the next
|
1507
2172
|
# page of results.
|
@@ -2238,10 +2903,21 @@ module Aws::CleanRooms
|
|
2238
2903
|
# The query string to be submitted.
|
2239
2904
|
# @return [String]
|
2240
2905
|
#
|
2906
|
+
# @!attribute [rw] analysis_template_arn
|
2907
|
+
# The Amazon Resource Name (ARN) associated with the analysis template
|
2908
|
+
# within a collaboration.
|
2909
|
+
# @return [String]
|
2910
|
+
#
|
2911
|
+
# @!attribute [rw] parameters
|
2912
|
+
# The protected query SQL parameters.
|
2913
|
+
# @return [Hash<String,String>]
|
2914
|
+
#
|
2241
2915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuerySQLParameters AWS API Documentation
|
2242
2916
|
#
|
2243
2917
|
class ProtectedQuerySQLParameters < Struct.new(
|
2244
|
-
:query_string
|
2918
|
+
:query_string,
|
2919
|
+
:analysis_template_arn,
|
2920
|
+
:parameters)
|
2245
2921
|
SENSITIVE = []
|
2246
2922
|
include Aws::Structure
|
2247
2923
|
end
|
@@ -2332,8 +3008,8 @@ module Aws::CleanRooms
|
|
2332
3008
|
# @return [Array<Types::Column>]
|
2333
3009
|
#
|
2334
3010
|
# @!attribute [rw] analysis_rule_types
|
2335
|
-
# The analysis rule types associated with the schema.
|
2336
|
-
#
|
3011
|
+
# The analysis rule types associated with the schema. Currently, only
|
3012
|
+
# one entry is present.
|
2337
3013
|
# @return [Array<String>]
|
2338
3014
|
#
|
2339
3015
|
# @!attribute [rw] analysis_method
|
@@ -2597,6 +3273,40 @@ module Aws::CleanRooms
|
|
2597
3273
|
#
|
2598
3274
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
2599
3275
|
|
3276
|
+
# @!attribute [rw] membership_identifier
|
3277
|
+
# The identifier for a membership resource.
|
3278
|
+
# @return [String]
|
3279
|
+
#
|
3280
|
+
# @!attribute [rw] analysis_template_identifier
|
3281
|
+
# The identifier for the analysis template resource.
|
3282
|
+
# @return [String]
|
3283
|
+
#
|
3284
|
+
# @!attribute [rw] description
|
3285
|
+
# A new description for the analysis template.
|
3286
|
+
# @return [String]
|
3287
|
+
#
|
3288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateAnalysisTemplateInput AWS API Documentation
|
3289
|
+
#
|
3290
|
+
class UpdateAnalysisTemplateInput < Struct.new(
|
3291
|
+
:membership_identifier,
|
3292
|
+
:analysis_template_identifier,
|
3293
|
+
:description)
|
3294
|
+
SENSITIVE = []
|
3295
|
+
include Aws::Structure
|
3296
|
+
end
|
3297
|
+
|
3298
|
+
# @!attribute [rw] analysis_template
|
3299
|
+
# The analysis template.
|
3300
|
+
# @return [Types::AnalysisTemplate]
|
3301
|
+
#
|
3302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateAnalysisTemplateOutput AWS API Documentation
|
3303
|
+
#
|
3304
|
+
class UpdateAnalysisTemplateOutput < Struct.new(
|
3305
|
+
:analysis_template)
|
3306
|
+
SENSITIVE = []
|
3307
|
+
include Aws::Structure
|
3308
|
+
end
|
3309
|
+
|
2600
3310
|
# @!attribute [rw] collaboration_identifier
|
2601
3311
|
# The identifier for the collaboration.
|
2602
3312
|
# @return [String]
|