aws-sdk-cleanrooms 1.40.0 → 1.41.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.
@@ -136,6 +136,15 @@ module Aws::CleanRooms
136
136
  # A policy that describes the associated data usage limitations.
137
137
  # @return [Types::AnalysisRulePolicy]
138
138
  #
139
+ # @!attribute [rw] collaboration_policy
140
+ # Controls on the query specifications that can be run on an
141
+ # associated configured table.
142
+ # @return [Types::ConfiguredTableAssociationAnalysisRulePolicy]
143
+ #
144
+ # @!attribute [rw] consolidated_policy
145
+ # The consolidated policy for the analysis rule.
146
+ # @return [Types::ConsolidatedPolicy]
147
+ #
139
148
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisRule AWS API Documentation
140
149
  #
141
150
  class AnalysisRule < Struct.new(
@@ -144,7 +153,9 @@ module Aws::CleanRooms
144
153
  :name,
145
154
  :create_time,
146
155
  :update_time,
147
- :policy)
156
+ :policy,
157
+ :collaboration_policy,
158
+ :consolidated_policy)
148
159
  SENSITIVE = []
149
160
  include Aws::Structure
150
161
  end
@@ -401,19 +412,46 @@ module Aws::CleanRooms
401
412
  # The query text.
402
413
  # @return [String]
403
414
  #
415
+ # @!attribute [rw] artifacts
416
+ # The artifacts of the analysis source.
417
+ # @return [Types::AnalysisTemplateArtifacts]
418
+ #
404
419
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisSource AWS API Documentation
405
420
  #
406
421
  class AnalysisSource < Struct.new(
407
422
  :text,
423
+ :artifacts,
408
424
  :unknown)
409
- SENSITIVE = []
425
+ SENSITIVE = [:text]
410
426
  include Aws::Structure
411
427
  include Aws::Structure::Union
412
428
 
413
429
  class Text < AnalysisSource; end
430
+ class Artifacts < AnalysisSource; end
414
431
  class Unknown < AnalysisSource; end
415
432
  end
416
433
 
434
+ # The analysis source metadata.
435
+ #
436
+ # @note AnalysisSourceMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AnalysisSourceMetadata corresponding to the set member.
437
+ #
438
+ # @!attribute [rw] artifacts
439
+ # The artifacts of the analysis source metadata.
440
+ # @return [Types::AnalysisTemplateArtifactMetadata]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisSourceMetadata AWS API Documentation
443
+ #
444
+ class AnalysisSourceMetadata < Struct.new(
445
+ :artifacts,
446
+ :unknown)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ include Aws::Structure::Union
450
+
451
+ class Artifacts < AnalysisSourceMetadata; end
452
+ class Unknown < AnalysisSourceMetadata; end
453
+ end
454
+
417
455
  # The analysis template.
418
456
  #
419
457
  # @!attribute [rw] id
@@ -470,6 +508,10 @@ module Aws::CleanRooms
470
508
  # The source of the analysis template.
471
509
  # @return [Types::AnalysisSource]
472
510
  #
511
+ # @!attribute [rw] source_metadata
512
+ # The source metadata for the analysis template.
513
+ # @return [Types::AnalysisSourceMetadata]
514
+ #
473
515
  # @!attribute [rw] analysis_parameters
474
516
  # The parameters of the analysis template.
475
517
  # @return [Array<Types::AnalysisParameter>]
@@ -495,9 +537,68 @@ module Aws::CleanRooms
495
537
  :schema,
496
538
  :format,
497
539
  :source,
540
+ :source_metadata,
498
541
  :analysis_parameters,
499
542
  :validations)
500
- SENSITIVE = [:source, :analysis_parameters]
543
+ SENSITIVE = [:analysis_parameters]
544
+ include Aws::Structure
545
+ end
546
+
547
+ # The analysis template artifact.
548
+ #
549
+ # @!attribute [rw] location
550
+ # The artifact location.
551
+ # @return [Types::S3Location]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisTemplateArtifact AWS API Documentation
554
+ #
555
+ class AnalysisTemplateArtifact < Struct.new(
556
+ :location)
557
+ SENSITIVE = []
558
+ include Aws::Structure
559
+ end
560
+
561
+ # The analysis template artifact metadata.
562
+ #
563
+ # @!attribute [rw] entry_point_hash
564
+ # The hash of the entry point for the analysis template artifact
565
+ # metadata.
566
+ # @return [Types::Hash]
567
+ #
568
+ # @!attribute [rw] additional_artifact_hashes
569
+ # Additional artifact hashes for the analysis template.
570
+ # @return [Array<Types::Hash>]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisTemplateArtifactMetadata AWS API Documentation
573
+ #
574
+ class AnalysisTemplateArtifactMetadata < Struct.new(
575
+ :entry_point_hash,
576
+ :additional_artifact_hashes)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # The analysis template artifacts.
582
+ #
583
+ # @!attribute [rw] entry_point
584
+ # The entry point for the analysis template artifacts.
585
+ # @return [Types::AnalysisTemplateArtifact]
586
+ #
587
+ # @!attribute [rw] additional_artifacts
588
+ # Additional artifacts for the analysis template.
589
+ # @return [Array<Types::AnalysisTemplateArtifact>]
590
+ #
591
+ # @!attribute [rw] role_arn
592
+ # The role ARN for the analysis template artifacts.
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/AnalysisTemplateArtifacts AWS API Documentation
596
+ #
597
+ class AnalysisTemplateArtifacts < Struct.new(
598
+ :entry_point,
599
+ :additional_artifacts,
600
+ :role_arn)
601
+ SENSITIVE = []
501
602
  include Aws::Structure
502
603
  end
503
604
 
@@ -833,6 +934,22 @@ module Aws::CleanRooms
833
934
  include Aws::Structure
834
935
  end
835
936
 
937
+ # Information related to the utilization of resources that have been
938
+ # billed or charged for in a given context, such as a protected job.
939
+ #
940
+ # @!attribute [rw] units
941
+ # The number of Clean Rooms Processing Unit (CRPU) hours that have
942
+ # been billed.
943
+ # @return [Float]
944
+ #
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BilledJobResourceUtilization AWS API Documentation
946
+ #
947
+ class BilledJobResourceUtilization < Struct.new(
948
+ :units)
949
+ SENSITIVE = []
950
+ include Aws::Structure
951
+ end
952
+
836
953
  # Information related to the utilization of resources that have been
837
954
  # billed or charged for in a given context, such as a protected query.
838
955
  #
@@ -906,6 +1023,19 @@ module Aws::CleanRooms
906
1023
  # @!attribute [rw] query_log_status
907
1024
  # An indicator as to whether query logging has been enabled or
908
1025
  # disabled for the collaboration.
1026
+ #
1027
+ # When `ENABLED`, Clean Rooms logs details about queries run within
1028
+ # this collaboration and those logs can be viewed in Amazon CloudWatch
1029
+ # Logs. The default value is `DISABLED`.
1030
+ # @return [String]
1031
+ #
1032
+ # @!attribute [rw] job_log_status
1033
+ # An indicator as to whether job logging has been enabled or disabled
1034
+ # for the collaboration.
1035
+ #
1036
+ # When `ENABLED`, Clean Rooms logs details about jobs run within this
1037
+ # collaboration and those logs can be viewed in Amazon CloudWatch
1038
+ # Logs. The default value is `DISABLED`.
909
1039
  # @return [String]
910
1040
  #
911
1041
  # @!attribute [rw] analytics_engine
@@ -928,6 +1058,7 @@ module Aws::CleanRooms
928
1058
  :membership_arn,
929
1059
  :data_encryption_metadata,
930
1060
  :query_log_status,
1061
+ :job_log_status,
931
1062
  :analytics_engine)
932
1063
  SENSITIVE = []
933
1064
  include Aws::Structure
@@ -987,6 +1118,10 @@ module Aws::CleanRooms
987
1118
  # The source of the analysis template within a collaboration.
988
1119
  # @return [Types::AnalysisSource]
989
1120
  #
1121
+ # @!attribute [rw] source_metadata
1122
+ # The source metadata for the collaboration analysis template.
1123
+ # @return [Types::AnalysisSourceMetadata]
1124
+ #
990
1125
  # @!attribute [rw] analysis_parameters
991
1126
  # The analysis parameters that have been specified in the analysis
992
1127
  # template.
@@ -1011,9 +1146,10 @@ module Aws::CleanRooms
1011
1146
  :schema,
1012
1147
  :format,
1013
1148
  :source,
1149
+ :source_metadata,
1014
1150
  :analysis_parameters,
1015
1151
  :validations)
1016
- SENSITIVE = [:source, :analysis_parameters]
1152
+ SENSITIVE = [:analysis_parameters]
1017
1153
  include Aws::Structure
1018
1154
  end
1019
1155
 
@@ -1864,8 +2000,14 @@ module Aws::CleanRooms
1864
2000
  # @return [Array<String>]
1865
2001
  #
1866
2002
  # @!attribute [rw] analysis_method
1867
- # The analysis method for the configured table. The only valid value
1868
- # is currently `DIRECT\_QUERY`.
2003
+ # The analysis method for the configured table.
2004
+ #
2005
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
2006
+ #
2007
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
2008
+ #
2009
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
2010
+ # directly on this table.
1869
2011
  # @return [String]
1870
2012
  #
1871
2013
  # @!attribute [rw] allowed_columns
@@ -1873,6 +2015,10 @@ module Aws::CleanRooms
1873
2015
  # within collaborations.
1874
2016
  # @return [Array<String>]
1875
2017
  #
2018
+ # @!attribute [rw] selected_analysis_methods
2019
+ # The selected analysis methods for the configured table.
2020
+ # @return [Array<String>]
2021
+ #
1876
2022
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTable AWS API Documentation
1877
2023
  #
1878
2024
  class ConfiguredTable < Struct.new(
@@ -1885,7 +2031,8 @@ module Aws::CleanRooms
1885
2031
  :update_time,
1886
2032
  :analysis_rule_types,
1887
2033
  :analysis_method,
1888
- :allowed_columns)
2034
+ :allowed_columns,
2035
+ :selected_analysis_methods)
1889
2036
  SENSITIVE = []
1890
2037
  include Aws::Structure
1891
2038
  end
@@ -2295,6 +2442,11 @@ module Aws::CleanRooms
2295
2442
  # The unique ARN for the configured table association.
2296
2443
  # @return [String]
2297
2444
  #
2445
+ # @!attribute [rw] analysis_rule_types
2446
+ # The analysis rule types that are associated with the configured
2447
+ # table associations in this summary.
2448
+ # @return [Array<String>]
2449
+ #
2298
2450
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableAssociationSummary AWS API Documentation
2299
2451
  #
2300
2452
  class ConfiguredTableAssociationSummary < Struct.new(
@@ -2305,7 +2457,8 @@ module Aws::CleanRooms
2305
2457
  :create_time,
2306
2458
  :update_time,
2307
2459
  :id,
2308
- :arn)
2460
+ :arn,
2461
+ :analysis_rule_types)
2309
2462
  SENSITIVE = []
2310
2463
  include Aws::Structure
2311
2464
  end
@@ -2337,10 +2490,20 @@ module Aws::CleanRooms
2337
2490
  # @return [Array<String>]
2338
2491
  #
2339
2492
  # @!attribute [rw] analysis_method
2340
- # The analysis method for the configured tables. The only valid value
2341
- # is currently `DIRECT\_QUERY`.
2493
+ # The analysis method for the configured tables.
2494
+ #
2495
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
2496
+ #
2497
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
2498
+ #
2499
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
2500
+ # directly on this table.
2342
2501
  # @return [String]
2343
2502
  #
2503
+ # @!attribute [rw] selected_analysis_methods
2504
+ # The selected analysis methods for the configured table summary.
2505
+ # @return [Array<String>]
2506
+ #
2344
2507
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConfiguredTableSummary AWS API Documentation
2345
2508
  #
2346
2509
  class ConfiguredTableSummary < Struct.new(
@@ -2350,7 +2513,8 @@ module Aws::CleanRooms
2350
2513
  :create_time,
2351
2514
  :update_time,
2352
2515
  :analysis_rule_types,
2353
- :analysis_method)
2516
+ :analysis_method,
2517
+ :selected_analysis_methods)
2354
2518
  SENSITIVE = []
2355
2519
  include Aws::Structure
2356
2520
  end
@@ -2383,6 +2547,208 @@ module Aws::CleanRooms
2383
2547
  include Aws::Structure
2384
2548
  end
2385
2549
 
2550
+ # Controls on the analysis specifications that can be run on a
2551
+ # configured table.
2552
+ #
2553
+ # @note ConsolidatedPolicy is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConsolidatedPolicy corresponding to the set member.
2554
+ #
2555
+ # @!attribute [rw] v1
2556
+ # The consolidated policy version 1.
2557
+ # @return [Types::ConsolidatedPolicyV1]
2558
+ #
2559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConsolidatedPolicy AWS API Documentation
2560
+ #
2561
+ class ConsolidatedPolicy < Struct.new(
2562
+ :v1,
2563
+ :unknown)
2564
+ SENSITIVE = []
2565
+ include Aws::Structure
2566
+ include Aws::Structure::Union
2567
+
2568
+ class V1 < ConsolidatedPolicy; end
2569
+ class Unknown < ConsolidatedPolicy; end
2570
+ end
2571
+
2572
+ # Controls on the analysis specifications that can be run on a
2573
+ # configured table.
2574
+ #
2575
+ # @!attribute [rw] aggregate_columns
2576
+ # Aggregate columns in consolidated policy aggregation.
2577
+ # @return [Array<Types::AggregateColumn>]
2578
+ #
2579
+ # @!attribute [rw] join_columns
2580
+ # The columns to join on.
2581
+ # @return [Array<String>]
2582
+ #
2583
+ # @!attribute [rw] join_required
2584
+ # Join required
2585
+ # @return [String]
2586
+ #
2587
+ # @!attribute [rw] allowed_join_operators
2588
+ # The allowed join operators.
2589
+ # @return [Array<String>]
2590
+ #
2591
+ # @!attribute [rw] dimension_columns
2592
+ # The dimension columns of the consolidated policy aggregation.
2593
+ # @return [Array<String>]
2594
+ #
2595
+ # @!attribute [rw] scalar_functions
2596
+ # The scalar functions.
2597
+ # @return [Array<String>]
2598
+ #
2599
+ # @!attribute [rw] output_constraints
2600
+ # The output constraints of the consolidated policy aggregation.
2601
+ # @return [Array<Types::AggregationConstraint>]
2602
+ #
2603
+ # @!attribute [rw] additional_analyses
2604
+ # Additional analyses for the consolidated policy aggregation.
2605
+ # @return [String]
2606
+ #
2607
+ # @!attribute [rw] allowed_result_receivers
2608
+ # The allowed result receivers.
2609
+ # @return [Array<String>]
2610
+ #
2611
+ # @!attribute [rw] allowed_additional_analyses
2612
+ # The additional analyses allowed by the consolidated policy
2613
+ # aggregation.
2614
+ # @return [Array<String>]
2615
+ #
2616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConsolidatedPolicyAggregation AWS API Documentation
2617
+ #
2618
+ class ConsolidatedPolicyAggregation < Struct.new(
2619
+ :aggregate_columns,
2620
+ :join_columns,
2621
+ :join_required,
2622
+ :allowed_join_operators,
2623
+ :dimension_columns,
2624
+ :scalar_functions,
2625
+ :output_constraints,
2626
+ :additional_analyses,
2627
+ :allowed_result_receivers,
2628
+ :allowed_additional_analyses)
2629
+ SENSITIVE = []
2630
+ include Aws::Structure
2631
+ end
2632
+
2633
+ # Controls on the analysis specifications that can be run on a
2634
+ # configured table.
2635
+ #
2636
+ # @!attribute [rw] allowed_analyses
2637
+ # The allowed analyses.
2638
+ # @return [Array<String>]
2639
+ #
2640
+ # @!attribute [rw] allowed_analysis_providers
2641
+ # The allowed analysis providers.
2642
+ # @return [Array<String>]
2643
+ #
2644
+ # @!attribute [rw] additional_analyses
2645
+ # Additional analyses for the consolidated policy.
2646
+ # @return [String]
2647
+ #
2648
+ # @!attribute [rw] disallowed_output_columns
2649
+ # Disallowed output columns
2650
+ # @return [Array<String>]
2651
+ #
2652
+ # @!attribute [rw] differential_privacy
2653
+ # Specifies the unique identifier for your users.
2654
+ # @return [Types::DifferentialPrivacyConfiguration]
2655
+ #
2656
+ # @!attribute [rw] allowed_result_receivers
2657
+ # The allowed result receivers.
2658
+ # @return [Array<String>]
2659
+ #
2660
+ # @!attribute [rw] allowed_additional_analyses
2661
+ # The additional analyses allowed by the consolidated policy.
2662
+ # @return [Array<String>]
2663
+ #
2664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConsolidatedPolicyCustom AWS API Documentation
2665
+ #
2666
+ class ConsolidatedPolicyCustom < Struct.new(
2667
+ :allowed_analyses,
2668
+ :allowed_analysis_providers,
2669
+ :additional_analyses,
2670
+ :disallowed_output_columns,
2671
+ :differential_privacy,
2672
+ :allowed_result_receivers,
2673
+ :allowed_additional_analyses)
2674
+ SENSITIVE = []
2675
+ include Aws::Structure
2676
+ end
2677
+
2678
+ # Controls on the analysis specifications that can be run on a
2679
+ # configured table.
2680
+ #
2681
+ # @!attribute [rw] join_columns
2682
+ # The columns to join on.
2683
+ # @return [Array<String>]
2684
+ #
2685
+ # @!attribute [rw] allowed_join_operators
2686
+ # The allowed join operators in the consolidated policy list.
2687
+ # @return [Array<String>]
2688
+ #
2689
+ # @!attribute [rw] list_columns
2690
+ # The columns in the consolidated policy list.
2691
+ # @return [Array<String>]
2692
+ #
2693
+ # @!attribute [rw] additional_analyses
2694
+ # Additional analyses for the consolidated policy list.
2695
+ # @return [String]
2696
+ #
2697
+ # @!attribute [rw] allowed_result_receivers
2698
+ # The allowed result receivers.
2699
+ # @return [Array<String>]
2700
+ #
2701
+ # @!attribute [rw] allowed_additional_analyses
2702
+ # The additional analyses allowed by the consolidated policy list.
2703
+ # @return [Array<String>]
2704
+ #
2705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConsolidatedPolicyList AWS API Documentation
2706
+ #
2707
+ class ConsolidatedPolicyList < Struct.new(
2708
+ :join_columns,
2709
+ :allowed_join_operators,
2710
+ :list_columns,
2711
+ :additional_analyses,
2712
+ :allowed_result_receivers,
2713
+ :allowed_additional_analyses)
2714
+ SENSITIVE = []
2715
+ include Aws::Structure
2716
+ end
2717
+
2718
+ # Controls on the analysis specifications that can be run on a
2719
+ # configured table.
2720
+ #
2721
+ # @note ConsolidatedPolicyV1 is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConsolidatedPolicyV1 corresponding to the set member.
2722
+ #
2723
+ # @!attribute [rw] list
2724
+ # The list of consolidated policies.
2725
+ # @return [Types::ConsolidatedPolicyList]
2726
+ #
2727
+ # @!attribute [rw] aggregation
2728
+ # The aggregation setting for the consolidated policy.
2729
+ # @return [Types::ConsolidatedPolicyAggregation]
2730
+ #
2731
+ # @!attribute [rw] custom
2732
+ # Custom policy
2733
+ # @return [Types::ConsolidatedPolicyCustom]
2734
+ #
2735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ConsolidatedPolicyV1 AWS API Documentation
2736
+ #
2737
+ class ConsolidatedPolicyV1 < Struct.new(
2738
+ :list,
2739
+ :aggregation,
2740
+ :custom,
2741
+ :unknown)
2742
+ SENSITIVE = []
2743
+ include Aws::Structure
2744
+ include Aws::Structure::Union
2745
+
2746
+ class List < ConsolidatedPolicyV1; end
2747
+ class Aggregation < ConsolidatedPolicyV1; end
2748
+ class Custom < ConsolidatedPolicyV1; end
2749
+ class Unknown < ConsolidatedPolicyV1; end
2750
+ end
2751
+
2386
2752
  # @!attribute [rw] description
2387
2753
  # The description of the analysis template.
2388
2754
  # @return [String]
@@ -2415,6 +2781,10 @@ module Aws::CleanRooms
2415
2781
  # The parameters of the analysis template.
2416
2782
  # @return [Array<Types::AnalysisParameter>]
2417
2783
  #
2784
+ # @!attribute [rw] schema
2785
+ # A relation within an analysis.
2786
+ # @return [Types::AnalysisSchema]
2787
+ #
2418
2788
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateAnalysisTemplateInput AWS API Documentation
2419
2789
  #
2420
2790
  class CreateAnalysisTemplateInput < Struct.new(
@@ -2424,8 +2794,9 @@ module Aws::CleanRooms
2424
2794
  :format,
2425
2795
  :source,
2426
2796
  :tags,
2427
- :analysis_parameters)
2428
- SENSITIVE = [:source, :analysis_parameters]
2797
+ :analysis_parameters,
2798
+ :schema)
2799
+ SENSITIVE = [:analysis_parameters]
2429
2800
  include Aws::Structure
2430
2801
  end
2431
2802
 
@@ -2461,14 +2832,6 @@ module Aws::CleanRooms
2461
2832
  #
2462
2833
  # @!attribute [rw] creator_ml_member_abilities
2463
2834
  # The ML abilities granted to the collaboration creator.
2464
- #
2465
- # Custom ML modeling is in beta release and is subject to change. For
2466
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
2467
- # Web Services Service Terms][1].
2468
- #
2469
- #
2470
- #
2471
- # [1]: https://aws.amazon.com/service-terms/
2472
2835
  # @return [Types::MLMemberAbilities]
2473
2836
  #
2474
2837
  # @!attribute [rw] creator_display_name
@@ -2483,6 +2846,18 @@ module Aws::CleanRooms
2483
2846
  # @!attribute [rw] query_log_status
2484
2847
  # An indicator as to whether query logging has been enabled or
2485
2848
  # disabled for the collaboration.
2849
+ #
2850
+ # When `ENABLED`, Clean Rooms logs details about queries run within
2851
+ # this collaboration and those logs can be viewed in Amazon CloudWatch
2852
+ # Logs. The default value is `DISABLED`.
2853
+ # @return [String]
2854
+ #
2855
+ # @!attribute [rw] job_log_status
2856
+ # Specifies whether job logs are enabled for this collaboration.
2857
+ #
2858
+ # When `ENABLED`, Clean Rooms logs details about jobs run within this
2859
+ # collaboration; those logs can be viewed in Amazon CloudWatch Logs.
2860
+ # The default value is `DISABLED`.
2486
2861
  # @return [String]
2487
2862
  #
2488
2863
  # @!attribute [rw] tags
@@ -2516,6 +2891,7 @@ module Aws::CleanRooms
2516
2891
  :creator_display_name,
2517
2892
  :data_encryption_metadata,
2518
2893
  :query_log_status,
2894
+ :job_log_status,
2519
2895
  :tags,
2520
2896
  :creator_payment_configuration,
2521
2897
  :analytics_engine)
@@ -2755,10 +3131,21 @@ module Aws::CleanRooms
2755
3131
  # @return [Array<String>]
2756
3132
  #
2757
3133
  # @!attribute [rw] analysis_method
2758
- # The analysis method for the configured tables. The only valid value
2759
- # is currently `DIRECT\_QUERY`.
3134
+ # The analysis method allowed for the configured tables.
3135
+ #
3136
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
3137
+ #
3138
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
3139
+ #
3140
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
3141
+ # directly on this table.
2760
3142
  # @return [String]
2761
3143
  #
3144
+ # @!attribute [rw] selected_analysis_methods
3145
+ # The analysis methods to enable for the configured table. When
3146
+ # configured, you must specify at least two analysis methods.
3147
+ # @return [Array<String>]
3148
+ #
2762
3149
  # @!attribute [rw] tags
2763
3150
  # An optional label that you can assign to a resource when you create
2764
3151
  # it. Each tag consists of a key and an optional value, both of which
@@ -2774,6 +3161,7 @@ module Aws::CleanRooms
2774
3161
  :table_reference,
2775
3162
  :allowed_columns,
2776
3163
  :analysis_method,
3164
+ :selected_analysis_methods,
2777
3165
  :tags)
2778
3166
  SENSITIVE = []
2779
3167
  include Aws::Structure
@@ -2908,6 +3296,19 @@ module Aws::CleanRooms
2908
3296
  # @!attribute [rw] query_log_status
2909
3297
  # An indicator as to whether query logging has been enabled or
2910
3298
  # disabled for the membership.
3299
+ #
3300
+ # When `ENABLED`, Clean Rooms logs details about queries run within
3301
+ # this collaboration and those logs can be viewed in Amazon CloudWatch
3302
+ # Logs. The default value is `DISABLED`.
3303
+ # @return [String]
3304
+ #
3305
+ # @!attribute [rw] job_log_status
3306
+ # An indicator as to whether job logging has been enabled or disabled
3307
+ # for the collaboration.
3308
+ #
3309
+ # When `ENABLED`, Clean Rooms logs details about jobs run within this
3310
+ # collaboration and those logs can be viewed in Amazon CloudWatch
3311
+ # Logs. The default value is `DISABLED`.
2911
3312
  # @return [String]
2912
3313
  #
2913
3314
  # @!attribute [rw] tags
@@ -2922,6 +3323,12 @@ module Aws::CleanRooms
2922
3323
  # member who can receive results.
2923
3324
  # @return [Types::MembershipProtectedQueryResultConfiguration]
2924
3325
  #
3326
+ # @!attribute [rw] default_job_result_configuration
3327
+ # The default job result configuration that determines how job results
3328
+ # are protected and managed within this membership. This configuration
3329
+ # applies to all jobs.
3330
+ # @return [Types::MembershipProtectedJobResultConfiguration]
3331
+ #
2925
3332
  # @!attribute [rw] payment_configuration
2926
3333
  # The payment responsibilities accepted by the collaboration member.
2927
3334
  #
@@ -2938,8 +3345,10 @@ module Aws::CleanRooms
2938
3345
  class CreateMembershipInput < Struct.new(
2939
3346
  :collaboration_identifier,
2940
3347
  :query_log_status,
3348
+ :job_log_status,
2941
3349
  :tags,
2942
3350
  :default_result_configuration,
3351
+ :default_job_result_configuration,
2943
3352
  :payment_configuration)
2944
3353
  SENSITIVE = []
2945
3354
  include Aws::Structure
@@ -4034,16 +4443,45 @@ module Aws::CleanRooms
4034
4443
  end
4035
4444
 
4036
4445
  # @!attribute [rw] membership_identifier
4037
- # The identifier for a membership in a protected query instance.
4446
+ # The identifier for a membership in a protected job instance.
4038
4447
  # @return [String]
4039
4448
  #
4040
- # @!attribute [rw] protected_query_identifier
4041
- # The identifier for a protected query instance.
4449
+ # @!attribute [rw] protected_job_identifier
4450
+ # The identifier for the protected job instance.
4042
4451
  # @return [String]
4043
4452
  #
4044
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedQueryInput AWS API Documentation
4453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedJobInput AWS API Documentation
4045
4454
  #
4046
- class GetProtectedQueryInput < Struct.new(
4455
+ class GetProtectedJobInput < Struct.new(
4456
+ :membership_identifier,
4457
+ :protected_job_identifier)
4458
+ SENSITIVE = []
4459
+ include Aws::Structure
4460
+ end
4461
+
4462
+ # @!attribute [rw] protected_job
4463
+ # The protected job metadata.
4464
+ # @return [Types::ProtectedJob]
4465
+ #
4466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedJobOutput AWS API Documentation
4467
+ #
4468
+ class GetProtectedJobOutput < Struct.new(
4469
+ :protected_job)
4470
+ SENSITIVE = []
4471
+ include Aws::Structure
4472
+ end
4473
+
4474
+ # @!attribute [rw] membership_identifier
4475
+ # The identifier for a membership in a protected query instance.
4476
+ # @return [String]
4477
+ #
4478
+ # @!attribute [rw] protected_query_identifier
4479
+ # The identifier for a protected query instance.
4480
+ # @return [String]
4481
+ #
4482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedQueryInput AWS API Documentation
4483
+ #
4484
+ class GetProtectedQueryInput < Struct.new(
4047
4485
  :membership_identifier,
4048
4486
  :protected_query_identifier)
4049
4487
  SENSITIVE = []
@@ -4149,6 +4587,20 @@ module Aws::CleanRooms
4149
4587
  include Aws::Structure
4150
4588
  end
4151
4589
 
4590
+ # Hash
4591
+ #
4592
+ # @!attribute [rw] sha256
4593
+ # The SHA-256 hash value.
4594
+ # @return [String]
4595
+ #
4596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/Hash AWS API Documentation
4597
+ #
4598
+ class Hash < Struct.new(
4599
+ :sha256)
4600
+ SENSITIVE = []
4601
+ include Aws::Structure
4602
+ end
4603
+
4152
4604
  # The configuration settings for the ID mapping table.
4153
4605
  #
4154
4606
  # @!attribute [rw] allow_use_as_dimension_column
@@ -4614,6 +5066,32 @@ module Aws::CleanRooms
4614
5066
  include Aws::Structure
4615
5067
  end
4616
5068
 
5069
+ # An object representing the collaboration member's payment
5070
+ # responsibilities set by the collaboration creator for query and job
5071
+ # compute costs.
5072
+ #
5073
+ # @!attribute [rw] is_responsible
5074
+ # Indicates whether the collaboration creator has configured the
5075
+ # collaboration member to pay for query and job compute costs (`TRUE`)
5076
+ # or has not configured the collaboration member to pay for query and
5077
+ # job compute costs (`FALSE`).
5078
+ #
5079
+ # Exactly one member can be configured to pay for query and job
5080
+ # compute costs. An error is returned if the collaboration creator
5081
+ # sets a `TRUE` value for more than one member in the collaboration.
5082
+ #
5083
+ # An error is returned if the collaboration creator sets a `FALSE`
5084
+ # value for the member who can run queries and jobs.
5085
+ # @return [Boolean]
5086
+ #
5087
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/JobComputePaymentConfig AWS API Documentation
5088
+ #
5089
+ class JobComputePaymentConfig < Struct.new(
5090
+ :is_responsible)
5091
+ SENSITIVE = []
5092
+ include Aws::Structure
5093
+ end
5094
+
4617
5095
  # @!attribute [rw] membership_identifier
4618
5096
  # The identifier for a membership resource.
4619
5097
  # @return [String]
@@ -5309,6 +5787,53 @@ module Aws::CleanRooms
5309
5787
  include Aws::Structure
5310
5788
  end
5311
5789
 
5790
+ # @!attribute [rw] membership_identifier
5791
+ # The identifier for the membership in the collaboration.
5792
+ # @return [String]
5793
+ #
5794
+ # @!attribute [rw] status
5795
+ # A filter on the status of the protected job.
5796
+ # @return [String]
5797
+ #
5798
+ # @!attribute [rw] next_token
5799
+ # The pagination token that's used to fetch the next set of results.
5800
+ # @return [String]
5801
+ #
5802
+ # @!attribute [rw] max_results
5803
+ # The maximum number of results that are returned for an API request
5804
+ # call. The service chooses a default number if you don't set one.
5805
+ # The service might return a `nextToken` even if the `maxResults`
5806
+ # value has not been met.
5807
+ # @return [Integer]
5808
+ #
5809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedJobsInput AWS API Documentation
5810
+ #
5811
+ class ListProtectedJobsInput < Struct.new(
5812
+ :membership_identifier,
5813
+ :status,
5814
+ :next_token,
5815
+ :max_results)
5816
+ SENSITIVE = []
5817
+ include Aws::Structure
5818
+ end
5819
+
5820
+ # @!attribute [rw] next_token
5821
+ # The pagination token that's used to fetch the next set of results.
5822
+ # @return [String]
5823
+ #
5824
+ # @!attribute [rw] protected_jobs
5825
+ # A list of protected job summaries.
5826
+ # @return [Array<Types::ProtectedJobSummary>]
5827
+ #
5828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedJobsOutput AWS API Documentation
5829
+ #
5830
+ class ListProtectedJobsOutput < Struct.new(
5831
+ :next_token,
5832
+ :protected_jobs)
5833
+ SENSITIVE = []
5834
+ include Aws::Structure
5835
+ end
5836
+
5312
5837
  # @!attribute [rw] membership_identifier
5313
5838
  # The identifier for the membership in the collaboration.
5314
5839
  # @return [String]
@@ -5431,25 +5956,8 @@ module Aws::CleanRooms
5431
5956
 
5432
5957
  # The ML member abilities for a collaboration member.
5433
5958
  #
5434
- # Custom ML modeling is in beta release and is subject to change. For
5435
- # beta terms and conditions, see *Betas and Previews* in the [Amazon Web
5436
- # Services Service Terms][1].
5437
- #
5438
- #
5439
- #
5440
- # [1]: https://aws.amazon.com/service-terms/
5441
- #
5442
5959
  # @!attribute [rw] custom_ml_member_abilities
5443
- # The custom ML member abilities for a collaboration member. The
5444
- # inference feature is not available in the custom ML modeling beta.
5445
- #
5446
- # Custom ML modeling is in beta release and is subject to change. For
5447
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
5448
- # Web Services Service Terms][1].
5449
- #
5450
- #
5451
- #
5452
- # [1]: https://aws.amazon.com/service-terms/
5960
+ # The custom ML member abilities for a collaboration member.
5453
5961
  # @return [Array<String>]
5454
5962
  #
5455
5963
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MLMemberAbilities AWS API Documentation
@@ -5495,14 +6003,6 @@ module Aws::CleanRooms
5495
6003
  #
5496
6004
  # @!attribute [rw] ml_member_abilities
5497
6005
  # The ML abilities granted to the collaboration member.
5498
- #
5499
- # Custom ML modeling is in beta release and is subject to change. For
5500
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
5501
- # Web Services Service Terms][1].
5502
- #
5503
- #
5504
- #
5505
- # [1]: https://aws.amazon.com/service-terms/
5506
6006
  # @return [Types::MLMemberAbilities]
5507
6007
  #
5508
6008
  # @!attribute [rw] display_name
@@ -5551,14 +6051,6 @@ module Aws::CleanRooms
5551
6051
  #
5552
6052
  # @!attribute [rw] ml_abilities
5553
6053
  # Provides a summary of the ML abilities for the collaboration member.
5554
- #
5555
- # Custom ML modeling is in beta release and is subject to change. For
5556
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
5557
- # Web Services Service Terms][1].
5558
- #
5559
- #
5560
- #
5561
- # [1]: https://aws.amazon.com/service-terms/
5562
6054
  # @return [Types::MLMemberAbilities]
5563
6055
  #
5564
6056
  # @!attribute [rw] create_time
@@ -5649,19 +6141,24 @@ module Aws::CleanRooms
5649
6141
  # @!attribute [rw] ml_member_abilities
5650
6142
  # Specifies the ML member abilities that are granted to a
5651
6143
  # collaboration member.
5652
- #
5653
- # Custom ML modeling is in beta release and is subject to change. For
5654
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
5655
- # Web Services Service Terms][1].
5656
- #
5657
- #
5658
- #
5659
- # [1]: https://aws.amazon.com/service-terms/
5660
6144
  # @return [Types::MLMemberAbilities]
5661
6145
  #
5662
6146
  # @!attribute [rw] query_log_status
5663
6147
  # An indicator as to whether query logging has been enabled or
5664
6148
  # disabled for the membership.
6149
+ #
6150
+ # When `ENABLED`, Clean Rooms logs details about queries run within
6151
+ # this collaboration and those logs can be viewed in Amazon CloudWatch
6152
+ # Logs. The default value is `DISABLED`.
6153
+ # @return [String]
6154
+ #
6155
+ # @!attribute [rw] job_log_status
6156
+ # An indicator as to whether job logging has been enabled or disabled
6157
+ # for the collaboration.
6158
+ #
6159
+ # When `ENABLED`, Clean Rooms logs details about jobs run within this
6160
+ # collaboration and those logs can be viewed in Amazon CloudWatch
6161
+ # Logs. The default value is `DISABLED`.
5665
6162
  # @return [String]
5666
6163
  #
5667
6164
  # @!attribute [rw] default_result_configuration
@@ -5669,6 +6166,10 @@ module Aws::CleanRooms
5669
6166
  # member who can receive results.
5670
6167
  # @return [Types::MembershipProtectedQueryResultConfiguration]
5671
6168
  #
6169
+ # @!attribute [rw] default_job_result_configuration
6170
+ # The default job result configuration for the membership.
6171
+ # @return [Types::MembershipProtectedJobResultConfiguration]
6172
+ #
5672
6173
  # @!attribute [rw] payment_configuration
5673
6174
  # The payment responsibilities accepted by the collaboration member.
5674
6175
  # @return [Types::MembershipPaymentConfiguration]
@@ -5689,12 +6190,41 @@ module Aws::CleanRooms
5689
6190
  :member_abilities,
5690
6191
  :ml_member_abilities,
5691
6192
  :query_log_status,
6193
+ :job_log_status,
5692
6194
  :default_result_configuration,
6195
+ :default_job_result_configuration,
5693
6196
  :payment_configuration)
5694
6197
  SENSITIVE = []
5695
6198
  include Aws::Structure
5696
6199
  end
5697
6200
 
6201
+ # An object representing the payment responsibilities accepted by the
6202
+ # collaboration member for query and job compute costs.
6203
+ #
6204
+ # @!attribute [rw] is_responsible
6205
+ # Indicates whether the collaboration member has accepted to pay for
6206
+ # job compute costs (`TRUE`) or has not accepted to pay for query and
6207
+ # job compute costs (`FALSE`).
6208
+ #
6209
+ # There is only one member who pays for queries and jobs.
6210
+ #
6211
+ # An error message is returned for the following reasons:
6212
+ #
6213
+ # * If you set the value to `FALSE` but you are responsible to pay for
6214
+ # query and job compute costs.
6215
+ #
6216
+ # * If you set the value to `TRUE` but you are not responsible to pay
6217
+ # for query and job compute costs.
6218
+ # @return [Boolean]
6219
+ #
6220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MembershipJobComputePaymentConfig AWS API Documentation
6221
+ #
6222
+ class MembershipJobComputePaymentConfig < Struct.new(
6223
+ :is_responsible)
6224
+ SENSITIVE = []
6225
+ include Aws::Structure
6226
+ end
6227
+
5698
6228
  # An object representing the collaboration member's machine learning
5699
6229
  # payment responsibilities set by the collaboration creator.
5700
6230
  #
@@ -5788,11 +6318,61 @@ module Aws::CleanRooms
5788
6318
  # for machine learning costs.
5789
6319
  # @return [Types::MembershipMLPaymentConfig]
5790
6320
  #
6321
+ # @!attribute [rw] job_compute
6322
+ # The payment responsibilities accepted by the collaboration member
6323
+ # for job compute costs.
6324
+ # @return [Types::MembershipJobComputePaymentConfig]
6325
+ #
5791
6326
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MembershipPaymentConfiguration AWS API Documentation
5792
6327
  #
5793
6328
  class MembershipPaymentConfiguration < Struct.new(
5794
6329
  :query_compute,
5795
- :machine_learning)
6330
+ :machine_learning,
6331
+ :job_compute)
6332
+ SENSITIVE = []
6333
+ include Aws::Structure
6334
+ end
6335
+
6336
+ # Contains configurations for protected job results.
6337
+ #
6338
+ # @note MembershipProtectedJobOutputConfiguration is a union - when making an API calls you must set exactly one of the members.
6339
+ #
6340
+ # @note MembershipProtectedJobOutputConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MembershipProtectedJobOutputConfiguration corresponding to the set member.
6341
+ #
6342
+ # @!attribute [rw] s3
6343
+ # Contains the configuration to write the job results to S3.
6344
+ # @return [Types::ProtectedJobS3OutputConfigurationInput]
6345
+ #
6346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MembershipProtectedJobOutputConfiguration AWS API Documentation
6347
+ #
6348
+ class MembershipProtectedJobOutputConfiguration < Struct.new(
6349
+ :s3,
6350
+ :unknown)
6351
+ SENSITIVE = []
6352
+ include Aws::Structure
6353
+ include Aws::Structure::Union
6354
+
6355
+ class S3 < MembershipProtectedJobOutputConfiguration; end
6356
+ class Unknown < MembershipProtectedJobOutputConfiguration; end
6357
+ end
6358
+
6359
+ # Contains configurations for protected job results.
6360
+ #
6361
+ # @!attribute [rw] output_configuration
6362
+ # The output configuration for a protected job result.
6363
+ # @return [Types::MembershipProtectedJobOutputConfiguration]
6364
+ #
6365
+ # @!attribute [rw] role_arn
6366
+ # The unique ARN for an IAM role that is used by Clean Rooms to write
6367
+ # protected job results to the result location, given by the member
6368
+ # who can receive results.
6369
+ # @return [String]
6370
+ #
6371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/MembershipProtectedJobResultConfiguration AWS API Documentation
6372
+ #
6373
+ class MembershipProtectedJobResultConfiguration < Struct.new(
6374
+ :output_configuration,
6375
+ :role_arn)
5796
6376
  SENSITIVE = []
5797
6377
  include Aws::Structure
5798
6378
  end
@@ -5920,14 +6500,6 @@ module Aws::CleanRooms
5920
6500
  #
5921
6501
  # @!attribute [rw] ml_member_abilities
5922
6502
  # Provides a summary of the ML abilities for the collaboration member.
5923
- #
5924
- # Custom ML modeling is in beta release and is subject to change. For
5925
- # beta terms and conditions, see *Betas and Previews* in the [Amazon
5926
- # Web Services Service Terms][1].
5927
- #
5928
- #
5929
- #
5930
- # [1]: https://aws.amazon.com/service-terms/
5931
6503
  # @return [Types::MLMemberAbilities]
5932
6504
  #
5933
6505
  # @!attribute [rw] payment_configuration
@@ -6021,11 +6593,16 @@ module Aws::CleanRooms
6021
6593
  # payment responsibilities set by the collaboration creator.
6022
6594
  # @return [Types::MLPaymentConfig]
6023
6595
  #
6596
+ # @!attribute [rw] job_compute
6597
+ # The compute configuration for the job.
6598
+ # @return [Types::JobComputePaymentConfig]
6599
+ #
6024
6600
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/PaymentConfiguration AWS API Documentation
6025
6601
  #
6026
6602
  class PaymentConfiguration < Struct.new(
6027
6603
  :query_compute,
6028
- :machine_learning)
6604
+ :machine_learning,
6605
+ :job_compute)
6029
6606
  SENSITIVE = []
6030
6607
  include Aws::Structure
6031
6608
  end
@@ -6436,14 +7013,14 @@ module Aws::CleanRooms
6436
7013
  class Unknown < PrivacyImpact; end
6437
7014
  end
6438
7015
 
6439
- # The parameters for an Clean Rooms protected query.
7016
+ # The parameters for an Clean Rooms protected job.
6440
7017
  #
6441
7018
  # @!attribute [rw] id
6442
- # The identifier for a protected query instance.
7019
+ # The identifier for a protected job instance.
6443
7020
  # @return [String]
6444
7021
  #
6445
7022
  # @!attribute [rw] membership_id
6446
- # The identifier for the membership.
7023
+ # he identifier for the membership.
6447
7024
  # @return [String]
6448
7025
  #
6449
7026
  # @!attribute [rw] membership_arn
@@ -6451,111 +7028,149 @@ module Aws::CleanRooms
6451
7028
  # @return [String]
6452
7029
  #
6453
7030
  # @!attribute [rw] create_time
6454
- # The time at which the protected query was created.
7031
+ # The creation time of the protected job.
6455
7032
  # @return [Time]
6456
7033
  #
6457
- # @!attribute [rw] sql_parameters
6458
- # The protected query SQL parameters.
6459
- # @return [Types::ProtectedQuerySQLParameters]
7034
+ # @!attribute [rw] job_parameters
7035
+ # The job parameters for the protected job.
7036
+ # @return [Types::ProtectedJobParameters]
6460
7037
  #
6461
7038
  # @!attribute [rw] status
6462
- # The status of the query.
7039
+ # The status of the protected job.
6463
7040
  # @return [String]
6464
7041
  #
6465
7042
  # @!attribute [rw] result_configuration
6466
- # Contains any details needed to write the query results.
6467
- # @return [Types::ProtectedQueryResultConfiguration]
7043
+ # Contains any details needed to write the job results.
7044
+ # @return [Types::ProtectedJobResultConfigurationOutput]
6468
7045
  #
6469
7046
  # @!attribute [rw] statistics
6470
- # Statistics about protected query execution.
6471
- # @return [Types::ProtectedQueryStatistics]
7047
+ # The statistics of the protected job.
7048
+ # @return [Types::ProtectedJobStatistics]
6472
7049
  #
6473
7050
  # @!attribute [rw] result
6474
- # The result of the protected query.
6475
- # @return [Types::ProtectedQueryResult]
7051
+ # The result of the protected job.
7052
+ # @return [Types::ProtectedJobResult]
6476
7053
  #
6477
7054
  # @!attribute [rw] error
6478
- # An error thrown by the protected query.
6479
- # @return [Types::ProtectedQueryError]
6480
- #
6481
- # @!attribute [rw] differential_privacy
6482
- # The sensitivity parameters of the differential privacy results of
6483
- # the protected query.
6484
- # @return [Types::DifferentialPrivacyParameters]
6485
- #
6486
- # @!attribute [rw] compute_configuration
6487
- # The compute configuration for the protected query.
6488
- # @return [Types::ComputeConfiguration]
7055
+ # The error from the protected job.
7056
+ # @return [Types::ProtectedJobError]
6489
7057
  #
6490
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuery AWS API Documentation
7058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJob AWS API Documentation
6491
7059
  #
6492
- class ProtectedQuery < Struct.new(
7060
+ class ProtectedJob < Struct.new(
6493
7061
  :id,
6494
7062
  :membership_id,
6495
7063
  :membership_arn,
6496
7064
  :create_time,
6497
- :sql_parameters,
7065
+ :job_parameters,
6498
7066
  :status,
6499
7067
  :result_configuration,
6500
7068
  :statistics,
6501
7069
  :result,
6502
- :error,
6503
- :differential_privacy,
6504
- :compute_configuration)
6505
- SENSITIVE = [:sql_parameters]
7070
+ :error)
7071
+ SENSITIVE = []
6506
7072
  include Aws::Structure
6507
7073
  end
6508
7074
 
6509
- # Details of errors thrown by the protected query.
7075
+ # The protected job configuration details.
7076
+ #
7077
+ # @note ProtectedJobConfigurationDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProtectedJobConfigurationDetails corresponding to the set member.
7078
+ #
7079
+ # @!attribute [rw] direct_analysis_configuration_details
7080
+ # The details needed to configure the direct analysis.
7081
+ # @return [Types::ProtectedJobDirectAnalysisConfigurationDetails]
7082
+ #
7083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobConfigurationDetails AWS API Documentation
7084
+ #
7085
+ class ProtectedJobConfigurationDetails < Struct.new(
7086
+ :direct_analysis_configuration_details,
7087
+ :unknown)
7088
+ SENSITIVE = []
7089
+ include Aws::Structure
7090
+ include Aws::Structure::Union
7091
+
7092
+ class DirectAnalysisConfigurationDetails < ProtectedJobConfigurationDetails; end
7093
+ class Unknown < ProtectedJobConfigurationDetails; end
7094
+ end
7095
+
7096
+ # The protected job direct analysis configuration details.
7097
+ #
7098
+ # @!attribute [rw] receiver_account_ids
7099
+ # The receiver account IDs.
7100
+ # @return [Array<String>]
7101
+ #
7102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobDirectAnalysisConfigurationDetails AWS API Documentation
7103
+ #
7104
+ class ProtectedJobDirectAnalysisConfigurationDetails < Struct.new(
7105
+ :receiver_account_ids)
7106
+ SENSITIVE = []
7107
+ include Aws::Structure
7108
+ end
7109
+
7110
+ # The protected job error.
6510
7111
  #
6511
7112
  # @!attribute [rw] message
6512
- # A description of why the query failed.
7113
+ # The message for the protected job error.
6513
7114
  # @return [String]
6514
7115
  #
6515
7116
  # @!attribute [rw] code
6516
- # An error code for the error.
7117
+ # The error code for the protected job.
6517
7118
  # @return [String]
6518
7119
  #
6519
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryError AWS API Documentation
7120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobError AWS API Documentation
6520
7121
  #
6521
- class ProtectedQueryError < Struct.new(
7122
+ class ProtectedJobError < Struct.new(
6522
7123
  :message,
6523
7124
  :code)
6524
7125
  SENSITIVE = []
6525
7126
  include Aws::Structure
6526
7127
  end
6527
7128
 
6528
- # Contains configuration details for the protected query member output.
7129
+ # The protected job member output configuration input.
6529
7130
  #
6530
7131
  # @!attribute [rw] account_id
6531
- # The unique identifier for the account.
7132
+ # The account ID.
6532
7133
  # @return [String]
6533
7134
  #
6534
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryMemberOutputConfiguration AWS API Documentation
7135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationInput AWS API Documentation
6535
7136
  #
6536
- class ProtectedQueryMemberOutputConfiguration < Struct.new(
7137
+ class ProtectedJobMemberOutputConfigurationInput < Struct.new(
6537
7138
  :account_id)
6538
7139
  SENSITIVE = []
6539
7140
  include Aws::Structure
6540
7141
  end
6541
7142
 
6542
- # Contains details about the protected query output.
7143
+ # The protected job member output configuration output.
6543
7144
  #
6544
- # @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.
7145
+ # @!attribute [rw] account_id
7146
+ # The account ID.
7147
+ # @return [String]
7148
+ #
7149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationOutput AWS API Documentation
7150
+ #
7151
+ class ProtectedJobMemberOutputConfigurationOutput < Struct.new(
7152
+ :account_id)
7153
+ SENSITIVE = []
7154
+ include Aws::Structure
7155
+ end
7156
+
7157
+ # Contains details about the protected job output.
7158
+ #
7159
+ # @note ProtectedJobOutput is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProtectedJobOutput corresponding to the set member.
6545
7160
  #
6546
7161
  # @!attribute [rw] s3
6547
- # If present, the output for a protected query with an `S3` output
7162
+ # If present, the output for a protected job with an `S3` output
6548
7163
  # type.
6549
- # @return [Types::ProtectedQueryS3Output]
7164
+ # @return [Types::ProtectedJobS3Output]
6550
7165
  #
6551
7166
  # @!attribute [rw] member_list
6552
7167
  # The list of member Amazon Web Services account(s) that received the
6553
- # results of the query.
6554
- # @return [Array<Types::ProtectedQuerySingleMemberOutput>]
7168
+ # results of the job.
7169
+ # @return [Array<Types::ProtectedJobSingleMemberOutput>]
6555
7170
  #
6556
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryOutput AWS API Documentation
7171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobOutput AWS API Documentation
6557
7172
  #
6558
- class ProtectedQueryOutput < Struct.new(
7173
+ class ProtectedJobOutput < Struct.new(
6559
7174
  :s3,
6560
7175
  :member_list,
6561
7176
  :unknown)
@@ -6563,21 +7178,403 @@ module Aws::CleanRooms
6563
7178
  include Aws::Structure
6564
7179
  include Aws::Structure::Union
6565
7180
 
6566
- class S3 < ProtectedQueryOutput; end
6567
- class MemberList < ProtectedQueryOutput; end
6568
- class Unknown < ProtectedQueryOutput; end
7181
+ class S3 < ProtectedJobOutput; end
7182
+ class MemberList < ProtectedJobOutput; end
7183
+ class Unknown < ProtectedJobOutput; end
6569
7184
  end
6570
7185
 
6571
- # Contains configuration details for protected query output.
7186
+ # The protected job output configuration input.
6572
7187
  #
6573
- # @note ProtectedQueryOutputConfiguration is a union - when making an API calls you must set exactly one of the members.
7188
+ # @note ProtectedJobOutputConfigurationInput is a union - when making an API calls you must set exactly one of the members.
6574
7189
  #
6575
- # @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.
7190
+ # @!attribute [rw] member
7191
+ # The member of the protected job output configuration input.
7192
+ # @return [Types::ProtectedJobMemberOutputConfigurationInput]
6576
7193
  #
6577
- # @!attribute [rw] s3
6578
- # Required configuration for a protected query with an `s3` output
6579
- # type.
6580
- # @return [Types::ProtectedQueryS3OutputConfiguration]
7194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationInput AWS API Documentation
7195
+ #
7196
+ class ProtectedJobOutputConfigurationInput < Struct.new(
7197
+ :member,
7198
+ :unknown)
7199
+ SENSITIVE = []
7200
+ include Aws::Structure
7201
+ include Aws::Structure::Union
7202
+
7203
+ class Member < ProtectedJobOutputConfigurationInput; end
7204
+ class Unknown < ProtectedJobOutputConfigurationInput; end
7205
+ end
7206
+
7207
+ # The protected job output configuration output.
7208
+ #
7209
+ # @note ProtectedJobOutputConfigurationOutput is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProtectedJobOutputConfigurationOutput corresponding to the set member.
7210
+ #
7211
+ # @!attribute [rw] s3
7212
+ # If present, the output for a protected job with an `S3` output
7213
+ # type.
7214
+ # @return [Types::ProtectedJobS3OutputConfigurationOutput]
7215
+ #
7216
+ # @!attribute [rw] member
7217
+ # The member output configuration for a protected job.
7218
+ # @return [Types::ProtectedJobMemberOutputConfigurationOutput]
7219
+ #
7220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationOutput AWS API Documentation
7221
+ #
7222
+ class ProtectedJobOutputConfigurationOutput < Struct.new(
7223
+ :s3,
7224
+ :member,
7225
+ :unknown)
7226
+ SENSITIVE = []
7227
+ include Aws::Structure
7228
+ include Aws::Structure::Union
7229
+
7230
+ class S3 < ProtectedJobOutputConfigurationOutput; end
7231
+ class Member < ProtectedJobOutputConfigurationOutput; end
7232
+ class Unknown < ProtectedJobOutputConfigurationOutput; end
7233
+ end
7234
+
7235
+ # The parameters for the protected job.
7236
+ #
7237
+ # @!attribute [rw] analysis_template_arn
7238
+ # The ARN of the analysis template.
7239
+ # @return [String]
7240
+ #
7241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobParameters AWS API Documentation
7242
+ #
7243
+ class ProtectedJobParameters < Struct.new(
7244
+ :analysis_template_arn)
7245
+ SENSITIVE = []
7246
+ include Aws::Structure
7247
+ end
7248
+
7249
+ # The protected job receiver configuration.
7250
+ #
7251
+ # @!attribute [rw] analysis_type
7252
+ # The analysis type for the protected job receiver configuration.
7253
+ # @return [String]
7254
+ #
7255
+ # @!attribute [rw] configuration_details
7256
+ # The configuration details for the protected job receiver.
7257
+ # @return [Types::ProtectedJobConfigurationDetails]
7258
+ #
7259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobReceiverConfiguration AWS API Documentation
7260
+ #
7261
+ class ProtectedJobReceiverConfiguration < Struct.new(
7262
+ :analysis_type,
7263
+ :configuration_details)
7264
+ SENSITIVE = []
7265
+ include Aws::Structure
7266
+ end
7267
+
7268
+ # Details about the job results.
7269
+ #
7270
+ # @!attribute [rw] output
7271
+ # The output of the protected job.
7272
+ # @return [Types::ProtectedJobOutput]
7273
+ #
7274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobResult AWS API Documentation
7275
+ #
7276
+ class ProtectedJobResult < Struct.new(
7277
+ :output)
7278
+ SENSITIVE = []
7279
+ include Aws::Structure
7280
+ end
7281
+
7282
+ # The protected job result configuration input.
7283
+ #
7284
+ # @!attribute [rw] output_configuration
7285
+ # The output configuration for a protected job result.
7286
+ # @return [Types::ProtectedJobOutputConfigurationInput]
7287
+ #
7288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobResultConfigurationInput AWS API Documentation
7289
+ #
7290
+ class ProtectedJobResultConfigurationInput < Struct.new(
7291
+ :output_configuration)
7292
+ SENSITIVE = []
7293
+ include Aws::Structure
7294
+ end
7295
+
7296
+ # The output configuration for a protected job result.
7297
+ #
7298
+ # @!attribute [rw] output_configuration
7299
+ # The output configuration.
7300
+ # @return [Types::ProtectedJobOutputConfigurationOutput]
7301
+ #
7302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobResultConfigurationOutput AWS API Documentation
7303
+ #
7304
+ class ProtectedJobResultConfigurationOutput < Struct.new(
7305
+ :output_configuration)
7306
+ SENSITIVE = []
7307
+ include Aws::Structure
7308
+ end
7309
+
7310
+ # Contains output information for protected jobs with an S3 output type.
7311
+ #
7312
+ # @!attribute [rw] location
7313
+ # The S3 location for the protected job output.
7314
+ # @return [String]
7315
+ #
7316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobS3Output AWS API Documentation
7317
+ #
7318
+ class ProtectedJobS3Output < Struct.new(
7319
+ :location)
7320
+ SENSITIVE = []
7321
+ include Aws::Structure
7322
+ end
7323
+
7324
+ # Contains input information for protected jobs with an S3 output type.
7325
+ #
7326
+ # @!attribute [rw] bucket
7327
+ # The S3 bucket for job output.
7328
+ # @return [String]
7329
+ #
7330
+ # @!attribute [rw] key_prefix
7331
+ # The S3 prefix to unload the protected job results.
7332
+ # @return [String]
7333
+ #
7334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationInput AWS API Documentation
7335
+ #
7336
+ class ProtectedJobS3OutputConfigurationInput < Struct.new(
7337
+ :bucket,
7338
+ :key_prefix)
7339
+ SENSITIVE = []
7340
+ include Aws::Structure
7341
+ end
7342
+
7343
+ # The output configuration for a protected job's S3 output.
7344
+ #
7345
+ # @!attribute [rw] bucket
7346
+ # The S3 bucket for job output.
7347
+ # @return [String]
7348
+ #
7349
+ # @!attribute [rw] key_prefix
7350
+ # The S3 prefix to unload the protected job results.
7351
+ # @return [String]
7352
+ #
7353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationOutput AWS API Documentation
7354
+ #
7355
+ class ProtectedJobS3OutputConfigurationOutput < Struct.new(
7356
+ :bucket,
7357
+ :key_prefix)
7358
+ SENSITIVE = []
7359
+ include Aws::Structure
7360
+ end
7361
+
7362
+ # Details about the member who received the job result.
7363
+ #
7364
+ # @!attribute [rw] account_id
7365
+ # The Amazon Web Services account ID of the member in the
7366
+ # collaboration who can receive results from analyses.
7367
+ # @return [String]
7368
+ #
7369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobSingleMemberOutput AWS API Documentation
7370
+ #
7371
+ class ProtectedJobSingleMemberOutput < Struct.new(
7372
+ :account_id)
7373
+ SENSITIVE = []
7374
+ include Aws::Structure
7375
+ end
7376
+
7377
+ # Contains statistics about the execution of the protected job.
7378
+ #
7379
+ # @!attribute [rw] total_duration_in_millis
7380
+ # The duration of the protected job, from creation until job
7381
+ # completion, in milliseconds.
7382
+ # @return [Integer]
7383
+ #
7384
+ # @!attribute [rw] billed_resource_utilization
7385
+ # The billed resource utilization for the protected job.
7386
+ # @return [Types::BilledJobResourceUtilization]
7387
+ #
7388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobStatistics AWS API Documentation
7389
+ #
7390
+ class ProtectedJobStatistics < Struct.new(
7391
+ :total_duration_in_millis,
7392
+ :billed_resource_utilization)
7393
+ SENSITIVE = []
7394
+ include Aws::Structure
7395
+ end
7396
+
7397
+ # The protected job summary for the objects listed by the request.
7398
+ #
7399
+ # @!attribute [rw] id
7400
+ # The ID of the protected job.
7401
+ # @return [String]
7402
+ #
7403
+ # @!attribute [rw] membership_id
7404
+ # The unique ID for the membership that initiated the protected job.
7405
+ # @return [String]
7406
+ #
7407
+ # @!attribute [rw] membership_arn
7408
+ # The unique ARN for the membership that initiated the protected job.
7409
+ # @return [String]
7410
+ #
7411
+ # @!attribute [rw] create_time
7412
+ # The time the protected job was created.
7413
+ # @return [Time]
7414
+ #
7415
+ # @!attribute [rw] status
7416
+ # The status of the protected job.
7417
+ # @return [String]
7418
+ #
7419
+ # @!attribute [rw] receiver_configurations
7420
+ # The receiver configurations for the protected job.
7421
+ # @return [Array<Types::ProtectedJobReceiverConfiguration>]
7422
+ #
7423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedJobSummary AWS API Documentation
7424
+ #
7425
+ class ProtectedJobSummary < Struct.new(
7426
+ :id,
7427
+ :membership_id,
7428
+ :membership_arn,
7429
+ :create_time,
7430
+ :status,
7431
+ :receiver_configurations)
7432
+ SENSITIVE = []
7433
+ include Aws::Structure
7434
+ end
7435
+
7436
+ # The parameters for an Clean Rooms protected query.
7437
+ #
7438
+ # @!attribute [rw] id
7439
+ # The identifier for a protected query instance.
7440
+ # @return [String]
7441
+ #
7442
+ # @!attribute [rw] membership_id
7443
+ # The identifier for the membership.
7444
+ # @return [String]
7445
+ #
7446
+ # @!attribute [rw] membership_arn
7447
+ # The ARN of the membership.
7448
+ # @return [String]
7449
+ #
7450
+ # @!attribute [rw] create_time
7451
+ # The time at which the protected query was created.
7452
+ # @return [Time]
7453
+ #
7454
+ # @!attribute [rw] sql_parameters
7455
+ # The protected query SQL parameters.
7456
+ # @return [Types::ProtectedQuerySQLParameters]
7457
+ #
7458
+ # @!attribute [rw] status
7459
+ # The status of the query.
7460
+ # @return [String]
7461
+ #
7462
+ # @!attribute [rw] result_configuration
7463
+ # Contains any details needed to write the query results.
7464
+ # @return [Types::ProtectedQueryResultConfiguration]
7465
+ #
7466
+ # @!attribute [rw] statistics
7467
+ # Statistics about protected query execution.
7468
+ # @return [Types::ProtectedQueryStatistics]
7469
+ #
7470
+ # @!attribute [rw] result
7471
+ # The result of the protected query.
7472
+ # @return [Types::ProtectedQueryResult]
7473
+ #
7474
+ # @!attribute [rw] error
7475
+ # An error thrown by the protected query.
7476
+ # @return [Types::ProtectedQueryError]
7477
+ #
7478
+ # @!attribute [rw] differential_privacy
7479
+ # The sensitivity parameters of the differential privacy results of
7480
+ # the protected query.
7481
+ # @return [Types::DifferentialPrivacyParameters]
7482
+ #
7483
+ # @!attribute [rw] compute_configuration
7484
+ # The compute configuration for the protected query.
7485
+ # @return [Types::ComputeConfiguration]
7486
+ #
7487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQuery AWS API Documentation
7488
+ #
7489
+ class ProtectedQuery < Struct.new(
7490
+ :id,
7491
+ :membership_id,
7492
+ :membership_arn,
7493
+ :create_time,
7494
+ :sql_parameters,
7495
+ :status,
7496
+ :result_configuration,
7497
+ :statistics,
7498
+ :result,
7499
+ :error,
7500
+ :differential_privacy,
7501
+ :compute_configuration)
7502
+ SENSITIVE = [:sql_parameters]
7503
+ include Aws::Structure
7504
+ end
7505
+
7506
+ # Details of errors thrown by the protected query.
7507
+ #
7508
+ # @!attribute [rw] message
7509
+ # A description of why the query failed.
7510
+ # @return [String]
7511
+ #
7512
+ # @!attribute [rw] code
7513
+ # An error code for the error.
7514
+ # @return [String]
7515
+ #
7516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryError AWS API Documentation
7517
+ #
7518
+ class ProtectedQueryError < Struct.new(
7519
+ :message,
7520
+ :code)
7521
+ SENSITIVE = []
7522
+ include Aws::Structure
7523
+ end
7524
+
7525
+ # Contains configuration details for the protected query member output.
7526
+ #
7527
+ # @!attribute [rw] account_id
7528
+ # The unique identifier for the account.
7529
+ # @return [String]
7530
+ #
7531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryMemberOutputConfiguration AWS API Documentation
7532
+ #
7533
+ class ProtectedQueryMemberOutputConfiguration < Struct.new(
7534
+ :account_id)
7535
+ SENSITIVE = []
7536
+ include Aws::Structure
7537
+ end
7538
+
7539
+ # Contains details about the protected query output.
7540
+ #
7541
+ # @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.
7542
+ #
7543
+ # @!attribute [rw] s3
7544
+ # If present, the output for a protected query with an `S3` output
7545
+ # type.
7546
+ # @return [Types::ProtectedQueryS3Output]
7547
+ #
7548
+ # @!attribute [rw] member_list
7549
+ # The list of member Amazon Web Services account(s) that received the
7550
+ # results of the query.
7551
+ # @return [Array<Types::ProtectedQuerySingleMemberOutput>]
7552
+ #
7553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ProtectedQueryOutput AWS API Documentation
7554
+ #
7555
+ class ProtectedQueryOutput < Struct.new(
7556
+ :s3,
7557
+ :member_list,
7558
+ :unknown)
7559
+ SENSITIVE = []
7560
+ include Aws::Structure
7561
+ include Aws::Structure::Union
7562
+
7563
+ class S3 < ProtectedQueryOutput; end
7564
+ class MemberList < ProtectedQueryOutput; end
7565
+ class Unknown < ProtectedQueryOutput; end
7566
+ end
7567
+
7568
+ # Contains configuration details for protected query output.
7569
+ #
7570
+ # @note ProtectedQueryOutputConfiguration is a union - when making an API calls you must set exactly one of the members.
7571
+ #
7572
+ # @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.
7573
+ #
7574
+ # @!attribute [rw] s3
7575
+ # Required configuration for a protected query with an `s3` output
7576
+ # type.
7577
+ # @return [Types::ProtectedQueryS3OutputConfiguration]
6581
7578
  #
6582
7579
  # @!attribute [rw] member
6583
7580
  # Required configuration for a protected query with a `member` output
@@ -6717,7 +7714,7 @@ module Aws::CleanRooms
6717
7714
  #
6718
7715
  # @!attribute [rw] total_duration_in_millis
6719
7716
  # The duration of the protected query, from creation until query
6720
- # completion.
7717
+ # completion, in milliseconds.
6721
7718
  # @return [Integer]
6722
7719
  #
6723
7720
  # @!attribute [rw] billed_resource_utilization
@@ -6882,6 +7879,25 @@ module Aws::CleanRooms
6882
7879
  include Aws::Structure
6883
7880
  end
6884
7881
 
7882
+ # The S3 location.
7883
+ #
7884
+ # @!attribute [rw] bucket
7885
+ # The bucket name.
7886
+ # @return [String]
7887
+ #
7888
+ # @!attribute [rw] key
7889
+ # The object key.
7890
+ # @return [String]
7891
+ #
7892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/S3Location AWS API Documentation
7893
+ #
7894
+ class S3Location < Struct.new(
7895
+ :bucket,
7896
+ :key)
7897
+ SENSITIVE = []
7898
+ include Aws::Structure
7899
+ end
7900
+
6885
7901
  # A schema is a relation within a collaboration.
6886
7902
  #
6887
7903
  # @!attribute [rw] columns
@@ -6898,10 +7914,20 @@ module Aws::CleanRooms
6898
7914
  # @return [Array<String>]
6899
7915
  #
6900
7916
  # @!attribute [rw] analysis_method
6901
- # The analysis method for the schema. The only valid value is
6902
- # currently `DIRECT_QUERY`.
7917
+ # The analysis method for the schema.
7918
+ #
7919
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
7920
+ #
7921
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
7922
+ #
7923
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
7924
+ # directly on this table.
6903
7925
  # @return [String]
6904
7926
  #
7927
+ # @!attribute [rw] selected_analysis_methods
7928
+ # The selected analysis methods for the schema.
7929
+ # @return [Array<String>]
7930
+ #
6905
7931
  # @!attribute [rw] creator_account_id
6906
7932
  # The unique account ID for the Amazon Web Services account that owns
6907
7933
  # the schema.
@@ -6953,6 +7979,7 @@ module Aws::CleanRooms
6953
7979
  :partition_keys,
6954
7980
  :analysis_rule_types,
6955
7981
  :analysis_method,
7982
+ :selected_analysis_methods,
6956
7983
  :creator_account_id,
6957
7984
  :name,
6958
7985
  :collaboration_id,
@@ -7088,10 +8115,20 @@ module Aws::CleanRooms
7088
8115
  # @return [Array<String>]
7089
8116
  #
7090
8117
  # @!attribute [rw] analysis_method
7091
- # The analysis method for the associated schema. The only valid value
7092
- # is currently `DIRECT\_QUERY`.
8118
+ # The analysis method for the associated schema.
8119
+ #
8120
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
8121
+ #
8122
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
8123
+ #
8124
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
8125
+ # directly on this table.
7093
8126
  # @return [String]
7094
8127
  #
8128
+ # @!attribute [rw] selected_analysis_methods
8129
+ # The selected analysis methods for the schema.
8130
+ # @return [Array<String>]
8131
+ #
7095
8132
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/SchemaSummary AWS API Documentation
7096
8133
  #
7097
8134
  class SchemaSummary < Struct.new(
@@ -7103,7 +8140,8 @@ module Aws::CleanRooms
7103
8140
  :collaboration_id,
7104
8141
  :collaboration_arn,
7105
8142
  :analysis_rule_types,
7106
- :analysis_method)
8143
+ :analysis_method,
8144
+ :selected_analysis_methods)
7107
8145
  SENSITIVE = []
7108
8146
  include Aws::Structure
7109
8147
  end
@@ -7238,6 +8276,46 @@ module Aws::CleanRooms
7238
8276
  include Aws::Structure
7239
8277
  end
7240
8278
 
8279
+ # @!attribute [rw] type
8280
+ # The type of protected job to start.
8281
+ # @return [String]
8282
+ #
8283
+ # @!attribute [rw] membership_identifier
8284
+ # A unique identifier for the membership to run this job against.
8285
+ # Currently accepts a membership ID.
8286
+ # @return [String]
8287
+ #
8288
+ # @!attribute [rw] job_parameters
8289
+ # The job parameters.
8290
+ # @return [Types::ProtectedJobParameters]
8291
+ #
8292
+ # @!attribute [rw] result_configuration
8293
+ # The details needed to write the job results.
8294
+ # @return [Types::ProtectedJobResultConfigurationInput]
8295
+ #
8296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/StartProtectedJobInput AWS API Documentation
8297
+ #
8298
+ class StartProtectedJobInput < Struct.new(
8299
+ :type,
8300
+ :membership_identifier,
8301
+ :job_parameters,
8302
+ :result_configuration)
8303
+ SENSITIVE = []
8304
+ include Aws::Structure
8305
+ end
8306
+
8307
+ # @!attribute [rw] protected_job
8308
+ # The protected job.
8309
+ # @return [Types::ProtectedJob]
8310
+ #
8311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/StartProtectedJobOutput AWS API Documentation
8312
+ #
8313
+ class StartProtectedJobOutput < Struct.new(
8314
+ :protected_job)
8315
+ SENSITIVE = []
8316
+ include Aws::Structure
8317
+ end
8318
+
7241
8319
  # @!attribute [rw] type
7242
8320
  # The type of the protected query to be started.
7243
8321
  # @return [String]
@@ -7624,12 +8702,29 @@ module Aws::CleanRooms
7624
8702
  # A new description for the configured table.
7625
8703
  # @return [String]
7626
8704
  #
8705
+ # @!attribute [rw] analysis_method
8706
+ # The analysis method for the configured table.
8707
+ #
8708
+ # `DIRECT_QUERY` allows SQL queries to be run directly on this table.
8709
+ #
8710
+ # `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
8711
+ #
8712
+ # `MULTIPLE` allows both SQL queries and PySpark jobs to be run
8713
+ # directly on this table.
8714
+ # @return [String]
8715
+ #
8716
+ # @!attribute [rw] selected_analysis_methods
8717
+ # The selected analysis methods for the table configuration update.
8718
+ # @return [Array<String>]
8719
+ #
7627
8720
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTableInput AWS API Documentation
7628
8721
  #
7629
8722
  class UpdateConfiguredTableInput < Struct.new(
7630
8723
  :configured_table_identifier,
7631
8724
  :name,
7632
- :description)
8725
+ :description,
8726
+ :analysis_method,
8727
+ :selected_analysis_methods)
7633
8728
  SENSITIVE = []
7634
8729
  include Aws::Structure
7635
8730
  end
@@ -7740,6 +8835,19 @@ module Aws::CleanRooms
7740
8835
  # @!attribute [rw] query_log_status
7741
8836
  # An indicator as to whether query logging has been enabled or
7742
8837
  # disabled for the membership.
8838
+ #
8839
+ # When `ENABLED`, Clean Rooms logs details about queries run within
8840
+ # this collaboration and those logs can be viewed in Amazon CloudWatch
8841
+ # Logs. The default value is `DISABLED`.
8842
+ # @return [String]
8843
+ #
8844
+ # @!attribute [rw] job_log_status
8845
+ # An indicator as to whether job logging has been enabled or disabled
8846
+ # for the collaboration.
8847
+ #
8848
+ # When `ENABLED`, Clean Rooms logs details about jobs run within this
8849
+ # collaboration and those logs can be viewed in Amazon CloudWatch
8850
+ # Logs. The default value is `DISABLED`.
7743
8851
  # @return [String]
7744
8852
  #
7745
8853
  # @!attribute [rw] default_result_configuration
@@ -7747,12 +8855,18 @@ module Aws::CleanRooms
7747
8855
  # member who can receive results.
7748
8856
  # @return [Types::MembershipProtectedQueryResultConfiguration]
7749
8857
  #
8858
+ # @!attribute [rw] default_job_result_configuration
8859
+ # The default job result configuration.
8860
+ # @return [Types::MembershipProtectedJobResultConfiguration]
8861
+ #
7750
8862
  # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembershipInput AWS API Documentation
7751
8863
  #
7752
8864
  class UpdateMembershipInput < Struct.new(
7753
8865
  :membership_identifier,
7754
8866
  :query_log_status,
7755
- :default_result_configuration)
8867
+ :job_log_status,
8868
+ :default_result_configuration,
8869
+ :default_job_result_configuration)
7756
8870
  SENSITIVE = []
7757
8871
  include Aws::Structure
7758
8872
  end
@@ -7812,6 +8926,41 @@ module Aws::CleanRooms
7812
8926
  include Aws::Structure
7813
8927
  end
7814
8928
 
8929
+ # @!attribute [rw] membership_identifier
8930
+ # The identifier for a member of a protected job instance.
8931
+ # @return [String]
8932
+ #
8933
+ # @!attribute [rw] protected_job_identifier
8934
+ # The identifier of the protected job to update.
8935
+ # @return [String]
8936
+ #
8937
+ # @!attribute [rw] target_status
8938
+ # The target status of a protected job. Used to update the execution
8939
+ # status of a currently running job.
8940
+ # @return [String]
8941
+ #
8942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateProtectedJobInput AWS API Documentation
8943
+ #
8944
+ class UpdateProtectedJobInput < Struct.new(
8945
+ :membership_identifier,
8946
+ :protected_job_identifier,
8947
+ :target_status)
8948
+ SENSITIVE = []
8949
+ include Aws::Structure
8950
+ end
8951
+
8952
+ # @!attribute [rw] protected_job
8953
+ # The protected job output.
8954
+ # @return [Types::ProtectedJob]
8955
+ #
8956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateProtectedJobOutput AWS API Documentation
8957
+ #
8958
+ class UpdateProtectedJobOutput < Struct.new(
8959
+ :protected_job)
8960
+ SENSITIVE = []
8961
+ include Aws::Structure
8962
+ end
8963
+
7815
8964
  # @!attribute [rw] membership_identifier
7816
8965
  # The identifier for a member of a protected query instance.
7817
8966
  # @return [String]