aws-sdk-cleanrooms 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.
@@ -0,0 +1,2741 @@
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::CleanRooms
11
+ module Types
12
+
13
+ # Caller does not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @!attribute [rw] reason
19
+ # A reason code for the exception.
20
+ # @return [String]
21
+ #
22
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AccessDeniedException AWS API Documentation
23
+ #
24
+ class AccessDeniedException < Struct.new(
25
+ :message,
26
+ :reason)
27
+ SENSITIVE = []
28
+ include Aws::Structure
29
+ end
30
+
31
+ # Column in configured table that can be used in aggregate function in
32
+ # query.
33
+ #
34
+ # @!attribute [rw] column_names
35
+ # Column names in configured table of aggregate columns.
36
+ # @return [Array<String>]
37
+ #
38
+ # @!attribute [rw] function
39
+ # Aggregation function that can be applied to aggregate column in
40
+ # query.
41
+ # @return [String]
42
+ #
43
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AggregateColumn AWS API Documentation
44
+ #
45
+ class AggregateColumn < Struct.new(
46
+ :column_names,
47
+ :function)
48
+ SENSITIVE = []
49
+ include Aws::Structure
50
+ end
51
+
52
+ # Constraint on query output removing output rows that do not meet a
53
+ # minimum number of distinct values of a specified column.
54
+ #
55
+ # @!attribute [rw] column_name
56
+ # Column in aggregation constraint for which there must be a minimum
57
+ # number of distinct values in an output row for it to be in the query
58
+ # output.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] minimum
62
+ # The minimum number of distinct values that an output row must be an
63
+ # aggregation of. Minimum threshold of distinct values for a specified
64
+ # column that must exist in an output row for it to be in the query
65
+ # output.
66
+ # @return [Integer]
67
+ #
68
+ # @!attribute [rw] type
69
+ # The type of aggregation the constraint allows. The only valid value
70
+ # is currently `COUNT\_DISTINCT`.
71
+ # @return [String]
72
+ #
73
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AggregationConstraint AWS API Documentation
74
+ #
75
+ class AggregationConstraint < Struct.new(
76
+ :column_name,
77
+ :minimum,
78
+ :type)
79
+ SENSITIVE = []
80
+ include Aws::Structure
81
+ end
82
+
83
+ # A specification about how data from the configured table can be used
84
+ # in a query.
85
+ #
86
+ # @!attribute [rw] collaboration_id
87
+ # The unique ID for the associated collaboration.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] type
91
+ # The type of analysis rule. Valid values are `AGGREGATION` and
92
+ # `LIST`.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] name
96
+ # The name for the analysis rule.
97
+ # @return [String]
98
+ #
99
+ # @!attribute [rw] create_time
100
+ # The time the analysis rule was created.
101
+ # @return [Time]
102
+ #
103
+ # @!attribute [rw] update_time
104
+ # The time the analysis rule was last updated.
105
+ # @return [Time]
106
+ #
107
+ # @!attribute [rw] policy
108
+ # A policy that describes the associated data usage limitations.
109
+ # @return [Types::AnalysisRulePolicy]
110
+ #
111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRule AWS API Documentation
112
+ #
113
+ class AnalysisRule < Struct.new(
114
+ :collaboration_id,
115
+ :type,
116
+ :name,
117
+ :create_time,
118
+ :update_time,
119
+ :policy)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ end
123
+
124
+ # Enables query structure and specified queries that product aggregate
125
+ # statistics.
126
+ #
127
+ # @!attribute [rw] aggregate_columns
128
+ # The columns that query runners are allowed to use in aggregation
129
+ # queries.
130
+ # @return [Array<Types::AggregateColumn>]
131
+ #
132
+ # @!attribute [rw] join_columns
133
+ # Columns in configured table that can be used in join statements
134
+ # and/or as aggregate columns. They can never be outputted directly.
135
+ # @return [Array<String>]
136
+ #
137
+ # @!attribute [rw] join_required
138
+ # Control that requires member who runs query to do a join with their
139
+ # configured table and/or other configured table in query
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] dimension_columns
143
+ # The columns that query runners are allowed to select, group by, or
144
+ # filter by.
145
+ # @return [Array<String>]
146
+ #
147
+ # @!attribute [rw] scalar_functions
148
+ # Set of scalar functions that are allowed to be used on dimension
149
+ # columns and the output of aggregation of metrics.
150
+ # @return [Array<String>]
151
+ #
152
+ # @!attribute [rw] output_constraints
153
+ # Columns that must meet a specific threshold value (after an
154
+ # aggregation function is applied to it) for each output row to be
155
+ # returned.
156
+ # @return [Array<Types::AggregationConstraint>]
157
+ #
158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRuleAggregation AWS API Documentation
159
+ #
160
+ class AnalysisRuleAggregation < Struct.new(
161
+ :aggregate_columns,
162
+ :join_columns,
163
+ :join_required,
164
+ :dimension_columns,
165
+ :scalar_functions,
166
+ :output_constraints)
167
+ SENSITIVE = []
168
+ include Aws::Structure
169
+ end
170
+
171
+ # A type of analysis rule that enables row-level analysis.
172
+ #
173
+ # @!attribute [rw] join_columns
174
+ # Columns that can be used to join a configured table with the table
175
+ # of the member who can query and another members' configured tables.
176
+ # @return [Array<String>]
177
+ #
178
+ # @!attribute [rw] list_columns
179
+ # Columns that can be listed in the output.
180
+ # @return [Array<String>]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRuleList AWS API Documentation
183
+ #
184
+ class AnalysisRuleList < Struct.new(
185
+ :join_columns,
186
+ :list_columns)
187
+ SENSITIVE = []
188
+ include Aws::Structure
189
+ end
190
+
191
+ # Controls on the query specifications that can be run on configured
192
+ # table..
193
+ #
194
+ # @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.
195
+ #
196
+ # @!attribute [rw] v1
197
+ # Controls on the query specifications that can be run on configured
198
+ # table..
199
+ # @return [Types::AnalysisRulePolicyV1]
200
+ #
201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRulePolicy AWS API Documentation
202
+ #
203
+ class AnalysisRulePolicy < Struct.new(
204
+ :v1,
205
+ :unknown)
206
+ SENSITIVE = []
207
+ include Aws::Structure
208
+ include Aws::Structure::Union
209
+
210
+ class V1 < AnalysisRulePolicy; end
211
+ class Unknown < AnalysisRulePolicy; end
212
+ end
213
+
214
+ # Controls on the query specifications that can be run on configured
215
+ # table..
216
+ #
217
+ # @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.
218
+ #
219
+ # @!attribute [rw] list
220
+ # Analysis rule type that enables only list queries on a configured
221
+ # table.
222
+ # @return [Types::AnalysisRuleList]
223
+ #
224
+ # @!attribute [rw] aggregation
225
+ # Analysis rule type that enables only aggregation queries on a
226
+ # configured table.
227
+ # @return [Types::AnalysisRuleAggregation]
228
+ #
229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRulePolicyV1 AWS API Documentation
230
+ #
231
+ class AnalysisRulePolicyV1 < Struct.new(
232
+ :list,
233
+ :aggregation,
234
+ :unknown)
235
+ SENSITIVE = []
236
+ include Aws::Structure
237
+ include Aws::Structure::Union
238
+
239
+ class List < AnalysisRulePolicyV1; end
240
+ class Aggregation < AnalysisRulePolicyV1; end
241
+ class Unknown < AnalysisRulePolicyV1; end
242
+ end
243
+
244
+ # An error describing why a schema could not be fetched.
245
+ #
246
+ # @!attribute [rw] name
247
+ # An error name for the error.
248
+ # @return [String]
249
+ #
250
+ # @!attribute [rw] code
251
+ # An error code for the error.
252
+ # @return [String]
253
+ #
254
+ # @!attribute [rw] message
255
+ # An error message for the error.
256
+ # @return [String]
257
+ #
258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetSchemaError AWS API Documentation
259
+ #
260
+ class BatchGetSchemaError < Struct.new(
261
+ :name,
262
+ :code,
263
+ :message)
264
+ SENSITIVE = []
265
+ include Aws::Structure
266
+ end
267
+
268
+ # @!attribute [rw] collaboration_identifier
269
+ # A unique identifier for the collaboration that the schemas belong
270
+ # to. Currently accepts collaboration ID.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] names
274
+ # The names for the schema objects to retrieve.&gt;
275
+ # @return [Array<String>]
276
+ #
277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetSchemaInput AWS API Documentation
278
+ #
279
+ class BatchGetSchemaInput < Struct.new(
280
+ :collaboration_identifier,
281
+ :names)
282
+ SENSITIVE = []
283
+ include Aws::Structure
284
+ end
285
+
286
+ # @!attribute [rw] schemas
287
+ # The retrieved list of schemas.
288
+ # @return [Array<Types::Schema>]
289
+ #
290
+ # @!attribute [rw] errors
291
+ # Error reasons for schemas that could not be retrieved. One error is
292
+ # returned for every schema that could not be retrieved.
293
+ # @return [Array<Types::BatchGetSchemaError>]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetSchemaOutput AWS API Documentation
296
+ #
297
+ class BatchGetSchemaOutput < Struct.new(
298
+ :schemas,
299
+ :errors)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # The multi-party data share environment. The collaboration contains
305
+ # metadata about its purpose and participants.
306
+ #
307
+ # @!attribute [rw] id
308
+ # The unique ID for the collaboration.
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] arn
312
+ # The unique ARN for the collaboration.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] name
316
+ # A human-readable identifier provided by the collaboration owner.
317
+ # Display names are not unique.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] description
321
+ # A description of the collaboration provided by the collaboration
322
+ # owner.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] creator_account_id
326
+ # The identifier used to reference members of the collaboration.
327
+ # Currently only supports AWS account ID.
328
+ # @return [String]
329
+ #
330
+ # @!attribute [rw] creator_display_name
331
+ # A display name of the collaboration creator.
332
+ # @return [String]
333
+ #
334
+ # @!attribute [rw] create_time
335
+ # The time when the collaboration was created.
336
+ # @return [Time]
337
+ #
338
+ # @!attribute [rw] update_time
339
+ # The time the collaboration metadata was last updated.
340
+ # @return [Time]
341
+ #
342
+ # @!attribute [rw] member_status
343
+ # The status of a member in a collaboration.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] membership_id
347
+ # The unique ID for your membership within the collaboration.
348
+ # @return [String]
349
+ #
350
+ # @!attribute [rw] membership_arn
351
+ # The unique ARN for your membership within the collaboration.
352
+ # @return [String]
353
+ #
354
+ # @!attribute [rw] data_encryption_metadata
355
+ # The settings for client-side encryption for cryptographic computing.
356
+ # @return [Types::DataEncryptionMetadata]
357
+ #
358
+ # @!attribute [rw] query_log_status
359
+ # An indicator as to whether query logging has been enabled or
360
+ # disabled for the collaboration.
361
+ # @return [String]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/Collaboration AWS API Documentation
364
+ #
365
+ class Collaboration < Struct.new(
366
+ :id,
367
+ :arn,
368
+ :name,
369
+ :description,
370
+ :creator_account_id,
371
+ :creator_display_name,
372
+ :create_time,
373
+ :update_time,
374
+ :member_status,
375
+ :membership_id,
376
+ :membership_arn,
377
+ :data_encryption_metadata,
378
+ :query_log_status)
379
+ SENSITIVE = []
380
+ include Aws::Structure
381
+ end
382
+
383
+ # The metadata of the collaboration.
384
+ #
385
+ # @!attribute [rw] id
386
+ # The identifier for the collaboration.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] arn
390
+ # The ARN of the collaboration.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] name
394
+ # A human-readable identifier provided by the collaboration owner.
395
+ # Display names are not unique.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] creator_account_id
399
+ # The identifier used to reference members of the collaboration.
400
+ # Currently only supports AWS Account ID.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] creator_display_name
404
+ # The display name of the collaboration creator.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] create_time
408
+ # The time when the collaboration was created.
409
+ # @return [Time]
410
+ #
411
+ # @!attribute [rw] update_time
412
+ # The time the collaboration metadata was last updated.
413
+ # @return [Time]
414
+ #
415
+ # @!attribute [rw] member_status
416
+ # The status of a member in a collaboration.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] membership_id
420
+ # The identifier of a member in a collaboration.
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] membership_arn
424
+ # The ARN of a member in a collaboration.
425
+ # @return [String]
426
+ #
427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CollaborationSummary AWS API Documentation
428
+ #
429
+ class CollaborationSummary < Struct.new(
430
+ :id,
431
+ :arn,
432
+ :name,
433
+ :creator_account_id,
434
+ :creator_display_name,
435
+ :create_time,
436
+ :update_time,
437
+ :member_status,
438
+ :membership_id,
439
+ :membership_arn)
440
+ SENSITIVE = []
441
+ include Aws::Structure
442
+ end
443
+
444
+ # A column within a schema relation, derived from the underlying AWS
445
+ # Glue table.
446
+ #
447
+ # @!attribute [rw] name
448
+ # The name of the column.
449
+ # @return [String]
450
+ #
451
+ # @!attribute [rw] type
452
+ # The type of the column.
453
+ # @return [String]
454
+ #
455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/Column AWS API Documentation
456
+ #
457
+ class Column < Struct.new(
458
+ :name,
459
+ :type)
460
+ SENSITIVE = []
461
+ include Aws::Structure
462
+ end
463
+
464
+ # A table that has been configured for use in a collaboration.
465
+ #
466
+ # @!attribute [rw] id
467
+ # The unique ID for the configured table.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] arn
471
+ # The unique ARN for the configured table.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] name
475
+ # A name for the configured table.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] description
479
+ # A description for the configured table.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] table_reference
483
+ # The AWS Glue table that this configured table represents.
484
+ # @return [Types::TableReference]
485
+ #
486
+ # @!attribute [rw] create_time
487
+ # The time the configured table was created.
488
+ # @return [Time]
489
+ #
490
+ # @!attribute [rw] update_time
491
+ # The time the configured table was last updated
492
+ # @return [Time]
493
+ #
494
+ # @!attribute [rw] analysis_rule_types
495
+ # The types of analysis rules associated with this configured table.
496
+ # Valid values are `AGGREGATION` and `LIST`. Currently, only one
497
+ # analysis rule may be associated with a configured table.
498
+ # @return [Array<String>]
499
+ #
500
+ # @!attribute [rw] analysis_method
501
+ # The analysis method for the configured table. The only valid value
502
+ # is currently `DIRECT\_QUERY`.
503
+ # @return [String]
504
+ #
505
+ # @!attribute [rw] allowed_columns
506
+ # The columns within the underlying AWS Glue table that can be
507
+ # utilized within collaborations.
508
+ # @return [Array<String>]
509
+ #
510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTable AWS API Documentation
511
+ #
512
+ class ConfiguredTable < Struct.new(
513
+ :id,
514
+ :arn,
515
+ :name,
516
+ :description,
517
+ :table_reference,
518
+ :create_time,
519
+ :update_time,
520
+ :analysis_rule_types,
521
+ :analysis_method,
522
+ :allowed_columns)
523
+ SENSITIVE = []
524
+ include Aws::Structure
525
+ end
526
+
527
+ # A configured table analysis rule, which limits how data for this table
528
+ # can be used.
529
+ #
530
+ # @!attribute [rw] configured_table_id
531
+ # The unique ID for the configured table.
532
+ # @return [String]
533
+ #
534
+ # @!attribute [rw] configured_table_arn
535
+ # The unique ARN for the configured table.
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] policy
539
+ # The policy that controls SQL query rules.
540
+ # @return [Types::ConfiguredTableAnalysisRulePolicy]
541
+ #
542
+ # @!attribute [rw] type
543
+ # The type of configured table analysis rule. Valid values are
544
+ # `AGGREGATION` and `LIST`.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] create_time
548
+ # The time the configured table analysis rule was created.
549
+ # @return [Time]
550
+ #
551
+ # @!attribute [rw] update_time
552
+ # The time the configured table analysis rule was last updated.
553
+ # @return [Time]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAnalysisRule AWS API Documentation
556
+ #
557
+ class ConfiguredTableAnalysisRule < Struct.new(
558
+ :configured_table_id,
559
+ :configured_table_arn,
560
+ :policy,
561
+ :type,
562
+ :create_time,
563
+ :update_time)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
568
+ # Controls on the query specifications that can be run on a configured
569
+ # table.
570
+ #
571
+ # @note ConfiguredTableAnalysisRulePolicy is a union - when making an API calls you must set exactly one of the members.
572
+ #
573
+ # @note ConfiguredTableAnalysisRulePolicy is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConfiguredTableAnalysisRulePolicy corresponding to the set member.
574
+ #
575
+ # @!attribute [rw] v1
576
+ # Controls on the query specifications that can be run on a configured
577
+ # table.
578
+ # @return [Types::ConfiguredTableAnalysisRulePolicyV1]
579
+ #
580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicy AWS API Documentation
581
+ #
582
+ class ConfiguredTableAnalysisRulePolicy < Struct.new(
583
+ :v1,
584
+ :unknown)
585
+ SENSITIVE = []
586
+ include Aws::Structure
587
+ include Aws::Structure::Union
588
+
589
+ class V1 < ConfiguredTableAnalysisRulePolicy; end
590
+ class Unknown < ConfiguredTableAnalysisRulePolicy; end
591
+ end
592
+
593
+ # Controls on the query specifications that can be run on a configured
594
+ # table.
595
+ #
596
+ # @note ConfiguredTableAnalysisRulePolicyV1 is a union - when making an API calls you must set exactly one of the members.
597
+ #
598
+ # @note ConfiguredTableAnalysisRulePolicyV1 is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConfiguredTableAnalysisRulePolicyV1 corresponding to the set member.
599
+ #
600
+ # @!attribute [rw] list
601
+ # Analysis rule type that enables only list queries on a configured
602
+ # table.
603
+ # @return [Types::AnalysisRuleList]
604
+ #
605
+ # @!attribute [rw] aggregation
606
+ # Analysis rule type that enables only aggregation queries on a
607
+ # configured table.
608
+ # @return [Types::AnalysisRuleAggregation]
609
+ #
610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicyV1 AWS API Documentation
611
+ #
612
+ class ConfiguredTableAnalysisRulePolicyV1 < Struct.new(
613
+ :list,
614
+ :aggregation,
615
+ :unknown)
616
+ SENSITIVE = []
617
+ include Aws::Structure
618
+ include Aws::Structure::Union
619
+
620
+ class List < ConfiguredTableAnalysisRulePolicyV1; end
621
+ class Aggregation < ConfiguredTableAnalysisRulePolicyV1; end
622
+ class Unknown < ConfiguredTableAnalysisRulePolicyV1; end
623
+ end
624
+
625
+ # A configured table association links a configured table to a
626
+ # collaboration.
627
+ #
628
+ # @!attribute [rw] arn
629
+ # The unique ARN for the configured table association.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] id
633
+ # The unique ID for the configured table association.
634
+ # @return [String]
635
+ #
636
+ # @!attribute [rw] configured_table_id
637
+ # The unique ID for the configured table that the association refers
638
+ # to.
639
+ # @return [String]
640
+ #
641
+ # @!attribute [rw] configured_table_arn
642
+ # The unique ARN for the configured table that the association refers
643
+ # to.
644
+ # @return [String]
645
+ #
646
+ # @!attribute [rw] membership_id
647
+ # The unique ID for the membership this configured table association
648
+ # belongs to.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] membership_arn
652
+ # The unique ARN for the membership this configured table association
653
+ # belongs to.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] role_arn
657
+ # The service will assume this role to access catalog metadata and
658
+ # query the table.
659
+ # @return [String]
660
+ #
661
+ # @!attribute [rw] name
662
+ # The name of the configured table association, in lowercase. The
663
+ # table is identified by this name when running protected queries
664
+ # against the underlying data.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] description
668
+ # A description of the configured table association.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] create_time
672
+ # The time the configured table association was created.
673
+ # @return [Time]
674
+ #
675
+ # @!attribute [rw] update_time
676
+ # The time the configured table association was last updated.
677
+ # @return [Time]
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAssociation AWS API Documentation
680
+ #
681
+ class ConfiguredTableAssociation < Struct.new(
682
+ :arn,
683
+ :id,
684
+ :configured_table_id,
685
+ :configured_table_arn,
686
+ :membership_id,
687
+ :membership_arn,
688
+ :role_arn,
689
+ :name,
690
+ :description,
691
+ :create_time,
692
+ :update_time)
693
+ SENSITIVE = []
694
+ include Aws::Structure
695
+ end
696
+
697
+ # The configured table association summary for the objects listed by the
698
+ # request.
699
+ #
700
+ # @!attribute [rw] configured_table_id
701
+ # The unique configured table ID that this configured table
702
+ # association refers to.
703
+ # @return [String]
704
+ #
705
+ # @!attribute [rw] membership_id
706
+ # The unique ID for the membership that the configured table
707
+ # association belongs to.
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] membership_arn
711
+ # The unique ARN for the membership that the configured table
712
+ # association belongs to.
713
+ # @return [String]
714
+ #
715
+ # @!attribute [rw] name
716
+ # The name of the configured table association. The table is
717
+ # identified by this name when running Protected Queries against the
718
+ # underlying data.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] create_time
722
+ # The time the configured table association was created.
723
+ # @return [Time]
724
+ #
725
+ # @!attribute [rw] update_time
726
+ # The time the configured table association was last updated.
727
+ # @return [Time]
728
+ #
729
+ # @!attribute [rw] id
730
+ # The unique ID for the configured table association.
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] arn
734
+ # The unique ARN for the configured table association.
735
+ # @return [String]
736
+ #
737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAssociationSummary AWS API Documentation
738
+ #
739
+ class ConfiguredTableAssociationSummary < Struct.new(
740
+ :configured_table_id,
741
+ :membership_id,
742
+ :membership_arn,
743
+ :name,
744
+ :create_time,
745
+ :update_time,
746
+ :id,
747
+ :arn)
748
+ SENSITIVE = []
749
+ include Aws::Structure
750
+ end
751
+
752
+ # The configured table summary for the objects listed by the request.
753
+ #
754
+ # @!attribute [rw] id
755
+ # The unique ID of the configured table.
756
+ # @return [String]
757
+ #
758
+ # @!attribute [rw] arn
759
+ # The unique ARN of the configured table.
760
+ # @return [String]
761
+ #
762
+ # @!attribute [rw] name
763
+ # The name of the configured table.
764
+ # @return [String]
765
+ #
766
+ # @!attribute [rw] create_time
767
+ # The time the configured table was created.
768
+ # @return [Time]
769
+ #
770
+ # @!attribute [rw] update_time
771
+ # The time the configured table was last updated.
772
+ # @return [Time]
773
+ #
774
+ # @!attribute [rw] analysis_rule_types
775
+ # The types of analysis rules associated with this configured table.
776
+ # @return [Array<String>]
777
+ #
778
+ # @!attribute [rw] analysis_method
779
+ # The analysis method for the configured tables. The only valid value
780
+ # is currently `DIRECT\_QUERY`.
781
+ # @return [String]
782
+ #
783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableSummary AWS API Documentation
784
+ #
785
+ class ConfiguredTableSummary < Struct.new(
786
+ :id,
787
+ :arn,
788
+ :name,
789
+ :create_time,
790
+ :update_time,
791
+ :analysis_rule_types,
792
+ :analysis_method)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
797
+ # Updating or deleting a resource can cause an inconsistent state.
798
+ #
799
+ # @!attribute [rw] message
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] resource_id
803
+ # The ID of the conflicting resource.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] resource_type
807
+ # The type of the conflicting resource.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] reason
811
+ # A reason code for the exception.
812
+ # @return [String]
813
+ #
814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConflictException AWS API Documentation
815
+ #
816
+ class ConflictException < Struct.new(
817
+ :message,
818
+ :resource_id,
819
+ :resource_type,
820
+ :reason)
821
+ SENSITIVE = []
822
+ include Aws::Structure
823
+ end
824
+
825
+ # @!attribute [rw] members
826
+ # A list of initial members, not including the creator. This list is
827
+ # immutable.
828
+ # @return [Array<Types::MemberSpecification>]
829
+ #
830
+ # @!attribute [rw] name
831
+ # The display name for a collaboration.
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] description
835
+ # A description of the collaboration provided by the collaboration
836
+ # owner.
837
+ # @return [String]
838
+ #
839
+ # @!attribute [rw] creator_member_abilities
840
+ # The abilities granted to the collaboration creator.
841
+ # @return [Array<String>]
842
+ #
843
+ # @!attribute [rw] creator_display_name
844
+ # The display name of the collaboration creator.
845
+ # @return [String]
846
+ #
847
+ # @!attribute [rw] data_encryption_metadata
848
+ # The settings for client-side encryption with Cryptographic Computing
849
+ # for Clean Rooms.
850
+ # @return [Types::DataEncryptionMetadata]
851
+ #
852
+ # @!attribute [rw] query_log_status
853
+ # An indicator as to whether query logging has been enabled or
854
+ # disabled for the collaboration.
855
+ # @return [String]
856
+ #
857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateCollaborationInput AWS API Documentation
858
+ #
859
+ class CreateCollaborationInput < Struct.new(
860
+ :members,
861
+ :name,
862
+ :description,
863
+ :creator_member_abilities,
864
+ :creator_display_name,
865
+ :data_encryption_metadata,
866
+ :query_log_status)
867
+ SENSITIVE = []
868
+ include Aws::Structure
869
+ end
870
+
871
+ # @!attribute [rw] collaboration
872
+ # The entire created collaboration object.
873
+ # @return [Types::Collaboration]
874
+ #
875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateCollaborationOutput AWS API Documentation
876
+ #
877
+ class CreateCollaborationOutput < Struct.new(
878
+ :collaboration)
879
+ SENSITIVE = []
880
+ include Aws::Structure
881
+ end
882
+
883
+ # @!attribute [rw] configured_table_identifier
884
+ # The identifier for the configured table to create the analysis rule
885
+ # for. Currently accepts the configured table ID.
886
+ # @return [String]
887
+ #
888
+ # @!attribute [rw] analysis_rule_type
889
+ # The type of analysis rule. Valid values are AGGREGATION and LIST.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] analysis_rule_policy
893
+ # The entire created configured table analysis rule object.
894
+ # @return [Types::ConfiguredTableAnalysisRulePolicy]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRuleInput AWS API Documentation
897
+ #
898
+ class CreateConfiguredTableAnalysisRuleInput < Struct.new(
899
+ :configured_table_identifier,
900
+ :analysis_rule_type,
901
+ :analysis_rule_policy)
902
+ SENSITIVE = []
903
+ include Aws::Structure
904
+ end
905
+
906
+ # @!attribute [rw] analysis_rule
907
+ # The entire created analysis rule.
908
+ # @return [Types::ConfiguredTableAnalysisRule]
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRuleOutput AWS API Documentation
911
+ #
912
+ class CreateConfiguredTableAnalysisRuleOutput < Struct.new(
913
+ :analysis_rule)
914
+ SENSITIVE = []
915
+ include Aws::Structure
916
+ end
917
+
918
+ # @!attribute [rw] name
919
+ # The name of the configured table association. This name is used to
920
+ # query the underlying configured table.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] description
924
+ # A description for the configured table association.
925
+ # @return [String]
926
+ #
927
+ # @!attribute [rw] membership_identifier
928
+ # A unique identifier for one of your memberships for a collaboration.
929
+ # The configured table is associated to the collaboration that this
930
+ # membership belongs to. Currently accepts a membership ID.
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] configured_table_identifier
934
+ # A unique identifier for the configured table to be associated to.
935
+ # Currently accepts a configured table ID.
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] role_arn
939
+ # The service will assume this role to access catalog metadata and
940
+ # query the table.
941
+ # @return [String]
942
+ #
943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAssociationInput AWS API Documentation
944
+ #
945
+ class CreateConfiguredTableAssociationInput < Struct.new(
946
+ :name,
947
+ :description,
948
+ :membership_identifier,
949
+ :configured_table_identifier,
950
+ :role_arn)
951
+ SENSITIVE = []
952
+ include Aws::Structure
953
+ end
954
+
955
+ # @!attribute [rw] configured_table_association
956
+ # The entire configured table association object.
957
+ # @return [Types::ConfiguredTableAssociation]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableAssociationOutput AWS API Documentation
960
+ #
961
+ class CreateConfiguredTableAssociationOutput < Struct.new(
962
+ :configured_table_association)
963
+ SENSITIVE = []
964
+ include Aws::Structure
965
+ end
966
+
967
+ # @!attribute [rw] name
968
+ # The name of the configured table.
969
+ # @return [String]
970
+ #
971
+ # @!attribute [rw] description
972
+ # A description for the configured table.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] table_reference
976
+ # A reference to the AWS Glue table being configured.
977
+ # @return [Types::TableReference]
978
+ #
979
+ # @!attribute [rw] allowed_columns
980
+ # The columns of the underlying table that can be used by
981
+ # collaborations or analysis rules.
982
+ # @return [Array<String>]
983
+ #
984
+ # @!attribute [rw] analysis_method
985
+ # The analysis method for the configured tables. The only valid value
986
+ # is currently `DIRECT\_QUERY`.
987
+ # @return [String]
988
+ #
989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableInput AWS API Documentation
990
+ #
991
+ class CreateConfiguredTableInput < Struct.new(
992
+ :name,
993
+ :description,
994
+ :table_reference,
995
+ :allowed_columns,
996
+ :analysis_method)
997
+ SENSITIVE = []
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # @!attribute [rw] configured_table
1002
+ # The created configured table.
1003
+ # @return [Types::ConfiguredTable]
1004
+ #
1005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTableOutput AWS API Documentation
1006
+ #
1007
+ class CreateConfiguredTableOutput < Struct.new(
1008
+ :configured_table)
1009
+ SENSITIVE = []
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @!attribute [rw] collaboration_identifier
1014
+ # The unique ID for the associated collaboration.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] query_log_status
1018
+ # An indicator as to whether query logging has been enabled or
1019
+ # disabled for the collaboration.
1020
+ # @return [String]
1021
+ #
1022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateMembershipInput AWS API Documentation
1023
+ #
1024
+ class CreateMembershipInput < Struct.new(
1025
+ :collaboration_identifier,
1026
+ :query_log_status)
1027
+ SENSITIVE = []
1028
+ include Aws::Structure
1029
+ end
1030
+
1031
+ # @!attribute [rw] membership
1032
+ # The membership that was created.
1033
+ # @return [Types::Membership]
1034
+ #
1035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateMembershipOutput AWS API Documentation
1036
+ #
1037
+ class CreateMembershipOutput < Struct.new(
1038
+ :membership)
1039
+ SENSITIVE = []
1040
+ include Aws::Structure
1041
+ end
1042
+
1043
+ # The settings for client-side encryption for cryptographic computing.
1044
+ #
1045
+ # @!attribute [rw] allow_cleartext
1046
+ # Indicates whether encrypted tables can contain cleartext data (true)
1047
+ # or are to cryptographically process every column (false).
1048
+ # @return [Boolean]
1049
+ #
1050
+ # @!attribute [rw] allow_duplicates
1051
+ # Indicates whether Fingerprint columns can contain duplicate entries
1052
+ # (true) or are to contain only non-repeated values (false).
1053
+ # @return [Boolean]
1054
+ #
1055
+ # @!attribute [rw] allow_joins_on_columns_with_different_names
1056
+ # Indicates whether Fingerprint columns can be joined on any other
1057
+ # Fingerprint column with a different name (true) or can only be
1058
+ # joined on Fingerprint columns of the same name (false).
1059
+ # @return [Boolean]
1060
+ #
1061
+ # @!attribute [rw] preserve_nulls
1062
+ # Indicates whether NULL values are to be copied as NULL to encrypted
1063
+ # tables (true) or cryptographically processed (false).
1064
+ # @return [Boolean]
1065
+ #
1066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DataEncryptionMetadata AWS API Documentation
1067
+ #
1068
+ class DataEncryptionMetadata < Struct.new(
1069
+ :allow_cleartext,
1070
+ :allow_duplicates,
1071
+ :allow_joins_on_columns_with_different_names,
1072
+ :preserve_nulls)
1073
+ SENSITIVE = []
1074
+ include Aws::Structure
1075
+ end
1076
+
1077
+ # @!attribute [rw] collaboration_identifier
1078
+ # The identifier for the collaboration.
1079
+ # @return [String]
1080
+ #
1081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteCollaborationInput AWS API Documentation
1082
+ #
1083
+ class DeleteCollaborationInput < Struct.new(
1084
+ :collaboration_identifier)
1085
+ SENSITIVE = []
1086
+ include Aws::Structure
1087
+ end
1088
+
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteCollaborationOutput AWS API Documentation
1090
+ #
1091
+ class DeleteCollaborationOutput < Aws::EmptyStructure; end
1092
+
1093
+ # @!attribute [rw] configured_table_identifier
1094
+ # The unique identifier for the configured table that the analysis
1095
+ # rule applies to. Currently accepts the configured table ID.
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] analysis_rule_type
1099
+ # The analysis rule type to be deleted. Configured table analysis
1100
+ # rules are uniquely identified by their configured table identifier
1101
+ # and analysis rule type.
1102
+ # @return [String]
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRuleInput AWS API Documentation
1105
+ #
1106
+ class DeleteConfiguredTableAnalysisRuleInput < Struct.new(
1107
+ :configured_table_identifier,
1108
+ :analysis_rule_type)
1109
+ SENSITIVE = []
1110
+ include Aws::Structure
1111
+ end
1112
+
1113
+ # An empty response that indicates a successful delete.
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRuleOutput AWS API Documentation
1116
+ #
1117
+ class DeleteConfiguredTableAnalysisRuleOutput < Aws::EmptyStructure; end
1118
+
1119
+ # @!attribute [rw] configured_table_association_identifier
1120
+ # The unique ID for the configured table association to be deleted.
1121
+ # Currently accepts the configured table ID.
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] membership_identifier
1125
+ # A unique identifier for the membership that the configured table
1126
+ # association belongs to. Currently accepts the membership ID.
1127
+ # @return [String]
1128
+ #
1129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationInput AWS API Documentation
1130
+ #
1131
+ class DeleteConfiguredTableAssociationInput < Struct.new(
1132
+ :configured_table_association_identifier,
1133
+ :membership_identifier)
1134
+ SENSITIVE = []
1135
+ include Aws::Structure
1136
+ end
1137
+
1138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationOutput AWS API Documentation
1139
+ #
1140
+ class DeleteConfiguredTableAssociationOutput < Aws::EmptyStructure; end
1141
+
1142
+ # @!attribute [rw] configured_table_identifier
1143
+ # The unique ID for the configured table to delete.
1144
+ # @return [String]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableInput AWS API Documentation
1147
+ #
1148
+ class DeleteConfiguredTableInput < Struct.new(
1149
+ :configured_table_identifier)
1150
+ SENSITIVE = []
1151
+ include Aws::Structure
1152
+ end
1153
+
1154
+ # The empty output for a successful deletion.
1155
+ #
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableOutput AWS API Documentation
1157
+ #
1158
+ class DeleteConfiguredTableOutput < Aws::EmptyStructure; end
1159
+
1160
+ # @!attribute [rw] collaboration_identifier
1161
+ # The unique identifier for the associated collaboration.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] account_id
1165
+ # The account ID of the member to remove.
1166
+ # @return [String]
1167
+ #
1168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteMemberInput AWS API Documentation
1169
+ #
1170
+ class DeleteMemberInput < Struct.new(
1171
+ :collaboration_identifier,
1172
+ :account_id)
1173
+ SENSITIVE = []
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteMemberOutput AWS API Documentation
1178
+ #
1179
+ class DeleteMemberOutput < Aws::EmptyStructure; end
1180
+
1181
+ # @!attribute [rw] membership_identifier
1182
+ # The identifier for a membership resource.
1183
+ # @return [String]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteMembershipInput AWS API Documentation
1186
+ #
1187
+ class DeleteMembershipInput < Struct.new(
1188
+ :membership_identifier)
1189
+ SENSITIVE = []
1190
+ include Aws::Structure
1191
+ end
1192
+
1193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteMembershipOutput AWS API Documentation
1194
+ #
1195
+ class DeleteMembershipOutput < Aws::EmptyStructure; end
1196
+
1197
+ # @!attribute [rw] collaboration_identifier
1198
+ # The identifier for the collaboration.
1199
+ # @return [String]
1200
+ #
1201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaborationInput AWS API Documentation
1202
+ #
1203
+ class GetCollaborationInput < Struct.new(
1204
+ :collaboration_identifier)
1205
+ SENSITIVE = []
1206
+ include Aws::Structure
1207
+ end
1208
+
1209
+ # @!attribute [rw] collaboration
1210
+ # The entire collaboration for this identifier.
1211
+ # @return [Types::Collaboration]
1212
+ #
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaborationOutput AWS API Documentation
1214
+ #
1215
+ class GetCollaborationOutput < Struct.new(
1216
+ :collaboration)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
1221
+ # @!attribute [rw] configured_table_identifier
1222
+ # The unique identifier for the configured table to retrieve.
1223
+ # Currently accepts the configured table ID.
1224
+ # @return [String]
1225
+ #
1226
+ # @!attribute [rw] analysis_rule_type
1227
+ # The analysis rule to be retrieved. Configured table analysis rules
1228
+ # are uniquely identified by their configured table identifier and
1229
+ # analysis rule type.
1230
+ # @return [String]
1231
+ #
1232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRuleInput AWS API Documentation
1233
+ #
1234
+ class GetConfiguredTableAnalysisRuleInput < Struct.new(
1235
+ :configured_table_identifier,
1236
+ :analysis_rule_type)
1237
+ SENSITIVE = []
1238
+ include Aws::Structure
1239
+ end
1240
+
1241
+ # @!attribute [rw] analysis_rule
1242
+ # The entire analysis rule output.
1243
+ # @return [Types::ConfiguredTableAnalysisRule]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRuleOutput AWS API Documentation
1246
+ #
1247
+ class GetConfiguredTableAnalysisRuleOutput < Struct.new(
1248
+ :analysis_rule)
1249
+ SENSITIVE = []
1250
+ include Aws::Structure
1251
+ end
1252
+
1253
+ # @!attribute [rw] configured_table_association_identifier
1254
+ # The unique ID for the configured table association to retrieve.
1255
+ # Currently accepts the configured table ID.
1256
+ # @return [String]
1257
+ #
1258
+ # @!attribute [rw] membership_identifier
1259
+ # A unique identifier for the membership that the configured table
1260
+ # association belongs to. Currently accepts the membership ID.
1261
+ # @return [String]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAssociationInput AWS API Documentation
1264
+ #
1265
+ class GetConfiguredTableAssociationInput < Struct.new(
1266
+ :configured_table_association_identifier,
1267
+ :membership_identifier)
1268
+ SENSITIVE = []
1269
+ include Aws::Structure
1270
+ end
1271
+
1272
+ # @!attribute [rw] configured_table_association
1273
+ # The entire configured table association object.
1274
+ # @return [Types::ConfiguredTableAssociation]
1275
+ #
1276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAssociationOutput AWS API Documentation
1277
+ #
1278
+ class GetConfiguredTableAssociationOutput < Struct.new(
1279
+ :configured_table_association)
1280
+ SENSITIVE = []
1281
+ include Aws::Structure
1282
+ end
1283
+
1284
+ # @!attribute [rw] configured_table_identifier
1285
+ # The unique ID for the configured table to retrieve.
1286
+ # @return [String]
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableInput AWS API Documentation
1289
+ #
1290
+ class GetConfiguredTableInput < Struct.new(
1291
+ :configured_table_identifier)
1292
+ SENSITIVE = []
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # @!attribute [rw] configured_table
1297
+ # The retrieved configured table.
1298
+ # @return [Types::ConfiguredTable]
1299
+ #
1300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableOutput AWS API Documentation
1301
+ #
1302
+ class GetConfiguredTableOutput < Struct.new(
1303
+ :configured_table)
1304
+ SENSITIVE = []
1305
+ include Aws::Structure
1306
+ end
1307
+
1308
+ # @!attribute [rw] membership_identifier
1309
+ # The identifier for a membership resource.
1310
+ # @return [String]
1311
+ #
1312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetMembershipInput AWS API Documentation
1313
+ #
1314
+ class GetMembershipInput < Struct.new(
1315
+ :membership_identifier)
1316
+ SENSITIVE = []
1317
+ include Aws::Structure
1318
+ end
1319
+
1320
+ # @!attribute [rw] membership
1321
+ # The membership retrieved for the provided identifier.
1322
+ # @return [Types::Membership]
1323
+ #
1324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetMembershipOutput AWS API Documentation
1325
+ #
1326
+ class GetMembershipOutput < Struct.new(
1327
+ :membership)
1328
+ SENSITIVE = []
1329
+ include Aws::Structure
1330
+ end
1331
+
1332
+ # @!attribute [rw] membership_identifier
1333
+ # The identifier for a membership in a protected query instance.
1334
+ # @return [String]
1335
+ #
1336
+ # @!attribute [rw] protected_query_identifier
1337
+ # The identifier for a protected query instance.
1338
+ # @return [String]
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedQueryInput AWS API Documentation
1341
+ #
1342
+ class GetProtectedQueryInput < Struct.new(
1343
+ :membership_identifier,
1344
+ :protected_query_identifier)
1345
+ SENSITIVE = []
1346
+ include Aws::Structure
1347
+ end
1348
+
1349
+ # @!attribute [rw] protected_query
1350
+ # The query processing metadata.
1351
+ # @return [Types::ProtectedQuery]
1352
+ #
1353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedQueryOutput AWS API Documentation
1354
+ #
1355
+ class GetProtectedQueryOutput < Struct.new(
1356
+ :protected_query)
1357
+ SENSITIVE = []
1358
+ include Aws::Structure
1359
+ end
1360
+
1361
+ # @!attribute [rw] collaboration_identifier
1362
+ # A unique identifier for the collaboration that the schema belongs
1363
+ # to. Currently accepts a collaboration ID.
1364
+ # @return [String]
1365
+ #
1366
+ # @!attribute [rw] name
1367
+ # The name of the schema to retrieve the analysis rule for.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] type
1371
+ # The type of the schema analysis rule to retrieve. Schema analysis
1372
+ # rules are uniquely identified by a combination of the collaboration,
1373
+ # the schema name, and their type.
1374
+ # @return [String]
1375
+ #
1376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaAnalysisRuleInput AWS API Documentation
1377
+ #
1378
+ class GetSchemaAnalysisRuleInput < Struct.new(
1379
+ :collaboration_identifier,
1380
+ :name,
1381
+ :type)
1382
+ SENSITIVE = []
1383
+ include Aws::Structure
1384
+ end
1385
+
1386
+ # @!attribute [rw] analysis_rule
1387
+ # A specification about how data from the configured table can be
1388
+ # used.
1389
+ # @return [Types::AnalysisRule]
1390
+ #
1391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaAnalysisRuleOutput AWS API Documentation
1392
+ #
1393
+ class GetSchemaAnalysisRuleOutput < Struct.new(
1394
+ :analysis_rule)
1395
+ SENSITIVE = []
1396
+ include Aws::Structure
1397
+ end
1398
+
1399
+ # @!attribute [rw] collaboration_identifier
1400
+ # A unique identifier for the collaboration that the schema belongs
1401
+ # to. Currently accepts a collaboration ID.
1402
+ # @return [String]
1403
+ #
1404
+ # @!attribute [rw] name
1405
+ # The name of the relation to retrieve the schema for.
1406
+ # @return [String]
1407
+ #
1408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaInput AWS API Documentation
1409
+ #
1410
+ class GetSchemaInput < Struct.new(
1411
+ :collaboration_identifier,
1412
+ :name)
1413
+ SENSITIVE = []
1414
+ include Aws::Structure
1415
+ end
1416
+
1417
+ # @!attribute [rw] schema
1418
+ # The entire schema object.
1419
+ # @return [Types::Schema]
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaOutput AWS API Documentation
1422
+ #
1423
+ class GetSchemaOutput < Struct.new(
1424
+ :schema)
1425
+ SENSITIVE = []
1426
+ include Aws::Structure
1427
+ end
1428
+
1429
+ # A reference to a table within an AWS Glue data catalog.
1430
+ #
1431
+ # @!attribute [rw] table_name
1432
+ # The name of the AWS Glue table.
1433
+ # @return [String]
1434
+ #
1435
+ # @!attribute [rw] database_name
1436
+ # The name of the database the AWS Glue table belongs to.
1437
+ # @return [String]
1438
+ #
1439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GlueTableReference AWS API Documentation
1440
+ #
1441
+ class GlueTableReference < Struct.new(
1442
+ :table_name,
1443
+ :database_name)
1444
+ SENSITIVE = []
1445
+ include Aws::Structure
1446
+ end
1447
+
1448
+ # Unexpected error during processing of request.
1449
+ #
1450
+ # @!attribute [rw] message
1451
+ # @return [String]
1452
+ #
1453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/InternalServerException AWS API Documentation
1454
+ #
1455
+ class InternalServerException < Struct.new(
1456
+ :message)
1457
+ SENSITIVE = []
1458
+ include Aws::Structure
1459
+ end
1460
+
1461
+ # @!attribute [rw] next_token
1462
+ # The token value retrieved from a previous call to access the next
1463
+ # page of results.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] max_results
1467
+ # The maximum size of the results that is returned per call. Service
1468
+ # chooses a default if it has not been set. Service may return a
1469
+ # nextToken even if the maximum results has not been met.
1470
+ # @return [Integer]
1471
+ #
1472
+ # @!attribute [rw] member_status
1473
+ # The caller's status in a collaboration.
1474
+ # @return [String]
1475
+ #
1476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationsInput AWS API Documentation
1477
+ #
1478
+ class ListCollaborationsInput < Struct.new(
1479
+ :next_token,
1480
+ :max_results,
1481
+ :member_status)
1482
+ SENSITIVE = []
1483
+ include Aws::Structure
1484
+ end
1485
+
1486
+ # @!attribute [rw] next_token
1487
+ # The token value retrieved from a previous call to access the next
1488
+ # page of results.
1489
+ # @return [String]
1490
+ #
1491
+ # @!attribute [rw] collaboration_list
1492
+ # The list of collaborations.
1493
+ # @return [Array<Types::CollaborationSummary>]
1494
+ #
1495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationsOutput AWS API Documentation
1496
+ #
1497
+ class ListCollaborationsOutput < Struct.new(
1498
+ :next_token,
1499
+ :collaboration_list)
1500
+ SENSITIVE = []
1501
+ include Aws::Structure
1502
+ end
1503
+
1504
+ # @!attribute [rw] membership_identifier
1505
+ # A unique identifier for the membership to list configured table
1506
+ # associations for. Currently accepts the membership ID.
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] next_token
1510
+ # The token value retrieved from a previous call to access the next
1511
+ # page of results.
1512
+ # @return [String]
1513
+ #
1514
+ # @!attribute [rw] max_results
1515
+ # The maximum size of the results that is returned per call.
1516
+ # @return [Integer]
1517
+ #
1518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTableAssociationsInput AWS API Documentation
1519
+ #
1520
+ class ListConfiguredTableAssociationsInput < Struct.new(
1521
+ :membership_identifier,
1522
+ :next_token,
1523
+ :max_results)
1524
+ SENSITIVE = []
1525
+ include Aws::Structure
1526
+ end
1527
+
1528
+ # @!attribute [rw] configured_table_association_summaries
1529
+ # The retrieved list of configured table associations.
1530
+ # @return [Array<Types::ConfiguredTableAssociationSummary>]
1531
+ #
1532
+ # @!attribute [rw] next_token
1533
+ # The token value retrieved from a previous call to access the next
1534
+ # page of results.
1535
+ # @return [String]
1536
+ #
1537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTableAssociationsOutput AWS API Documentation
1538
+ #
1539
+ class ListConfiguredTableAssociationsOutput < Struct.new(
1540
+ :configured_table_association_summaries,
1541
+ :next_token)
1542
+ SENSITIVE = []
1543
+ include Aws::Structure
1544
+ end
1545
+
1546
+ # @!attribute [rw] next_token
1547
+ # The token value retrieved from a previous call to access the next
1548
+ # page of results.
1549
+ # @return [String]
1550
+ #
1551
+ # @!attribute [rw] max_results
1552
+ # The maximum size of the results that is returned per call.
1553
+ # @return [Integer]
1554
+ #
1555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTablesInput AWS API Documentation
1556
+ #
1557
+ class ListConfiguredTablesInput < Struct.new(
1558
+ :next_token,
1559
+ :max_results)
1560
+ SENSITIVE = []
1561
+ include Aws::Structure
1562
+ end
1563
+
1564
+ # @!attribute [rw] configured_table_summaries
1565
+ # The configured tables listed by the request.
1566
+ # @return [Array<Types::ConfiguredTableSummary>]
1567
+ #
1568
+ # @!attribute [rw] next_token
1569
+ # The token value retrieved from a previous call to access the next
1570
+ # page of results.
1571
+ # @return [String]
1572
+ #
1573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTablesOutput AWS API Documentation
1574
+ #
1575
+ class ListConfiguredTablesOutput < Struct.new(
1576
+ :configured_table_summaries,
1577
+ :next_token)
1578
+ SENSITIVE = []
1579
+ include Aws::Structure
1580
+ end
1581
+
1582
+ # @!attribute [rw] collaboration_identifier
1583
+ # The identifier of the collaboration in which the members are listed.
1584
+ # @return [String]
1585
+ #
1586
+ # @!attribute [rw] next_token
1587
+ # The token value retrieved from a previous call to access the next
1588
+ # page of results.
1589
+ # @return [String]
1590
+ #
1591
+ # @!attribute [rw] max_results
1592
+ # The maximum size of the results that is returned per call.
1593
+ # @return [Integer]
1594
+ #
1595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMembersInput AWS API Documentation
1596
+ #
1597
+ class ListMembersInput < Struct.new(
1598
+ :collaboration_identifier,
1599
+ :next_token,
1600
+ :max_results)
1601
+ SENSITIVE = []
1602
+ include Aws::Structure
1603
+ end
1604
+
1605
+ # @!attribute [rw] next_token
1606
+ # The token value retrieved from a previous call to access the next
1607
+ # page of results.
1608
+ # @return [String]
1609
+ #
1610
+ # @!attribute [rw] member_summaries
1611
+ # The list of members returned by the ListMembers operation.
1612
+ # @return [Array<Types::MemberSummary>]
1613
+ #
1614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMembersOutput AWS API Documentation
1615
+ #
1616
+ class ListMembersOutput < Struct.new(
1617
+ :next_token,
1618
+ :member_summaries)
1619
+ SENSITIVE = []
1620
+ include Aws::Structure
1621
+ end
1622
+
1623
+ # @!attribute [rw] next_token
1624
+ # The token value retrieved from a previous call to access the next
1625
+ # page of results.
1626
+ # @return [String]
1627
+ #
1628
+ # @!attribute [rw] max_results
1629
+ # The maximum size of the results that is returned per call.
1630
+ # @return [Integer]
1631
+ #
1632
+ # @!attribute [rw] status
1633
+ # A filter which will return only memberships in the specified status.
1634
+ # @return [String]
1635
+ #
1636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMembershipsInput AWS API Documentation
1637
+ #
1638
+ class ListMembershipsInput < Struct.new(
1639
+ :next_token,
1640
+ :max_results,
1641
+ :status)
1642
+ SENSITIVE = []
1643
+ include Aws::Structure
1644
+ end
1645
+
1646
+ # @!attribute [rw] next_token
1647
+ # The token value retrieved from a previous call to access the next
1648
+ # page of results.
1649
+ # @return [String]
1650
+ #
1651
+ # @!attribute [rw] membership_summaries
1652
+ # The list of memberships returned from the ListMemberships operation.
1653
+ # @return [Array<Types::MembershipSummary>]
1654
+ #
1655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMembershipsOutput AWS API Documentation
1656
+ #
1657
+ class ListMembershipsOutput < Struct.new(
1658
+ :next_token,
1659
+ :membership_summaries)
1660
+ SENSITIVE = []
1661
+ include Aws::Structure
1662
+ end
1663
+
1664
+ # @!attribute [rw] membership_identifier
1665
+ # The identifier for the membership in the collaboration.
1666
+ # @return [String]
1667
+ #
1668
+ # @!attribute [rw] status
1669
+ # A filter on the status of the protected query.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] next_token
1673
+ # The token value retrieved from a previous call to access the next
1674
+ # page of results.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] max_results
1678
+ # The maximum size of the results that is returned per call. Service
1679
+ # chooses a default if it has not been set. Service can return a
1680
+ # nextToken even if the maximum results has not been met.
1681
+ # @return [Integer]
1682
+ #
1683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedQueriesInput AWS API Documentation
1684
+ #
1685
+ class ListProtectedQueriesInput < Struct.new(
1686
+ :membership_identifier,
1687
+ :status,
1688
+ :next_token,
1689
+ :max_results)
1690
+ SENSITIVE = []
1691
+ include Aws::Structure
1692
+ end
1693
+
1694
+ # @!attribute [rw] next_token
1695
+ # The token value retrieved from a previous call to access the next
1696
+ # page of results.
1697
+ # @return [String]
1698
+ #
1699
+ # @!attribute [rw] protected_queries
1700
+ # A list of protected queries.
1701
+ # @return [Array<Types::ProtectedQuerySummary>]
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedQueriesOutput AWS API Documentation
1704
+ #
1705
+ class ListProtectedQueriesOutput < Struct.new(
1706
+ :next_token,
1707
+ :protected_queries)
1708
+ SENSITIVE = []
1709
+ include Aws::Structure
1710
+ end
1711
+
1712
+ # @!attribute [rw] collaboration_identifier
1713
+ # A unique identifier for the collaboration that the schema belongs
1714
+ # to. Currently accepts a collaboration ID.
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] schema_type
1718
+ # If present, filter schemas by schema type. The only valid schema
1719
+ # type is currently `TABLE`.
1720
+ # @return [String]
1721
+ #
1722
+ # @!attribute [rw] next_token
1723
+ # The token value retrieved from a previous call to access the next
1724
+ # page of results.
1725
+ # @return [String]
1726
+ #
1727
+ # @!attribute [rw] max_results
1728
+ # The maximum size of the results that is returned per call.
1729
+ # @return [Integer]
1730
+ #
1731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListSchemasInput AWS API Documentation
1732
+ #
1733
+ class ListSchemasInput < Struct.new(
1734
+ :collaboration_identifier,
1735
+ :schema_type,
1736
+ :next_token,
1737
+ :max_results)
1738
+ SENSITIVE = []
1739
+ include Aws::Structure
1740
+ end
1741
+
1742
+ # @!attribute [rw] schema_summaries
1743
+ # The retrieved list of schemas.
1744
+ # @return [Array<Types::SchemaSummary>]
1745
+ #
1746
+ # @!attribute [rw] next_token
1747
+ # The token value retrieved from a previous call to access the next
1748
+ # page of results.
1749
+ # @return [String]
1750
+ #
1751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListSchemasOutput AWS API Documentation
1752
+ #
1753
+ class ListSchemasOutput < Struct.new(
1754
+ :schema_summaries,
1755
+ :next_token)
1756
+ SENSITIVE = []
1757
+ include Aws::Structure
1758
+ end
1759
+
1760
+ # Basic metadata used to construct a new member.
1761
+ #
1762
+ # @!attribute [rw] account_id
1763
+ # The identifier used to reference members of the collaboration.
1764
+ # Currently only supports AWS Account ID.
1765
+ # @return [String]
1766
+ #
1767
+ # @!attribute [rw] member_abilities
1768
+ # The abilities granted to the collaboration member.
1769
+ # @return [Array<String>]
1770
+ #
1771
+ # @!attribute [rw] display_name
1772
+ # The member's display name.
1773
+ # @return [String]
1774
+ #
1775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MemberSpecification AWS API Documentation
1776
+ #
1777
+ class MemberSpecification < Struct.new(
1778
+ :account_id,
1779
+ :member_abilities,
1780
+ :display_name)
1781
+ SENSITIVE = []
1782
+ include Aws::Structure
1783
+ end
1784
+
1785
+ # The member object listed by the request.
1786
+ #
1787
+ # @!attribute [rw] account_id
1788
+ # The identifier used to reference members of the collaboration.
1789
+ # Currently only supports AWS Account ID.
1790
+ # @return [String]
1791
+ #
1792
+ # @!attribute [rw] status
1793
+ # The status of the member. Valid values are `INVITED`, `ACTIVE`,
1794
+ # `LEFT`, and `REMOVED`.
1795
+ # @return [String]
1796
+ #
1797
+ # @!attribute [rw] display_name
1798
+ # The member's display name.
1799
+ # @return [String]
1800
+ #
1801
+ # @!attribute [rw] abilities
1802
+ # The abilities granted to the collaboration member.
1803
+ # @return [Array<String>]
1804
+ #
1805
+ # @!attribute [rw] create_time
1806
+ # The time when the member was created.
1807
+ # @return [Time]
1808
+ #
1809
+ # @!attribute [rw] update_time
1810
+ # The time the member metadata was last updated.
1811
+ # @return [Time]
1812
+ #
1813
+ # @!attribute [rw] membership_id
1814
+ # The unique ID for the member's associated membership, if present.
1815
+ # @return [String]
1816
+ #
1817
+ # @!attribute [rw] membership_arn
1818
+ # The unique ARN for the member's associated membership, if present.
1819
+ # @return [String]
1820
+ #
1821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MemberSummary AWS API Documentation
1822
+ #
1823
+ class MemberSummary < Struct.new(
1824
+ :account_id,
1825
+ :status,
1826
+ :display_name,
1827
+ :abilities,
1828
+ :create_time,
1829
+ :update_time,
1830
+ :membership_id,
1831
+ :membership_arn)
1832
+ SENSITIVE = []
1833
+ include Aws::Structure
1834
+ end
1835
+
1836
+ # The membership object.
1837
+ #
1838
+ # @!attribute [rw] id
1839
+ # The unique ID of the membership.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] arn
1843
+ # The unique ARN for the membership.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] collaboration_arn
1847
+ # The unique ARN for the membership's associated collaboration.
1848
+ # @return [String]
1849
+ #
1850
+ # @!attribute [rw] collaboration_id
1851
+ # The unique ID for the membership's collaboration.
1852
+ # @return [String]
1853
+ #
1854
+ # @!attribute [rw] collaboration_creator_account_id
1855
+ # The identifier used to reference members of the collaboration.
1856
+ # Currently only supports AWS account ID.
1857
+ # @return [String]
1858
+ #
1859
+ # @!attribute [rw] collaboration_creator_display_name
1860
+ # The display name of the collaboration creator.
1861
+ # @return [String]
1862
+ #
1863
+ # @!attribute [rw] collaboration_name
1864
+ # The name of the membership's collaboration.
1865
+ # @return [String]
1866
+ #
1867
+ # @!attribute [rw] create_time
1868
+ # The time when the membership was created.
1869
+ # @return [Time]
1870
+ #
1871
+ # @!attribute [rw] update_time
1872
+ # The time the membership metadata was last updated.
1873
+ # @return [Time]
1874
+ #
1875
+ # @!attribute [rw] status
1876
+ # The status of the membership. Valid values are `ACTIVE`,
1877
+ # `REMOVED`, and `COLLABORATION\_DELETED`.
1878
+ # @return [String]
1879
+ #
1880
+ # @!attribute [rw] member_abilities
1881
+ # The abilities granted to the collaboration member.
1882
+ # @return [Array<String>]
1883
+ #
1884
+ # @!attribute [rw] query_log_status
1885
+ # An indicator as to whether query logging has been enabled or
1886
+ # disabled for the collaboration.
1887
+ # @return [String]
1888
+ #
1889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/Membership AWS API Documentation
1890
+ #
1891
+ class Membership < Struct.new(
1892
+ :id,
1893
+ :arn,
1894
+ :collaboration_arn,
1895
+ :collaboration_id,
1896
+ :collaboration_creator_account_id,
1897
+ :collaboration_creator_display_name,
1898
+ :collaboration_name,
1899
+ :create_time,
1900
+ :update_time,
1901
+ :status,
1902
+ :member_abilities,
1903
+ :query_log_status)
1904
+ SENSITIVE = []
1905
+ include Aws::Structure
1906
+ end
1907
+
1908
+ # The membership object listed by the request.
1909
+ #
1910
+ # @!attribute [rw] id
1911
+ # The unique ID for the membership's collaboration.
1912
+ # @return [String]
1913
+ #
1914
+ # @!attribute [rw] arn
1915
+ # The unique ARN for the membership.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] collaboration_arn
1919
+ # The unique ARN for the membership's associated collaboration.
1920
+ # @return [String]
1921
+ #
1922
+ # @!attribute [rw] collaboration_id
1923
+ # The unique ID for the membership's collaboration.
1924
+ # @return [String]
1925
+ #
1926
+ # @!attribute [rw] collaboration_creator_account_id
1927
+ # The identifier of the AWS principal that created the collaboration.
1928
+ # Currently only supports AWS account ID.
1929
+ # @return [String]
1930
+ #
1931
+ # @!attribute [rw] collaboration_creator_display_name
1932
+ # The display name of the collaboration creator.
1933
+ # @return [String]
1934
+ #
1935
+ # @!attribute [rw] collaboration_name
1936
+ # The name for the membership's collaboration.
1937
+ # @return [String]
1938
+ #
1939
+ # @!attribute [rw] create_time
1940
+ # The time when the membership was created.
1941
+ # @return [Time]
1942
+ #
1943
+ # @!attribute [rw] update_time
1944
+ # The time the membership metadata was last updated.
1945
+ # @return [Time]
1946
+ #
1947
+ # @!attribute [rw] status
1948
+ # The status of the membership. Valid values are `ACTIVE`,
1949
+ # `REMOVED`, and `COLLABORATION\_DELETED`.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] member_abilities
1953
+ # The abilities granted to the collaboration member.
1954
+ # @return [Array<String>]
1955
+ #
1956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MembershipSummary AWS API Documentation
1957
+ #
1958
+ class MembershipSummary < Struct.new(
1959
+ :id,
1960
+ :arn,
1961
+ :collaboration_arn,
1962
+ :collaboration_id,
1963
+ :collaboration_creator_account_id,
1964
+ :collaboration_creator_display_name,
1965
+ :collaboration_name,
1966
+ :create_time,
1967
+ :update_time,
1968
+ :status,
1969
+ :member_abilities)
1970
+ SENSITIVE = []
1971
+ include Aws::Structure
1972
+ end
1973
+
1974
+ # The parameters for an AWS Clean Rooms protected query.
1975
+ #
1976
+ # @!attribute [rw] id
1977
+ # The identifier for a protected query instance.
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] membership_id
1981
+ # The identifier for the membership.
1982
+ # @return [String]
1983
+ #
1984
+ # @!attribute [rw] membership_arn
1985
+ # The ARN of the membership.
1986
+ # @return [String]
1987
+ #
1988
+ # @!attribute [rw] create_time
1989
+ # The time at which the protected query was created.
1990
+ # @return [Time]
1991
+ #
1992
+ # @!attribute [rw] sql_parameters
1993
+ # The protected query SQL parameters.
1994
+ # @return [Types::ProtectedQuerySQLParameters]
1995
+ #
1996
+ # @!attribute [rw] status
1997
+ # The status of the query.
1998
+ # @return [String]
1999
+ #
2000
+ # @!attribute [rw] result_configuration
2001
+ # Contains any details needed to write the query results.
2002
+ # @return [Types::ProtectedQueryResultConfiguration]
2003
+ #
2004
+ # @!attribute [rw] statistics
2005
+ # Statistics about protected query execution.
2006
+ # @return [Types::ProtectedQueryStatistics]
2007
+ #
2008
+ # @!attribute [rw] result
2009
+ # The result of the protected query.
2010
+ # @return [Types::ProtectedQueryResult]
2011
+ #
2012
+ # @!attribute [rw] error
2013
+ # An error thrown by the protected query.
2014
+ # @return [Types::ProtectedQueryError]
2015
+ #
2016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuery AWS API Documentation
2017
+ #
2018
+ class ProtectedQuery < Struct.new(
2019
+ :id,
2020
+ :membership_id,
2021
+ :membership_arn,
2022
+ :create_time,
2023
+ :sql_parameters,
2024
+ :status,
2025
+ :result_configuration,
2026
+ :statistics,
2027
+ :result,
2028
+ :error)
2029
+ SENSITIVE = [:sql_parameters]
2030
+ include Aws::Structure
2031
+ end
2032
+
2033
+ # Details of errors thrown by the protected query.
2034
+ #
2035
+ # @!attribute [rw] message
2036
+ # A description of why the query failed.
2037
+ # @return [String]
2038
+ #
2039
+ # @!attribute [rw] code
2040
+ # An error code for the error.
2041
+ # @return [String]
2042
+ #
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryError AWS API Documentation
2044
+ #
2045
+ class ProtectedQueryError < Struct.new(
2046
+ :message,
2047
+ :code)
2048
+ SENSITIVE = []
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # Contains details about the protected query output.
2053
+ #
2054
+ # @note ProtectedQueryOutput is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProtectedQueryOutput corresponding to the set member.
2055
+ #
2056
+ # @!attribute [rw] s3
2057
+ # If present, the output for a protected query with an `S3` output
2058
+ # type.
2059
+ # @return [Types::ProtectedQueryS3Output]
2060
+ #
2061
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryOutput AWS API Documentation
2062
+ #
2063
+ class ProtectedQueryOutput < Struct.new(
2064
+ :s3,
2065
+ :unknown)
2066
+ SENSITIVE = []
2067
+ include Aws::Structure
2068
+ include Aws::Structure::Union
2069
+
2070
+ class S3 < ProtectedQueryOutput; end
2071
+ class Unknown < ProtectedQueryOutput; end
2072
+ end
2073
+
2074
+ # Contains configuration details for protected query output.
2075
+ #
2076
+ # @note ProtectedQueryOutputConfiguration is a union - when making an API calls you must set exactly one of the members.
2077
+ #
2078
+ # @note ProtectedQueryOutputConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProtectedQueryOutputConfiguration corresponding to the set member.
2079
+ #
2080
+ # @!attribute [rw] s3
2081
+ # Required configuration for a protected query with an `S3` output
2082
+ # type.
2083
+ # @return [Types::ProtectedQueryS3OutputConfiguration]
2084
+ #
2085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryOutputConfiguration AWS API Documentation
2086
+ #
2087
+ class ProtectedQueryOutputConfiguration < Struct.new(
2088
+ :s3,
2089
+ :unknown)
2090
+ SENSITIVE = []
2091
+ include Aws::Structure
2092
+ include Aws::Structure::Union
2093
+
2094
+ class S3 < ProtectedQueryOutputConfiguration; end
2095
+ class Unknown < ProtectedQueryOutputConfiguration; end
2096
+ end
2097
+
2098
+ # Details about the query results.
2099
+ #
2100
+ # @!attribute [rw] output
2101
+ # The output of the protected query.
2102
+ # @return [Types::ProtectedQueryOutput]
2103
+ #
2104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryResult AWS API Documentation
2105
+ #
2106
+ class ProtectedQueryResult < Struct.new(
2107
+ :output)
2108
+ SENSITIVE = []
2109
+ include Aws::Structure
2110
+ end
2111
+
2112
+ # Contains configurations for protected query results.
2113
+ #
2114
+ # @!attribute [rw] output_configuration
2115
+ # Configuration for protected query results.
2116
+ # @return [Types::ProtectedQueryOutputConfiguration]
2117
+ #
2118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryResultConfiguration AWS API Documentation
2119
+ #
2120
+ class ProtectedQueryResultConfiguration < Struct.new(
2121
+ :output_configuration)
2122
+ SENSITIVE = []
2123
+ include Aws::Structure
2124
+ end
2125
+
2126
+ # Contains output information for protected queries with an S3 output
2127
+ # type.
2128
+ #
2129
+ # @!attribute [rw] location
2130
+ # The S3 location of the result.
2131
+ # @return [String]
2132
+ #
2133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryS3Output AWS API Documentation
2134
+ #
2135
+ class ProtectedQueryS3Output < Struct.new(
2136
+ :location)
2137
+ SENSITIVE = []
2138
+ include Aws::Structure
2139
+ end
2140
+
2141
+ # Contains the configuration to write the query results to S3.
2142
+ #
2143
+ # @!attribute [rw] result_format
2144
+ # Intended file format of the result.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] bucket
2148
+ # The S3 bucket to unload the protected query results.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] key_prefix
2152
+ # The S3 prefix to unload the protected query results.
2153
+ # @return [String]
2154
+ #
2155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryS3OutputConfiguration AWS API Documentation
2156
+ #
2157
+ class ProtectedQueryS3OutputConfiguration < Struct.new(
2158
+ :result_format,
2159
+ :bucket,
2160
+ :key_prefix)
2161
+ SENSITIVE = []
2162
+ include Aws::Structure
2163
+ end
2164
+
2165
+ # The parameters for the SQL type Protected Query.
2166
+ #
2167
+ # @!attribute [rw] query_string
2168
+ # The query string to be submitted.
2169
+ # @return [String]
2170
+ #
2171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuerySQLParameters AWS API Documentation
2172
+ #
2173
+ class ProtectedQuerySQLParameters < Struct.new(
2174
+ :query_string)
2175
+ SENSITIVE = []
2176
+ include Aws::Structure
2177
+ end
2178
+
2179
+ # Contains statistics about the execution of the protected query.
2180
+ #
2181
+ # @!attribute [rw] total_duration_in_millis
2182
+ # The duration of the Protected Query, from creation until query
2183
+ # completion.
2184
+ # @return [Integer]
2185
+ #
2186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryStatistics AWS API Documentation
2187
+ #
2188
+ class ProtectedQueryStatistics < Struct.new(
2189
+ :total_duration_in_millis)
2190
+ SENSITIVE = []
2191
+ include Aws::Structure
2192
+ end
2193
+
2194
+ # The protected query summary for the objects listed by the request.
2195
+ #
2196
+ # @!attribute [rw] id
2197
+ # The unique ID of the protected query.
2198
+ # @return [String]
2199
+ #
2200
+ # @!attribute [rw] membership_id
2201
+ # The unique ID for the membership that initiated the protected query.
2202
+ # @return [String]
2203
+ #
2204
+ # @!attribute [rw] membership_arn
2205
+ # The unique ARN for the membership that initiated the protected
2206
+ # query.
2207
+ # @return [String]
2208
+ #
2209
+ # @!attribute [rw] create_time
2210
+ # The time the protected query was created.
2211
+ # @return [Time]
2212
+ #
2213
+ # @!attribute [rw] status
2214
+ # The status of the protected query. Value values are `SUBMITTED`,
2215
+ # `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`,
2216
+ # `TIMED\_OUT`.
2217
+ # @return [String]
2218
+ #
2219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuerySummary AWS API Documentation
2220
+ #
2221
+ class ProtectedQuerySummary < Struct.new(
2222
+ :id,
2223
+ :membership_id,
2224
+ :membership_arn,
2225
+ :create_time,
2226
+ :status)
2227
+ SENSITIVE = []
2228
+ include Aws::Structure
2229
+ end
2230
+
2231
+ # Request references a resource which does not exist.
2232
+ #
2233
+ # @!attribute [rw] message
2234
+ # @return [String]
2235
+ #
2236
+ # @!attribute [rw] resource_id
2237
+ # The Id of the missing resource.
2238
+ # @return [String]
2239
+ #
2240
+ # @!attribute [rw] resource_type
2241
+ # The type of the missing resource.
2242
+ # @return [String]
2243
+ #
2244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ResourceNotFoundException AWS API Documentation
2245
+ #
2246
+ class ResourceNotFoundException < Struct.new(
2247
+ :message,
2248
+ :resource_id,
2249
+ :resource_type)
2250
+ SENSITIVE = []
2251
+ include Aws::Structure
2252
+ end
2253
+
2254
+ # A schema is a relation within a collaboration.
2255
+ #
2256
+ # @!attribute [rw] columns
2257
+ # The columns for the relation this schema represents.
2258
+ # @return [Array<Types::Column>]
2259
+ #
2260
+ # @!attribute [rw] partition_keys
2261
+ # The partition keys for the data set underlying this schema.
2262
+ # @return [Array<Types::Column>]
2263
+ #
2264
+ # @!attribute [rw] analysis_rule_types
2265
+ # The analysis rule types associated with the schema. Valued values
2266
+ # are LIST and AGGREGATION. Currently, only one entry is present.
2267
+ # @return [Array<String>]
2268
+ #
2269
+ # @!attribute [rw] analysis_method
2270
+ # The analysis method for the schema. The only valid value is
2271
+ # currently DIRECT\_QUERY.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] creator_account_id
2275
+ # The unique account ID for the AWS account that owns the schema.
2276
+ # @return [String]
2277
+ #
2278
+ # @!attribute [rw] name
2279
+ # A name for the schema. The schema relation is referred to by this
2280
+ # name when queried by a protected query.
2281
+ # @return [String]
2282
+ #
2283
+ # @!attribute [rw] collaboration_id
2284
+ # The unique ID for the collaboration that the schema belongs to.
2285
+ # @return [String]
2286
+ #
2287
+ # @!attribute [rw] collaboration_arn
2288
+ # The unique ARN for the collaboration that the schema belongs to.
2289
+ # @return [String]
2290
+ #
2291
+ # @!attribute [rw] description
2292
+ # A description for the schema.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] create_time
2296
+ # The time the schema was created.
2297
+ # @return [Time]
2298
+ #
2299
+ # @!attribute [rw] update_time
2300
+ # The time the schema was last updated.
2301
+ # @return [Time]
2302
+ #
2303
+ # @!attribute [rw] type
2304
+ # The type of schema. The only valid value is currently `TABLE`.
2305
+ # @return [String]
2306
+ #
2307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/Schema AWS API Documentation
2308
+ #
2309
+ class Schema < Struct.new(
2310
+ :columns,
2311
+ :partition_keys,
2312
+ :analysis_rule_types,
2313
+ :analysis_method,
2314
+ :creator_account_id,
2315
+ :name,
2316
+ :collaboration_id,
2317
+ :collaboration_arn,
2318
+ :description,
2319
+ :create_time,
2320
+ :update_time,
2321
+ :type)
2322
+ SENSITIVE = []
2323
+ include Aws::Structure
2324
+ end
2325
+
2326
+ # The schema summary for the objects listed by the request.
2327
+ #
2328
+ # @!attribute [rw] name
2329
+ # The name for the schema object.
2330
+ # @return [String]
2331
+ #
2332
+ # @!attribute [rw] type
2333
+ # The type of schema object. The only valid schema type is currently
2334
+ # `TABLE`.
2335
+ # @return [String]
2336
+ #
2337
+ # @!attribute [rw] creator_account_id
2338
+ # The unique account ID for the AWS account that owns the schema.
2339
+ # @return [String]
2340
+ #
2341
+ # @!attribute [rw] create_time
2342
+ # The time the schema object was created.
2343
+ # @return [Time]
2344
+ #
2345
+ # @!attribute [rw] update_time
2346
+ # The time the schema object was last updated.
2347
+ # @return [Time]
2348
+ #
2349
+ # @!attribute [rw] collaboration_id
2350
+ # The unique ID for the collaboration that the schema belongs to.
2351
+ # @return [String]
2352
+ #
2353
+ # @!attribute [rw] collaboration_arn
2354
+ # The unique ARN for the collaboration that the schema belongs to.
2355
+ # @return [String]
2356
+ #
2357
+ # @!attribute [rw] analysis_rule_types
2358
+ # The types of analysis rules that are associated with this schema
2359
+ # object.
2360
+ # @return [Array<String>]
2361
+ #
2362
+ # @!attribute [rw] analysis_method
2363
+ # The analysis method for the associated schema. The only valid value
2364
+ # is currently `DIRECT\_QUERY`.
2365
+ # @return [String]
2366
+ #
2367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/SchemaSummary AWS API Documentation
2368
+ #
2369
+ class SchemaSummary < Struct.new(
2370
+ :name,
2371
+ :type,
2372
+ :creator_account_id,
2373
+ :create_time,
2374
+ :update_time,
2375
+ :collaboration_id,
2376
+ :collaboration_arn,
2377
+ :analysis_rule_types,
2378
+ :analysis_method)
2379
+ SENSITIVE = []
2380
+ include Aws::Structure
2381
+ end
2382
+
2383
+ # Request denied because service quota has been exceeded.
2384
+ #
2385
+ # @!attribute [rw] message
2386
+ # @return [String]
2387
+ #
2388
+ # @!attribute [rw] quota_name
2389
+ # The name of the quota.
2390
+ # @return [String]
2391
+ #
2392
+ # @!attribute [rw] quota_value
2393
+ # The value of the quota.
2394
+ # @return [Float]
2395
+ #
2396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ServiceQuotaExceededException AWS API Documentation
2397
+ #
2398
+ class ServiceQuotaExceededException < Struct.new(
2399
+ :message,
2400
+ :quota_name,
2401
+ :quota_value)
2402
+ SENSITIVE = []
2403
+ include Aws::Structure
2404
+ end
2405
+
2406
+ # @!attribute [rw] type
2407
+ # The type of the protected query to be started.
2408
+ # @return [String]
2409
+ #
2410
+ # @!attribute [rw] membership_identifier
2411
+ # A unique identifier for the membership to run this query against.
2412
+ # Currently accepts a membership ID.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] sql_parameters
2416
+ # The protected SQL query parameters.
2417
+ # @return [Types::ProtectedQuerySQLParameters]
2418
+ #
2419
+ # @!attribute [rw] result_configuration
2420
+ # The details needed to write the query results.
2421
+ # @return [Types::ProtectedQueryResultConfiguration]
2422
+ #
2423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/StartProtectedQueryInput AWS API Documentation
2424
+ #
2425
+ class StartProtectedQueryInput < Struct.new(
2426
+ :type,
2427
+ :membership_identifier,
2428
+ :sql_parameters,
2429
+ :result_configuration)
2430
+ SENSITIVE = [:sql_parameters]
2431
+ include Aws::Structure
2432
+ end
2433
+
2434
+ # @!attribute [rw] protected_query
2435
+ # The protected query.
2436
+ # @return [Types::ProtectedQuery]
2437
+ #
2438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/StartProtectedQueryOutput AWS API Documentation
2439
+ #
2440
+ class StartProtectedQueryOutput < Struct.new(
2441
+ :protected_query)
2442
+ SENSITIVE = []
2443
+ include Aws::Structure
2444
+ end
2445
+
2446
+ # A pointer to the data set that underlies this table. Currently, this
2447
+ # can only be an AWS Glue table.
2448
+ #
2449
+ # @note TableReference is a union - when making an API calls you must set exactly one of the members.
2450
+ #
2451
+ # @note TableReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TableReference corresponding to the set member.
2452
+ #
2453
+ # @!attribute [rw] glue
2454
+ # If present, a reference to the AWS Glue table referred to by this
2455
+ # table reference.
2456
+ # @return [Types::GlueTableReference]
2457
+ #
2458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/TableReference AWS API Documentation
2459
+ #
2460
+ class TableReference < Struct.new(
2461
+ :glue,
2462
+ :unknown)
2463
+ SENSITIVE = []
2464
+ include Aws::Structure
2465
+ include Aws::Structure::Union
2466
+
2467
+ class Glue < TableReference; end
2468
+ class Unknown < TableReference; end
2469
+ end
2470
+
2471
+ # Request was denied due to request throttling.
2472
+ #
2473
+ # @!attribute [rw] message
2474
+ # @return [String]
2475
+ #
2476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ThrottlingException AWS API Documentation
2477
+ #
2478
+ class ThrottlingException < Struct.new(
2479
+ :message)
2480
+ SENSITIVE = []
2481
+ include Aws::Structure
2482
+ end
2483
+
2484
+ # @!attribute [rw] collaboration_identifier
2485
+ # The identifier for the collaboration.
2486
+ # @return [String]
2487
+ #
2488
+ # @!attribute [rw] name
2489
+ # A human-readable identifier provided by the collaboration owner.
2490
+ # Display names are not unique.
2491
+ # @return [String]
2492
+ #
2493
+ # @!attribute [rw] description
2494
+ # A description of the collaboration.
2495
+ # @return [String]
2496
+ #
2497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateCollaborationInput AWS API Documentation
2498
+ #
2499
+ class UpdateCollaborationInput < Struct.new(
2500
+ :collaboration_identifier,
2501
+ :name,
2502
+ :description)
2503
+ SENSITIVE = []
2504
+ include Aws::Structure
2505
+ end
2506
+
2507
+ # @!attribute [rw] collaboration
2508
+ # The entire collaboration that has been updated.
2509
+ # @return [Types::Collaboration]
2510
+ #
2511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateCollaborationOutput AWS API Documentation
2512
+ #
2513
+ class UpdateCollaborationOutput < Struct.new(
2514
+ :collaboration)
2515
+ SENSITIVE = []
2516
+ include Aws::Structure
2517
+ end
2518
+
2519
+ # @!attribute [rw] configured_table_identifier
2520
+ # The unique identifier for the configured table that the analysis
2521
+ # rule applies to. Currently accepts the configured table ID.
2522
+ # @return [String]
2523
+ #
2524
+ # @!attribute [rw] analysis_rule_type
2525
+ # The analysis rule type to be updated. Configured table analysis
2526
+ # rules are uniquely identified by their configured table identifier
2527
+ # and analysis rule type.
2528
+ # @return [String]
2529
+ #
2530
+ # @!attribute [rw] analysis_rule_policy
2531
+ # The new analysis rule policy for the configured table analysis rule.
2532
+ # @return [Types::ConfiguredTableAnalysisRulePolicy]
2533
+ #
2534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRuleInput AWS API Documentation
2535
+ #
2536
+ class UpdateConfiguredTableAnalysisRuleInput < Struct.new(
2537
+ :configured_table_identifier,
2538
+ :analysis_rule_type,
2539
+ :analysis_rule_policy)
2540
+ SENSITIVE = []
2541
+ include Aws::Structure
2542
+ end
2543
+
2544
+ # @!attribute [rw] analysis_rule
2545
+ # The entire updated analysis rule.
2546
+ # @return [Types::ConfiguredTableAnalysisRule]
2547
+ #
2548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRuleOutput AWS API Documentation
2549
+ #
2550
+ class UpdateConfiguredTableAnalysisRuleOutput < Struct.new(
2551
+ :analysis_rule)
2552
+ SENSITIVE = []
2553
+ include Aws::Structure
2554
+ end
2555
+
2556
+ # @!attribute [rw] configured_table_association_identifier
2557
+ # The unique identifier for the configured table association to
2558
+ # update. Currently accepts the configured table association ID.
2559
+ # @return [String]
2560
+ #
2561
+ # @!attribute [rw] membership_identifier
2562
+ # The unique ID for the membership that the configured table
2563
+ # association belongs to.
2564
+ # @return [String]
2565
+ #
2566
+ # @!attribute [rw] description
2567
+ # A new description for the configured table association.
2568
+ # @return [String]
2569
+ #
2570
+ # @!attribute [rw] role_arn
2571
+ # The service will assume this role to access catalog metadata and
2572
+ # query the table.
2573
+ # @return [String]
2574
+ #
2575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationInput AWS API Documentation
2576
+ #
2577
+ class UpdateConfiguredTableAssociationInput < Struct.new(
2578
+ :configured_table_association_identifier,
2579
+ :membership_identifier,
2580
+ :description,
2581
+ :role_arn)
2582
+ SENSITIVE = []
2583
+ include Aws::Structure
2584
+ end
2585
+
2586
+ # @!attribute [rw] configured_table_association
2587
+ # The entire updated configured table association.
2588
+ # @return [Types::ConfiguredTableAssociation]
2589
+ #
2590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationOutput AWS API Documentation
2591
+ #
2592
+ class UpdateConfiguredTableAssociationOutput < Struct.new(
2593
+ :configured_table_association)
2594
+ SENSITIVE = []
2595
+ include Aws::Structure
2596
+ end
2597
+
2598
+ # @!attribute [rw] configured_table_identifier
2599
+ # The identifier for the configured table to update. Currently accepts
2600
+ # the configured table ID.
2601
+ # @return [String]
2602
+ #
2603
+ # @!attribute [rw] name
2604
+ # A new name for the configured table.
2605
+ # @return [String]
2606
+ #
2607
+ # @!attribute [rw] description
2608
+ # A new description for the configured table.
2609
+ # @return [String]
2610
+ #
2611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableInput AWS API Documentation
2612
+ #
2613
+ class UpdateConfiguredTableInput < Struct.new(
2614
+ :configured_table_identifier,
2615
+ :name,
2616
+ :description)
2617
+ SENSITIVE = []
2618
+ include Aws::Structure
2619
+ end
2620
+
2621
+ # @!attribute [rw] configured_table
2622
+ # The updated configured table.
2623
+ # @return [Types::ConfiguredTable]
2624
+ #
2625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableOutput AWS API Documentation
2626
+ #
2627
+ class UpdateConfiguredTableOutput < Struct.new(
2628
+ :configured_table)
2629
+ SENSITIVE = []
2630
+ include Aws::Structure
2631
+ end
2632
+
2633
+ # @!attribute [rw] membership_identifier
2634
+ # The unique identifier of the membership.
2635
+ # @return [String]
2636
+ #
2637
+ # @!attribute [rw] query_log_status
2638
+ # An indicator as to whether query logging has been enabled or
2639
+ # disabled for the collaboration.
2640
+ # @return [String]
2641
+ #
2642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembershipInput AWS API Documentation
2643
+ #
2644
+ class UpdateMembershipInput < Struct.new(
2645
+ :membership_identifier,
2646
+ :query_log_status)
2647
+ SENSITIVE = []
2648
+ include Aws::Structure
2649
+ end
2650
+
2651
+ # @!attribute [rw] membership
2652
+ # The membership object.
2653
+ # @return [Types::Membership]
2654
+ #
2655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembershipOutput AWS API Documentation
2656
+ #
2657
+ class UpdateMembershipOutput < Struct.new(
2658
+ :membership)
2659
+ SENSITIVE = []
2660
+ include Aws::Structure
2661
+ end
2662
+
2663
+ # @!attribute [rw] membership_identifier
2664
+ # The identifier for a member of a protected query instance.
2665
+ # @return [String]
2666
+ #
2667
+ # @!attribute [rw] protected_query_identifier
2668
+ # The identifier for a protected query instance.
2669
+ # @return [String]
2670
+ #
2671
+ # @!attribute [rw] target_status
2672
+ # The target status of a query. Used to update the execution status of
2673
+ # a currently running query.
2674
+ # @return [String]
2675
+ #
2676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateProtectedQueryInput AWS API Documentation
2677
+ #
2678
+ class UpdateProtectedQueryInput < Struct.new(
2679
+ :membership_identifier,
2680
+ :protected_query_identifier,
2681
+ :target_status)
2682
+ SENSITIVE = []
2683
+ include Aws::Structure
2684
+ end
2685
+
2686
+ # @!attribute [rw] protected_query
2687
+ # The protected query output.
2688
+ # @return [Types::ProtectedQuery]
2689
+ #
2690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateProtectedQueryOutput AWS API Documentation
2691
+ #
2692
+ class UpdateProtectedQueryOutput < Struct.new(
2693
+ :protected_query)
2694
+ SENSITIVE = []
2695
+ include Aws::Structure
2696
+ end
2697
+
2698
+ # The input fails to satisfy the specified constraints.
2699
+ #
2700
+ # @!attribute [rw] message
2701
+ # @return [String]
2702
+ #
2703
+ # @!attribute [rw] reason
2704
+ # A reason code for the exception.
2705
+ # @return [String]
2706
+ #
2707
+ # @!attribute [rw] field_list
2708
+ # Validation errors for specific input parameters.
2709
+ # @return [Array<Types::ValidationExceptionField>]
2710
+ #
2711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ValidationException AWS API Documentation
2712
+ #
2713
+ class ValidationException < Struct.new(
2714
+ :message,
2715
+ :reason,
2716
+ :field_list)
2717
+ SENSITIVE = []
2718
+ include Aws::Structure
2719
+ end
2720
+
2721
+ # Describes validation errors for specific input parameters.
2722
+ #
2723
+ # @!attribute [rw] name
2724
+ # The name of the input parameter.
2725
+ # @return [String]
2726
+ #
2727
+ # @!attribute [rw] message
2728
+ # A message for the input validation error.
2729
+ # @return [String]
2730
+ #
2731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ValidationExceptionField AWS API Documentation
2732
+ #
2733
+ class ValidationExceptionField < Struct.new(
2734
+ :name,
2735
+ :message)
2736
+ SENSITIVE = []
2737
+ include Aws::Structure
2738
+ end
2739
+
2740
+ end
2741
+ end