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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanrooms/client.rb +562 -32
- data/lib/aws-sdk-cleanrooms/client_api.rb +394 -1
- data/lib/aws-sdk-cleanrooms/types.rb +1296 -147
- data/lib/aws-sdk-cleanrooms.rb +1 -1
- data/sig/client.rbs +118 -7
- data/sig/types.rbs +377 -17
- metadata +2 -2
@@ -507,8 +507,17 @@ module Aws::CleanRooms
|
|
507
507
|
# resp.collaboration_analysis_templates[0].update_time #=> Time
|
508
508
|
# resp.collaboration_analysis_templates[0].schema.referenced_tables #=> Array
|
509
509
|
# resp.collaboration_analysis_templates[0].schema.referenced_tables[0] #=> String
|
510
|
-
# resp.collaboration_analysis_templates[0].format #=> String, one of "SQL"
|
510
|
+
# resp.collaboration_analysis_templates[0].format #=> String, one of "SQL", "PYSPARK_1_0"
|
511
511
|
# resp.collaboration_analysis_templates[0].source.text #=> String
|
512
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.entry_point.location.bucket #=> String
|
513
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.entry_point.location.key #=> String
|
514
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts #=> Array
|
515
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts[0].location.bucket #=> String
|
516
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.additional_artifacts[0].location.key #=> String
|
517
|
+
# resp.collaboration_analysis_templates[0].source.artifacts.role_arn #=> String
|
518
|
+
# resp.collaboration_analysis_templates[0].source_metadata.artifacts.entry_point_hash.sha256 #=> String
|
519
|
+
# resp.collaboration_analysis_templates[0].source_metadata.artifacts.additional_artifact_hashes #=> Array
|
520
|
+
# resp.collaboration_analysis_templates[0].source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
|
512
521
|
# resp.collaboration_analysis_templates[0].analysis_parameters #=> Array
|
513
522
|
# resp.collaboration_analysis_templates[0].analysis_parameters[0].name #=> String
|
514
523
|
# resp.collaboration_analysis_templates[0].analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
|
@@ -564,7 +573,9 @@ module Aws::CleanRooms
|
|
564
573
|
# resp.schemas[0].partition_keys[0].type #=> String
|
565
574
|
# resp.schemas[0].analysis_rule_types #=> Array
|
566
575
|
# resp.schemas[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
|
567
|
-
# resp.schemas[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
576
|
+
# resp.schemas[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
577
|
+
# resp.schemas[0].selected_analysis_methods #=> Array
|
578
|
+
# resp.schemas[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
568
579
|
# resp.schemas[0].creator_account_id #=> String
|
569
580
|
# resp.schemas[0].name #=> String
|
570
581
|
# resp.schemas[0].collaboration_id #=> String
|
@@ -674,6 +685,64 @@ module Aws::CleanRooms
|
|
674
685
|
# resp.analysis_rules[0].policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns[0] #=> String
|
675
686
|
# resp.analysis_rules[0].policy.v1.id_mapping_table.dimension_columns #=> Array
|
676
687
|
# resp.analysis_rules[0].policy.v1.id_mapping_table.dimension_columns[0] #=> String
|
688
|
+
# resp.analysis_rules[0].collaboration_policy.v1.list.allowed_result_receivers #=> Array
|
689
|
+
# resp.analysis_rules[0].collaboration_policy.v1.list.allowed_result_receivers[0] #=> String
|
690
|
+
# resp.analysis_rules[0].collaboration_policy.v1.list.allowed_additional_analyses #=> Array
|
691
|
+
# resp.analysis_rules[0].collaboration_policy.v1.list.allowed_additional_analyses[0] #=> String
|
692
|
+
# resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_result_receivers #=> Array
|
693
|
+
# resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_result_receivers[0] #=> String
|
694
|
+
# resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_additional_analyses #=> Array
|
695
|
+
# resp.analysis_rules[0].collaboration_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
|
696
|
+
# resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_result_receivers #=> Array
|
697
|
+
# resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_result_receivers[0] #=> String
|
698
|
+
# resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_additional_analyses #=> Array
|
699
|
+
# resp.analysis_rules[0].collaboration_policy.v1.custom.allowed_additional_analyses[0] #=> String
|
700
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.join_columns #=> Array
|
701
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.join_columns[0] #=> String
|
702
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_join_operators #=> Array
|
703
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
|
704
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.list_columns #=> Array
|
705
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.list_columns[0] #=> String
|
706
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
707
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_result_receivers #=> Array
|
708
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_result_receivers[0] #=> String
|
709
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_additional_analyses #=> Array
|
710
|
+
# resp.analysis_rules[0].consolidated_policy.v1.list.allowed_additional_analyses[0] #=> String
|
711
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns #=> Array
|
712
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
|
713
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
|
714
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
|
715
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_columns #=> Array
|
716
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_columns[0] #=> String
|
717
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
|
718
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_join_operators #=> Array
|
719
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
|
720
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.dimension_columns #=> Array
|
721
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.dimension_columns[0] #=> String
|
722
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.scalar_functions #=> Array
|
723
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.scalar_functions[0] #=> String, one of "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
|
724
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints #=> Array
|
725
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].column_name #=> String
|
726
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
727
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
728
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
729
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_result_receivers #=> Array
|
730
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_result_receivers[0] #=> String
|
731
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_additional_analyses #=> Array
|
732
|
+
# resp.analysis_rules[0].consolidated_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
|
733
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analyses #=> Array
|
734
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analyses[0] #=> String
|
735
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analysis_providers #=> Array
|
736
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_analysis_providers[0] #=> String
|
737
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
738
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.disallowed_output_columns #=> Array
|
739
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.disallowed_output_columns[0] #=> String
|
740
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.differential_privacy.columns #=> Array
|
741
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.differential_privacy.columns[0].name #=> String
|
742
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_result_receivers #=> Array
|
743
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_result_receivers[0] #=> String
|
744
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_additional_analyses #=> Array
|
745
|
+
# resp.analysis_rules[0].consolidated_policy.v1.custom.allowed_additional_analyses[0] #=> String
|
677
746
|
# resp.errors #=> Array
|
678
747
|
# resp.errors[0].name #=> String
|
679
748
|
# resp.errors[0].type #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
|
@@ -716,6 +785,9 @@ module Aws::CleanRooms
|
|
716
785
|
# @option params [Array<Types::AnalysisParameter>] :analysis_parameters
|
717
786
|
# The parameters of the analysis template.
|
718
787
|
#
|
788
|
+
# @option params [Types::AnalysisSchema] :schema
|
789
|
+
# A relation within an analysis.
|
790
|
+
#
|
719
791
|
# @return [Types::CreateAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
720
792
|
#
|
721
793
|
# * {Types::CreateAnalysisTemplateOutput#analysis_template #analysis_template} => Types::AnalysisTemplate
|
@@ -726,9 +798,26 @@ module Aws::CleanRooms
|
|
726
798
|
# description: "ResourceDescription",
|
727
799
|
# membership_identifier: "MembershipIdentifier", # required
|
728
800
|
# name: "TableAlias", # required
|
729
|
-
# format: "SQL", # required, accepts SQL
|
801
|
+
# format: "SQL", # required, accepts SQL, PYSPARK_1_0
|
730
802
|
# source: { # required
|
731
803
|
# text: "AnalysisTemplateText",
|
804
|
+
# artifacts: {
|
805
|
+
# entry_point: { # required
|
806
|
+
# location: { # required
|
807
|
+
# bucket: "S3LocationBucketString", # required
|
808
|
+
# key: "S3LocationKeyString", # required
|
809
|
+
# },
|
810
|
+
# },
|
811
|
+
# additional_artifacts: [
|
812
|
+
# {
|
813
|
+
# location: { # required
|
814
|
+
# bucket: "S3LocationBucketString", # required
|
815
|
+
# key: "S3LocationKeyString", # required
|
816
|
+
# },
|
817
|
+
# },
|
818
|
+
# ],
|
819
|
+
# role_arn: "RoleArn", # required
|
820
|
+
# },
|
732
821
|
# },
|
733
822
|
# tags: {
|
734
823
|
# "TagKey" => "TagValue",
|
@@ -740,6 +829,9 @@ module Aws::CleanRooms
|
|
740
829
|
# default_value: "ParameterValue",
|
741
830
|
# },
|
742
831
|
# ],
|
832
|
+
# schema: {
|
833
|
+
# referenced_tables: ["TableAlias"],
|
834
|
+
# },
|
743
835
|
# })
|
744
836
|
#
|
745
837
|
# @example Response structure
|
@@ -756,8 +848,17 @@ module Aws::CleanRooms
|
|
756
848
|
# resp.analysis_template.update_time #=> Time
|
757
849
|
# resp.analysis_template.schema.referenced_tables #=> Array
|
758
850
|
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
759
|
-
# resp.analysis_template.format #=> String, one of "SQL"
|
851
|
+
# resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
|
760
852
|
# resp.analysis_template.source.text #=> String
|
853
|
+
# resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
|
854
|
+
# resp.analysis_template.source.artifacts.entry_point.location.key #=> String
|
855
|
+
# resp.analysis_template.source.artifacts.additional_artifacts #=> Array
|
856
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
|
857
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
|
858
|
+
# resp.analysis_template.source.artifacts.role_arn #=> String
|
859
|
+
# resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
|
860
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
|
861
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
|
761
862
|
# resp.analysis_template.analysis_parameters #=> Array
|
762
863
|
# resp.analysis_template.analysis_parameters[0].name #=> String
|
763
864
|
# resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
|
@@ -796,14 +897,6 @@ module Aws::CleanRooms
|
|
796
897
|
# @option params [Types::MLMemberAbilities] :creator_ml_member_abilities
|
797
898
|
# The ML abilities granted to the collaboration creator.
|
798
899
|
#
|
799
|
-
# Custom ML modeling is in beta release and is subject to change. For
|
800
|
-
# beta terms and conditions, see *Betas and Previews* in the [Amazon Web
|
801
|
-
# Services Service Terms][1].
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
# [1]: https://aws.amazon.com/service-terms/
|
806
|
-
#
|
807
900
|
# @option params [required, String] :creator_display_name
|
808
901
|
# The display name of the collaboration creator.
|
809
902
|
#
|
@@ -815,6 +908,17 @@ module Aws::CleanRooms
|
|
815
908
|
# An indicator as to whether query logging has been enabled or disabled
|
816
909
|
# for the collaboration.
|
817
910
|
#
|
911
|
+
# When `ENABLED`, Clean Rooms logs details about queries run within this
|
912
|
+
# collaboration and those logs can be viewed in Amazon CloudWatch Logs.
|
913
|
+
# The default value is `DISABLED`.
|
914
|
+
#
|
915
|
+
# @option params [String] :job_log_status
|
916
|
+
# Specifies whether job logs are enabled for this collaboration.
|
917
|
+
#
|
918
|
+
# When `ENABLED`, Clean Rooms logs details about jobs run within this
|
919
|
+
# collaboration; those logs can be viewed in Amazon CloudWatch Logs. The
|
920
|
+
# default value is `DISABLED`.
|
921
|
+
#
|
818
922
|
# @option params [Hash<String,String>] :tags
|
819
923
|
# An optional label that you can assign to a resource when you create
|
820
924
|
# it. Each tag consists of a key and an optional value, both of which
|
@@ -842,7 +946,7 @@ module Aws::CleanRooms
|
|
842
946
|
# members: [ # required
|
843
947
|
# {
|
844
948
|
# account_id: "AccountId", # required
|
845
|
-
# member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS
|
949
|
+
# member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS, CAN_RUN_JOB
|
846
950
|
# ml_member_abilities: {
|
847
951
|
# custom_ml_member_abilities: ["CAN_RECEIVE_MODEL_OUTPUT"], # required, accepts CAN_RECEIVE_MODEL_OUTPUT, CAN_RECEIVE_INFERENCE_OUTPUT
|
848
952
|
# },
|
@@ -859,12 +963,15 @@ module Aws::CleanRooms
|
|
859
963
|
# is_responsible: false, # required
|
860
964
|
# },
|
861
965
|
# },
|
966
|
+
# job_compute: {
|
967
|
+
# is_responsible: false, # required
|
968
|
+
# },
|
862
969
|
# },
|
863
970
|
# },
|
864
971
|
# ],
|
865
972
|
# name: "CollaborationName", # required
|
866
973
|
# description: "CollaborationDescription", # required
|
867
|
-
# creator_member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS
|
974
|
+
# creator_member_abilities: ["CAN_QUERY"], # required, accepts CAN_QUERY, CAN_RECEIVE_RESULTS, CAN_RUN_JOB
|
868
975
|
# creator_ml_member_abilities: {
|
869
976
|
# custom_ml_member_abilities: ["CAN_RECEIVE_MODEL_OUTPUT"], # required, accepts CAN_RECEIVE_MODEL_OUTPUT, CAN_RECEIVE_INFERENCE_OUTPUT
|
870
977
|
# },
|
@@ -876,6 +983,7 @@ module Aws::CleanRooms
|
|
876
983
|
# preserve_nulls: false, # required
|
877
984
|
# },
|
878
985
|
# query_log_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
986
|
+
# job_log_status: "ENABLED", # accepts ENABLED, DISABLED
|
879
987
|
# tags: {
|
880
988
|
# "TagKey" => "TagValue",
|
881
989
|
# },
|
@@ -891,6 +999,9 @@ module Aws::CleanRooms
|
|
891
999
|
# is_responsible: false, # required
|
892
1000
|
# },
|
893
1001
|
# },
|
1002
|
+
# job_compute: {
|
1003
|
+
# is_responsible: false, # required
|
1004
|
+
# },
|
894
1005
|
# },
|
895
1006
|
# analytics_engine: "SPARK", # accepts SPARK, CLEAN_ROOMS_SQL
|
896
1007
|
# })
|
@@ -913,6 +1024,7 @@ module Aws::CleanRooms
|
|
913
1024
|
# resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
|
914
1025
|
# resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
|
915
1026
|
# resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
1027
|
+
# resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
916
1028
|
# resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
|
917
1029
|
#
|
918
1030
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateCollaboration AWS API Documentation
|
@@ -1019,8 +1131,18 @@ module Aws::CleanRooms
|
|
1019
1131
|
# or analysis rules.
|
1020
1132
|
#
|
1021
1133
|
# @option params [required, String] :analysis_method
|
1022
|
-
# The analysis method for the configured tables.
|
1023
|
-
#
|
1134
|
+
# The analysis method allowed for the configured tables.
|
1135
|
+
#
|
1136
|
+
# `DIRECT_QUERY` allows SQL queries to be run directly on this table.
|
1137
|
+
#
|
1138
|
+
# `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
|
1139
|
+
#
|
1140
|
+
# `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly
|
1141
|
+
# on this table.
|
1142
|
+
#
|
1143
|
+
# @option params [Array<String>] :selected_analysis_methods
|
1144
|
+
# The analysis methods to enable for the configured table. When
|
1145
|
+
# configured, you must specify at least two analysis methods.
|
1024
1146
|
#
|
1025
1147
|
# @option params [Hash<String,String>] :tags
|
1026
1148
|
# An optional label that you can assign to a resource when you create
|
@@ -1065,7 +1187,8 @@ module Aws::CleanRooms
|
|
1065
1187
|
# },
|
1066
1188
|
# },
|
1067
1189
|
# allowed_columns: ["ColumnName"], # required
|
1068
|
-
# analysis_method: "DIRECT_QUERY", # required, accepts DIRECT_QUERY
|
1190
|
+
# analysis_method: "DIRECT_QUERY", # required, accepts DIRECT_QUERY, DIRECT_JOB, MULTIPLE
|
1191
|
+
# selected_analysis_methods: ["DIRECT_QUERY"], # accepts DIRECT_QUERY, DIRECT_JOB
|
1069
1192
|
# tags: {
|
1070
1193
|
# "TagKey" => "TagValue",
|
1071
1194
|
# },
|
@@ -1095,9 +1218,11 @@ module Aws::CleanRooms
|
|
1095
1218
|
# resp.configured_table.update_time #=> Time
|
1096
1219
|
# resp.configured_table.analysis_rule_types #=> Array
|
1097
1220
|
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1098
|
-
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
1221
|
+
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
1099
1222
|
# resp.configured_table.allowed_columns #=> Array
|
1100
1223
|
# resp.configured_table.allowed_columns[0] #=> String
|
1224
|
+
# resp.configured_table.selected_analysis_methods #=> Array
|
1225
|
+
# resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
1101
1226
|
#
|
1102
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateConfiguredTable AWS API Documentation
|
1103
1228
|
#
|
@@ -1532,6 +1657,18 @@ module Aws::CleanRooms
|
|
1532
1657
|
# An indicator as to whether query logging has been enabled or disabled
|
1533
1658
|
# for the membership.
|
1534
1659
|
#
|
1660
|
+
# When `ENABLED`, Clean Rooms logs details about queries run within this
|
1661
|
+
# collaboration and those logs can be viewed in Amazon CloudWatch Logs.
|
1662
|
+
# The default value is `DISABLED`.
|
1663
|
+
#
|
1664
|
+
# @option params [String] :job_log_status
|
1665
|
+
# An indicator as to whether job logging has been enabled or disabled
|
1666
|
+
# for the collaboration.
|
1667
|
+
#
|
1668
|
+
# When `ENABLED`, Clean Rooms logs details about jobs run within this
|
1669
|
+
# collaboration and those logs can be viewed in Amazon CloudWatch Logs.
|
1670
|
+
# The default value is `DISABLED`.
|
1671
|
+
#
|
1535
1672
|
# @option params [Hash<String,String>] :tags
|
1536
1673
|
# An optional label that you can assign to a resource when you create
|
1537
1674
|
# it. Each tag consists of a key and an optional value, both of which
|
@@ -1542,6 +1679,11 @@ module Aws::CleanRooms
|
|
1542
1679
|
# The default protected query result configuration as specified by the
|
1543
1680
|
# member who can receive results.
|
1544
1681
|
#
|
1682
|
+
# @option params [Types::MembershipProtectedJobResultConfiguration] :default_job_result_configuration
|
1683
|
+
# The default job result configuration that determines how job results
|
1684
|
+
# are protected and managed within this membership. This configuration
|
1685
|
+
# applies to all jobs.
|
1686
|
+
#
|
1545
1687
|
# @option params [Types::MembershipPaymentConfiguration] :payment_configuration
|
1546
1688
|
# The payment responsibilities accepted by the collaboration member.
|
1547
1689
|
#
|
@@ -1561,6 +1703,7 @@ module Aws::CleanRooms
|
|
1561
1703
|
# resp = client.create_membership({
|
1562
1704
|
# collaboration_identifier: "CollaborationIdentifier", # required
|
1563
1705
|
# query_log_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
1706
|
+
# job_log_status: "ENABLED", # accepts ENABLED, DISABLED
|
1564
1707
|
# tags: {
|
1565
1708
|
# "TagKey" => "TagValue",
|
1566
1709
|
# },
|
@@ -1575,6 +1718,15 @@ module Aws::CleanRooms
|
|
1575
1718
|
# },
|
1576
1719
|
# role_arn: "RoleArn",
|
1577
1720
|
# },
|
1721
|
+
# default_job_result_configuration: {
|
1722
|
+
# output_configuration: { # required
|
1723
|
+
# s3: {
|
1724
|
+
# bucket: "ProtectedJobS3OutputConfigurationInputBucketString", # required
|
1725
|
+
# key_prefix: "KeyPrefix",
|
1726
|
+
# },
|
1727
|
+
# },
|
1728
|
+
# role_arn: "RoleArn", # required
|
1729
|
+
# },
|
1578
1730
|
# payment_configuration: {
|
1579
1731
|
# query_compute: { # required
|
1580
1732
|
# is_responsible: false, # required
|
@@ -1587,6 +1739,9 @@ module Aws::CleanRooms
|
|
1587
1739
|
# is_responsible: false, # required
|
1588
1740
|
# },
|
1589
1741
|
# },
|
1742
|
+
# job_compute: {
|
1743
|
+
# is_responsible: false, # required
|
1744
|
+
# },
|
1590
1745
|
# },
|
1591
1746
|
# })
|
1592
1747
|
#
|
@@ -1603,18 +1758,23 @@ module Aws::CleanRooms
|
|
1603
1758
|
# resp.membership.update_time #=> Time
|
1604
1759
|
# resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
|
1605
1760
|
# resp.membership.member_abilities #=> Array
|
1606
|
-
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
1761
|
+
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
|
1607
1762
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
|
1608
1763
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
|
1609
1764
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
1765
|
+
# resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
1610
1766
|
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
1611
1767
|
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
1612
1768
|
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
1613
1769
|
# resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
|
1614
1770
|
# resp.membership.default_result_configuration.role_arn #=> String
|
1771
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
|
1772
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
|
1773
|
+
# resp.membership.default_job_result_configuration.role_arn #=> String
|
1615
1774
|
# resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
|
1616
1775
|
# resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
|
1617
1776
|
# resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
|
1777
|
+
# resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
|
1618
1778
|
#
|
1619
1779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateMembership AWS API Documentation
|
1620
1780
|
#
|
@@ -2060,8 +2220,17 @@ module Aws::CleanRooms
|
|
2060
2220
|
# resp.analysis_template.update_time #=> Time
|
2061
2221
|
# resp.analysis_template.schema.referenced_tables #=> Array
|
2062
2222
|
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
2063
|
-
# resp.analysis_template.format #=> String, one of "SQL"
|
2223
|
+
# resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
|
2064
2224
|
# resp.analysis_template.source.text #=> String
|
2225
|
+
# resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
|
2226
|
+
# resp.analysis_template.source.artifacts.entry_point.location.key #=> String
|
2227
|
+
# resp.analysis_template.source.artifacts.additional_artifacts #=> Array
|
2228
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
|
2229
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
|
2230
|
+
# resp.analysis_template.source.artifacts.role_arn #=> String
|
2231
|
+
# resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
|
2232
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
|
2233
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
|
2065
2234
|
# resp.analysis_template.analysis_parameters #=> Array
|
2066
2235
|
# resp.analysis_template.analysis_parameters[0].name #=> String
|
2067
2236
|
# resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
|
@@ -2114,6 +2283,7 @@ module Aws::CleanRooms
|
|
2114
2283
|
# resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
|
2115
2284
|
# resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
|
2116
2285
|
# resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
2286
|
+
# resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
2117
2287
|
# resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
|
2118
2288
|
#
|
2119
2289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaboration AWS API Documentation
|
@@ -2159,8 +2329,17 @@ module Aws::CleanRooms
|
|
2159
2329
|
# resp.collaboration_analysis_template.update_time #=> Time
|
2160
2330
|
# resp.collaboration_analysis_template.schema.referenced_tables #=> Array
|
2161
2331
|
# resp.collaboration_analysis_template.schema.referenced_tables[0] #=> String
|
2162
|
-
# resp.collaboration_analysis_template.format #=> String, one of "SQL"
|
2332
|
+
# resp.collaboration_analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
|
2163
2333
|
# resp.collaboration_analysis_template.source.text #=> String
|
2334
|
+
# resp.collaboration_analysis_template.source.artifacts.entry_point.location.bucket #=> String
|
2335
|
+
# resp.collaboration_analysis_template.source.artifacts.entry_point.location.key #=> String
|
2336
|
+
# resp.collaboration_analysis_template.source.artifacts.additional_artifacts #=> Array
|
2337
|
+
# resp.collaboration_analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
|
2338
|
+
# resp.collaboration_analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
|
2339
|
+
# resp.collaboration_analysis_template.source.artifacts.role_arn #=> String
|
2340
|
+
# resp.collaboration_analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
|
2341
|
+
# resp.collaboration_analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
|
2342
|
+
# resp.collaboration_analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
|
2164
2343
|
# resp.collaboration_analysis_template.analysis_parameters #=> Array
|
2165
2344
|
# resp.collaboration_analysis_template.analysis_parameters[0].name #=> String
|
2166
2345
|
# resp.collaboration_analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
|
@@ -2397,9 +2576,11 @@ module Aws::CleanRooms
|
|
2397
2576
|
# resp.configured_table.update_time #=> Time
|
2398
2577
|
# resp.configured_table.analysis_rule_types #=> Array
|
2399
2578
|
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
2400
|
-
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
2579
|
+
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
2401
2580
|
# resp.configured_table.allowed_columns #=> Array
|
2402
2581
|
# resp.configured_table.allowed_columns[0] #=> String
|
2582
|
+
# resp.configured_table.selected_analysis_methods #=> Array
|
2583
|
+
# resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
2403
2584
|
#
|
2404
2585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTable AWS API Documentation
|
2405
2586
|
#
|
@@ -2709,18 +2890,23 @@ module Aws::CleanRooms
|
|
2709
2890
|
# resp.membership.update_time #=> Time
|
2710
2891
|
# resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
|
2711
2892
|
# resp.membership.member_abilities #=> Array
|
2712
|
-
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
2893
|
+
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
|
2713
2894
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
|
2714
2895
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
|
2715
2896
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
2897
|
+
# resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
2716
2898
|
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
2717
2899
|
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
2718
2900
|
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
2719
2901
|
# resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
|
2720
2902
|
# resp.membership.default_result_configuration.role_arn #=> String
|
2903
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
|
2904
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
|
2905
|
+
# resp.membership.default_job_result_configuration.role_arn #=> String
|
2721
2906
|
# resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
|
2722
2907
|
# resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
|
2723
2908
|
# resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
|
2909
|
+
# resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
|
2724
2910
|
#
|
2725
2911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetMembership AWS API Documentation
|
2726
2912
|
#
|
@@ -2776,6 +2962,53 @@ module Aws::CleanRooms
|
|
2776
2962
|
req.send_request(options)
|
2777
2963
|
end
|
2778
2964
|
|
2965
|
+
# Returns job processing metadata.
|
2966
|
+
#
|
2967
|
+
# @option params [required, String] :membership_identifier
|
2968
|
+
# The identifier for a membership in a protected job instance.
|
2969
|
+
#
|
2970
|
+
# @option params [required, String] :protected_job_identifier
|
2971
|
+
# The identifier for the protected job instance.
|
2972
|
+
#
|
2973
|
+
# @return [Types::GetProtectedJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2974
|
+
#
|
2975
|
+
# * {Types::GetProtectedJobOutput#protected_job #protected_job} => Types::ProtectedJob
|
2976
|
+
#
|
2977
|
+
# @example Request syntax with placeholder values
|
2978
|
+
#
|
2979
|
+
# resp = client.get_protected_job({
|
2980
|
+
# membership_identifier: "MembershipIdentifier", # required
|
2981
|
+
# protected_job_identifier: "ProtectedJobIdentifier", # required
|
2982
|
+
# })
|
2983
|
+
#
|
2984
|
+
# @example Response structure
|
2985
|
+
#
|
2986
|
+
# resp.protected_job.id #=> String
|
2987
|
+
# resp.protected_job.membership_id #=> String
|
2988
|
+
# resp.protected_job.membership_arn #=> String
|
2989
|
+
# resp.protected_job.create_time #=> Time
|
2990
|
+
# resp.protected_job.job_parameters.analysis_template_arn #=> String
|
2991
|
+
# resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
|
2992
|
+
# resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
|
2993
|
+
# resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
|
2994
|
+
# resp.protected_job.result_configuration.output_configuration.member.account_id #=> String
|
2995
|
+
# resp.protected_job.statistics.total_duration_in_millis #=> Integer
|
2996
|
+
# resp.protected_job.statistics.billed_resource_utilization.units #=> Float
|
2997
|
+
# resp.protected_job.result.output.s3.location #=> String
|
2998
|
+
# resp.protected_job.result.output.member_list #=> Array
|
2999
|
+
# resp.protected_job.result.output.member_list[0].account_id #=> String
|
3000
|
+
# resp.protected_job.error.message #=> String
|
3001
|
+
# resp.protected_job.error.code #=> String
|
3002
|
+
#
|
3003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetProtectedJob AWS API Documentation
|
3004
|
+
#
|
3005
|
+
# @overload get_protected_job(params = {})
|
3006
|
+
# @param [Hash] params ({})
|
3007
|
+
def get_protected_job(params = {}, options = {})
|
3008
|
+
req = build_request(:get_protected_job, params)
|
3009
|
+
req.send_request(options)
|
3010
|
+
end
|
3011
|
+
|
2779
3012
|
# Returns query processing metadata.
|
2780
3013
|
#
|
2781
3014
|
# @option params [required, String] :membership_identifier
|
@@ -2866,7 +3099,9 @@ module Aws::CleanRooms
|
|
2866
3099
|
# resp.schema.partition_keys[0].type #=> String
|
2867
3100
|
# resp.schema.analysis_rule_types #=> Array
|
2868
3101
|
# resp.schema.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
|
2869
|
-
# resp.schema.analysis_method #=> String, one of "DIRECT_QUERY"
|
3102
|
+
# resp.schema.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
3103
|
+
# resp.schema.selected_analysis_methods #=> Array
|
3104
|
+
# resp.schema.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
2870
3105
|
# resp.schema.creator_account_id #=> String
|
2871
3106
|
# resp.schema.name #=> String
|
2872
3107
|
# resp.schema.collaboration_id #=> String
|
@@ -2971,6 +3206,64 @@ module Aws::CleanRooms
|
|
2971
3206
|
# resp.analysis_rule.policy.v1.id_mapping_table.query_constraints[0].require_overlap.columns[0] #=> String
|
2972
3207
|
# resp.analysis_rule.policy.v1.id_mapping_table.dimension_columns #=> Array
|
2973
3208
|
# resp.analysis_rule.policy.v1.id_mapping_table.dimension_columns[0] #=> String
|
3209
|
+
# resp.analysis_rule.collaboration_policy.v1.list.allowed_result_receivers #=> Array
|
3210
|
+
# resp.analysis_rule.collaboration_policy.v1.list.allowed_result_receivers[0] #=> String
|
3211
|
+
# resp.analysis_rule.collaboration_policy.v1.list.allowed_additional_analyses #=> Array
|
3212
|
+
# resp.analysis_rule.collaboration_policy.v1.list.allowed_additional_analyses[0] #=> String
|
3213
|
+
# resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_result_receivers #=> Array
|
3214
|
+
# resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_result_receivers[0] #=> String
|
3215
|
+
# resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_additional_analyses #=> Array
|
3216
|
+
# resp.analysis_rule.collaboration_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
|
3217
|
+
# resp.analysis_rule.collaboration_policy.v1.custom.allowed_result_receivers #=> Array
|
3218
|
+
# resp.analysis_rule.collaboration_policy.v1.custom.allowed_result_receivers[0] #=> String
|
3219
|
+
# resp.analysis_rule.collaboration_policy.v1.custom.allowed_additional_analyses #=> Array
|
3220
|
+
# resp.analysis_rule.collaboration_policy.v1.custom.allowed_additional_analyses[0] #=> String
|
3221
|
+
# resp.analysis_rule.consolidated_policy.v1.list.join_columns #=> Array
|
3222
|
+
# resp.analysis_rule.consolidated_policy.v1.list.join_columns[0] #=> String
|
3223
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_join_operators #=> Array
|
3224
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_join_operators[0] #=> String, one of "OR", "AND"
|
3225
|
+
# resp.analysis_rule.consolidated_policy.v1.list.list_columns #=> Array
|
3226
|
+
# resp.analysis_rule.consolidated_policy.v1.list.list_columns[0] #=> String
|
3227
|
+
# resp.analysis_rule.consolidated_policy.v1.list.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
3228
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_result_receivers #=> Array
|
3229
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_result_receivers[0] #=> String
|
3230
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_additional_analyses #=> Array
|
3231
|
+
# resp.analysis_rule.consolidated_policy.v1.list.allowed_additional_analyses[0] #=> String
|
3232
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns #=> Array
|
3233
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].column_names #=> Array
|
3234
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].column_names[0] #=> String
|
3235
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.aggregate_columns[0].function #=> String, one of "SUM", "SUM_DISTINCT", "COUNT", "COUNT_DISTINCT", "AVG"
|
3236
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.join_columns #=> Array
|
3237
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.join_columns[0] #=> String
|
3238
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.join_required #=> String, one of "QUERY_RUNNER"
|
3239
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_join_operators #=> Array
|
3240
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_join_operators[0] #=> String, one of "OR", "AND"
|
3241
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.dimension_columns #=> Array
|
3242
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.dimension_columns[0] #=> String
|
3243
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.scalar_functions #=> Array
|
3244
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.scalar_functions[0] #=> String, one of "ABS", "CAST", "CEILING", "COALESCE", "CONVERT", "CURRENT_DATE", "DATEADD", "EXTRACT", "FLOOR", "GETDATE", "LN", "LOG", "LOWER", "ROUND", "RTRIM", "SQRT", "SUBSTRING", "TO_CHAR", "TO_DATE", "TO_NUMBER", "TO_TIMESTAMP", "TRIM", "TRUNC", "UPPER"
|
3245
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints #=> Array
|
3246
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].column_name #=> String
|
3247
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
3248
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
3249
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
3250
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_result_receivers #=> Array
|
3251
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_result_receivers[0] #=> String
|
3252
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_additional_analyses #=> Array
|
3253
|
+
# resp.analysis_rule.consolidated_policy.v1.aggregation.allowed_additional_analyses[0] #=> String
|
3254
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_analyses #=> Array
|
3255
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_analyses[0] #=> String
|
3256
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_analysis_providers #=> Array
|
3257
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_analysis_providers[0] #=> String
|
3258
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.additional_analyses #=> String, one of "ALLOWED", "REQUIRED", "NOT_ALLOWED"
|
3259
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.disallowed_output_columns #=> Array
|
3260
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.disallowed_output_columns[0] #=> String
|
3261
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.differential_privacy.columns #=> Array
|
3262
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.differential_privacy.columns[0].name #=> String
|
3263
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_result_receivers #=> Array
|
3264
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_result_receivers[0] #=> String
|
3265
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_additional_analyses #=> Array
|
3266
|
+
# resp.analysis_rule.consolidated_policy.v1.custom.allowed_additional_analyses[0] #=> String
|
2974
3267
|
#
|
2975
3268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaAnalysisRule AWS API Documentation
|
2976
3269
|
#
|
@@ -3462,6 +3755,8 @@ module Aws::CleanRooms
|
|
3462
3755
|
# resp.configured_table_association_summaries[0].update_time #=> Time
|
3463
3756
|
# resp.configured_table_association_summaries[0].id #=> String
|
3464
3757
|
# resp.configured_table_association_summaries[0].arn #=> String
|
3758
|
+
# resp.configured_table_association_summaries[0].analysis_rule_types #=> Array
|
3759
|
+
# resp.configured_table_association_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
3465
3760
|
# resp.next_token #=> String
|
3466
3761
|
#
|
3467
3762
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTableAssociations AWS API Documentation
|
@@ -3508,7 +3803,9 @@ module Aws::CleanRooms
|
|
3508
3803
|
# resp.configured_table_summaries[0].update_time #=> Time
|
3509
3804
|
# resp.configured_table_summaries[0].analysis_rule_types #=> Array
|
3510
3805
|
# resp.configured_table_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
3511
|
-
# resp.configured_table_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
3806
|
+
# resp.configured_table_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
3807
|
+
# resp.configured_table_summaries[0].selected_analysis_methods #=> Array
|
3808
|
+
# resp.configured_table_summaries[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
3512
3809
|
# resp.next_token #=> String
|
3513
3810
|
#
|
3514
3811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListConfiguredTables AWS API Documentation
|
@@ -3668,7 +3965,7 @@ module Aws::CleanRooms
|
|
3668
3965
|
# resp.member_summaries[0].status #=> String, one of "INVITED", "ACTIVE", "LEFT", "REMOVED"
|
3669
3966
|
# resp.member_summaries[0].display_name #=> String
|
3670
3967
|
# resp.member_summaries[0].abilities #=> Array
|
3671
|
-
# resp.member_summaries[0].abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
3968
|
+
# resp.member_summaries[0].abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
|
3672
3969
|
# resp.member_summaries[0].ml_abilities.custom_ml_member_abilities #=> Array
|
3673
3970
|
# resp.member_summaries[0].ml_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
|
3674
3971
|
# resp.member_summaries[0].create_time #=> Time
|
@@ -3678,6 +3975,7 @@ module Aws::CleanRooms
|
|
3678
3975
|
# resp.member_summaries[0].payment_configuration.query_compute.is_responsible #=> Boolean
|
3679
3976
|
# resp.member_summaries[0].payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
|
3680
3977
|
# resp.member_summaries[0].payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
|
3978
|
+
# resp.member_summaries[0].payment_configuration.job_compute.is_responsible #=> Boolean
|
3681
3979
|
#
|
3682
3980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMembers AWS API Documentation
|
3683
3981
|
#
|
@@ -3732,12 +4030,13 @@ module Aws::CleanRooms
|
|
3732
4030
|
# resp.membership_summaries[0].update_time #=> Time
|
3733
4031
|
# resp.membership_summaries[0].status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
|
3734
4032
|
# resp.membership_summaries[0].member_abilities #=> Array
|
3735
|
-
# resp.membership_summaries[0].member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
4033
|
+
# resp.membership_summaries[0].member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
|
3736
4034
|
# resp.membership_summaries[0].ml_member_abilities.custom_ml_member_abilities #=> Array
|
3737
4035
|
# resp.membership_summaries[0].ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
|
3738
4036
|
# resp.membership_summaries[0].payment_configuration.query_compute.is_responsible #=> Boolean
|
3739
4037
|
# resp.membership_summaries[0].payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
|
3740
4038
|
# resp.membership_summaries[0].payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
|
4039
|
+
# resp.membership_summaries[0].payment_configuration.job_compute.is_responsible #=> Boolean
|
3741
4040
|
#
|
3742
4041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListMemberships AWS API Documentation
|
3743
4042
|
#
|
@@ -3868,6 +4167,62 @@ module Aws::CleanRooms
|
|
3868
4167
|
req.send_request(options)
|
3869
4168
|
end
|
3870
4169
|
|
4170
|
+
# Lists protected jobs, sorted by most recent job.
|
4171
|
+
#
|
4172
|
+
# @option params [required, String] :membership_identifier
|
4173
|
+
# The identifier for the membership in the collaboration.
|
4174
|
+
#
|
4175
|
+
# @option params [String] :status
|
4176
|
+
# A filter on the status of the protected job.
|
4177
|
+
#
|
4178
|
+
# @option params [String] :next_token
|
4179
|
+
# The pagination token that's used to fetch the next set of results.
|
4180
|
+
#
|
4181
|
+
# @option params [Integer] :max_results
|
4182
|
+
# The maximum number of results that are returned for an API request
|
4183
|
+
# call. The service chooses a default number if you don't set one. The
|
4184
|
+
# service might return a `nextToken` even if the `maxResults` value
|
4185
|
+
# has not been met.
|
4186
|
+
#
|
4187
|
+
# @return [Types::ListProtectedJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4188
|
+
#
|
4189
|
+
# * {Types::ListProtectedJobsOutput#next_token #next_token} => String
|
4190
|
+
# * {Types::ListProtectedJobsOutput#protected_jobs #protected_jobs} => Array<Types::ProtectedJobSummary>
|
4191
|
+
#
|
4192
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4193
|
+
#
|
4194
|
+
# @example Request syntax with placeholder values
|
4195
|
+
#
|
4196
|
+
# resp = client.list_protected_jobs({
|
4197
|
+
# membership_identifier: "MembershipIdentifier", # required
|
4198
|
+
# status: "SUBMITTED", # accepts SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS
|
4199
|
+
# next_token: "PaginationToken",
|
4200
|
+
# max_results: 1,
|
4201
|
+
# })
|
4202
|
+
#
|
4203
|
+
# @example Response structure
|
4204
|
+
#
|
4205
|
+
# resp.next_token #=> String
|
4206
|
+
# resp.protected_jobs #=> Array
|
4207
|
+
# resp.protected_jobs[0].id #=> String
|
4208
|
+
# resp.protected_jobs[0].membership_id #=> String
|
4209
|
+
# resp.protected_jobs[0].membership_arn #=> String
|
4210
|
+
# resp.protected_jobs[0].create_time #=> Time
|
4211
|
+
# resp.protected_jobs[0].status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
|
4212
|
+
# resp.protected_jobs[0].receiver_configurations #=> Array
|
4213
|
+
# resp.protected_jobs[0].receiver_configurations[0].analysis_type #=> String, one of "DIRECT_ANALYSIS"
|
4214
|
+
# resp.protected_jobs[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details.receiver_account_ids #=> Array
|
4215
|
+
# resp.protected_jobs[0].receiver_configurations[0].configuration_details.direct_analysis_configuration_details.receiver_account_ids[0] #=> String
|
4216
|
+
#
|
4217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListProtectedJobs AWS API Documentation
|
4218
|
+
#
|
4219
|
+
# @overload list_protected_jobs(params = {})
|
4220
|
+
# @param [Hash] params ({})
|
4221
|
+
def list_protected_jobs(params = {}, options = {})
|
4222
|
+
req = build_request(:list_protected_jobs, params)
|
4223
|
+
req.send_request(options)
|
4224
|
+
end
|
4225
|
+
|
3871
4226
|
# Lists protected queries, sorted by the most recent query.
|
3872
4227
|
#
|
3873
4228
|
# @option params [required, String] :membership_identifier
|
@@ -3970,7 +4325,9 @@ module Aws::CleanRooms
|
|
3970
4325
|
# resp.schema_summaries[0].collaboration_arn #=> String
|
3971
4326
|
# resp.schema_summaries[0].analysis_rule_types #=> Array
|
3972
4327
|
# resp.schema_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM", "ID_MAPPING_TABLE"
|
3973
|
-
# resp.schema_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
4328
|
+
# resp.schema_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
4329
|
+
# resp.schema_summaries[0].selected_analysis_methods #=> Array
|
4330
|
+
# resp.schema_summaries[0].selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
3974
4331
|
# resp.next_token #=> String
|
3975
4332
|
#
|
3976
4333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListSchemas AWS API Documentation
|
@@ -4088,6 +4445,70 @@ module Aws::CleanRooms
|
|
4088
4445
|
req.send_request(options)
|
4089
4446
|
end
|
4090
4447
|
|
4448
|
+
# Creates a protected job that is started by Clean Rooms.
|
4449
|
+
#
|
4450
|
+
# @option params [required, String] :type
|
4451
|
+
# The type of protected job to start.
|
4452
|
+
#
|
4453
|
+
# @option params [required, String] :membership_identifier
|
4454
|
+
# A unique identifier for the membership to run this job against.
|
4455
|
+
# Currently accepts a membership ID.
|
4456
|
+
#
|
4457
|
+
# @option params [required, Types::ProtectedJobParameters] :job_parameters
|
4458
|
+
# The job parameters.
|
4459
|
+
#
|
4460
|
+
# @option params [Types::ProtectedJobResultConfigurationInput] :result_configuration
|
4461
|
+
# The details needed to write the job results.
|
4462
|
+
#
|
4463
|
+
# @return [Types::StartProtectedJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4464
|
+
#
|
4465
|
+
# * {Types::StartProtectedJobOutput#protected_job #protected_job} => Types::ProtectedJob
|
4466
|
+
#
|
4467
|
+
# @example Request syntax with placeholder values
|
4468
|
+
#
|
4469
|
+
# resp = client.start_protected_job({
|
4470
|
+
# type: "PYSPARK", # required, accepts PYSPARK
|
4471
|
+
# membership_identifier: "MembershipIdentifier", # required
|
4472
|
+
# job_parameters: { # required
|
4473
|
+
# analysis_template_arn: "AnalysisTemplateArn",
|
4474
|
+
# },
|
4475
|
+
# result_configuration: {
|
4476
|
+
# output_configuration: { # required
|
4477
|
+
# member: {
|
4478
|
+
# account_id: "AccountId", # required
|
4479
|
+
# },
|
4480
|
+
# },
|
4481
|
+
# },
|
4482
|
+
# })
|
4483
|
+
#
|
4484
|
+
# @example Response structure
|
4485
|
+
#
|
4486
|
+
# resp.protected_job.id #=> String
|
4487
|
+
# resp.protected_job.membership_id #=> String
|
4488
|
+
# resp.protected_job.membership_arn #=> String
|
4489
|
+
# resp.protected_job.create_time #=> Time
|
4490
|
+
# resp.protected_job.job_parameters.analysis_template_arn #=> String
|
4491
|
+
# resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
|
4492
|
+
# resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
|
4493
|
+
# resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
|
4494
|
+
# resp.protected_job.result_configuration.output_configuration.member.account_id #=> String
|
4495
|
+
# resp.protected_job.statistics.total_duration_in_millis #=> Integer
|
4496
|
+
# resp.protected_job.statistics.billed_resource_utilization.units #=> Float
|
4497
|
+
# resp.protected_job.result.output.s3.location #=> String
|
4498
|
+
# resp.protected_job.result.output.member_list #=> Array
|
4499
|
+
# resp.protected_job.result.output.member_list[0].account_id #=> String
|
4500
|
+
# resp.protected_job.error.message #=> String
|
4501
|
+
# resp.protected_job.error.code #=> String
|
4502
|
+
#
|
4503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/StartProtectedJob AWS API Documentation
|
4504
|
+
#
|
4505
|
+
# @overload start_protected_job(params = {})
|
4506
|
+
# @param [Hash] params ({})
|
4507
|
+
def start_protected_job(params = {}, options = {})
|
4508
|
+
req = build_request(:start_protected_job, params)
|
4509
|
+
req.send_request(options)
|
4510
|
+
end
|
4511
|
+
|
4091
4512
|
# Creates a protected query that is started by Clean Rooms.
|
4092
4513
|
#
|
4093
4514
|
# @option params [required, String] :type
|
@@ -4277,8 +4698,17 @@ module Aws::CleanRooms
|
|
4277
4698
|
# resp.analysis_template.update_time #=> Time
|
4278
4699
|
# resp.analysis_template.schema.referenced_tables #=> Array
|
4279
4700
|
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
4280
|
-
# resp.analysis_template.format #=> String, one of "SQL"
|
4701
|
+
# resp.analysis_template.format #=> String, one of "SQL", "PYSPARK_1_0"
|
4281
4702
|
# resp.analysis_template.source.text #=> String
|
4703
|
+
# resp.analysis_template.source.artifacts.entry_point.location.bucket #=> String
|
4704
|
+
# resp.analysis_template.source.artifacts.entry_point.location.key #=> String
|
4705
|
+
# resp.analysis_template.source.artifacts.additional_artifacts #=> Array
|
4706
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.bucket #=> String
|
4707
|
+
# resp.analysis_template.source.artifacts.additional_artifacts[0].location.key #=> String
|
4708
|
+
# resp.analysis_template.source.artifacts.role_arn #=> String
|
4709
|
+
# resp.analysis_template.source_metadata.artifacts.entry_point_hash.sha256 #=> String
|
4710
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes #=> Array
|
4711
|
+
# resp.analysis_template.source_metadata.artifacts.additional_artifact_hashes[0].sha256 #=> String
|
4282
4712
|
# resp.analysis_template.analysis_parameters #=> Array
|
4283
4713
|
# resp.analysis_template.analysis_parameters[0].name #=> String
|
4284
4714
|
# resp.analysis_template.analysis_parameters[0].type #=> String, one of "SMALLINT", "INTEGER", "BIGINT", "DECIMAL", "REAL", "DOUBLE_PRECISION", "BOOLEAN", "CHAR", "VARCHAR", "DATE", "TIMESTAMP", "TIMESTAMPTZ", "TIME", "TIMETZ", "VARBYTE", "BINARY", "BYTE", "CHARACTER", "DOUBLE", "FLOAT", "INT", "LONG", "NUMERIC", "SHORT", "STRING", "TIMESTAMP_LTZ", "TIMESTAMP_NTZ", "TINYINT"
|
@@ -4341,6 +4771,7 @@ module Aws::CleanRooms
|
|
4341
4771
|
# resp.collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names #=> Boolean
|
4342
4772
|
# resp.collaboration.data_encryption_metadata.preserve_nulls #=> Boolean
|
4343
4773
|
# resp.collaboration.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
4774
|
+
# resp.collaboration.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
4344
4775
|
# resp.collaboration.analytics_engine #=> String, one of "SPARK", "CLEAN_ROOMS_SQL"
|
4345
4776
|
#
|
4346
4777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateCollaboration AWS API Documentation
|
@@ -4418,6 +4849,19 @@ module Aws::CleanRooms
|
|
4418
4849
|
# @option params [String] :description
|
4419
4850
|
# A new description for the configured table.
|
4420
4851
|
#
|
4852
|
+
# @option params [String] :analysis_method
|
4853
|
+
# The analysis method for the configured table.
|
4854
|
+
#
|
4855
|
+
# `DIRECT_QUERY` allows SQL queries to be run directly on this table.
|
4856
|
+
#
|
4857
|
+
# `DIRECT_JOB` allows PySpark jobs to be run directly on this table.
|
4858
|
+
#
|
4859
|
+
# `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly
|
4860
|
+
# on this table.
|
4861
|
+
#
|
4862
|
+
# @option params [Array<String>] :selected_analysis_methods
|
4863
|
+
# The selected analysis methods for the table configuration update.
|
4864
|
+
#
|
4421
4865
|
# @return [Types::UpdateConfiguredTableOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4422
4866
|
#
|
4423
4867
|
# * {Types::UpdateConfiguredTableOutput#configured_table #configured_table} => Types::ConfiguredTable
|
@@ -4428,6 +4872,8 @@ module Aws::CleanRooms
|
|
4428
4872
|
# configured_table_identifier: "ConfiguredTableIdentifier", # required
|
4429
4873
|
# name: "DisplayName",
|
4430
4874
|
# description: "TableDescription",
|
4875
|
+
# analysis_method: "DIRECT_QUERY", # accepts DIRECT_QUERY, DIRECT_JOB, MULTIPLE
|
4876
|
+
# selected_analysis_methods: ["DIRECT_QUERY"], # accepts DIRECT_QUERY, DIRECT_JOB
|
4431
4877
|
# })
|
4432
4878
|
#
|
4433
4879
|
# @example Response structure
|
@@ -4454,9 +4900,11 @@ module Aws::CleanRooms
|
|
4454
4900
|
# resp.configured_table.update_time #=> Time
|
4455
4901
|
# resp.configured_table.analysis_rule_types #=> Array
|
4456
4902
|
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
4457
|
-
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
4903
|
+
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY", "DIRECT_JOB", "MULTIPLE"
|
4458
4904
|
# resp.configured_table.allowed_columns #=> Array
|
4459
4905
|
# resp.configured_table.allowed_columns[0] #=> String
|
4906
|
+
# resp.configured_table.selected_analysis_methods #=> Array
|
4907
|
+
# resp.configured_table.selected_analysis_methods[0] #=> String, one of "DIRECT_QUERY", "DIRECT_JOB"
|
4460
4908
|
#
|
4461
4909
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateConfiguredTable AWS API Documentation
|
4462
4910
|
#
|
@@ -4843,10 +5291,25 @@ module Aws::CleanRooms
|
|
4843
5291
|
# An indicator as to whether query logging has been enabled or disabled
|
4844
5292
|
# for the membership.
|
4845
5293
|
#
|
5294
|
+
# When `ENABLED`, Clean Rooms logs details about queries run within this
|
5295
|
+
# collaboration and those logs can be viewed in Amazon CloudWatch Logs.
|
5296
|
+
# The default value is `DISABLED`.
|
5297
|
+
#
|
5298
|
+
# @option params [String] :job_log_status
|
5299
|
+
# An indicator as to whether job logging has been enabled or disabled
|
5300
|
+
# for the collaboration.
|
5301
|
+
#
|
5302
|
+
# When `ENABLED`, Clean Rooms logs details about jobs run within this
|
5303
|
+
# collaboration and those logs can be viewed in Amazon CloudWatch Logs.
|
5304
|
+
# The default value is `DISABLED`.
|
5305
|
+
#
|
4846
5306
|
# @option params [Types::MembershipProtectedQueryResultConfiguration] :default_result_configuration
|
4847
5307
|
# The default protected query result configuration as specified by the
|
4848
5308
|
# member who can receive results.
|
4849
5309
|
#
|
5310
|
+
# @option params [Types::MembershipProtectedJobResultConfiguration] :default_job_result_configuration
|
5311
|
+
# The default job result configuration.
|
5312
|
+
#
|
4850
5313
|
# @return [Types::UpdateMembershipOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4851
5314
|
#
|
4852
5315
|
# * {Types::UpdateMembershipOutput#membership #membership} => Types::Membership
|
@@ -4856,6 +5319,7 @@ module Aws::CleanRooms
|
|
4856
5319
|
# resp = client.update_membership({
|
4857
5320
|
# membership_identifier: "MembershipIdentifier", # required
|
4858
5321
|
# query_log_status: "ENABLED", # accepts ENABLED, DISABLED
|
5322
|
+
# job_log_status: "ENABLED", # accepts ENABLED, DISABLED
|
4859
5323
|
# default_result_configuration: {
|
4860
5324
|
# output_configuration: { # required
|
4861
5325
|
# s3: {
|
@@ -4867,6 +5331,15 @@ module Aws::CleanRooms
|
|
4867
5331
|
# },
|
4868
5332
|
# role_arn: "RoleArn",
|
4869
5333
|
# },
|
5334
|
+
# default_job_result_configuration: {
|
5335
|
+
# output_configuration: { # required
|
5336
|
+
# s3: {
|
5337
|
+
# bucket: "ProtectedJobS3OutputConfigurationInputBucketString", # required
|
5338
|
+
# key_prefix: "KeyPrefix",
|
5339
|
+
# },
|
5340
|
+
# },
|
5341
|
+
# role_arn: "RoleArn", # required
|
5342
|
+
# },
|
4870
5343
|
# })
|
4871
5344
|
#
|
4872
5345
|
# @example Response structure
|
@@ -4882,18 +5355,23 @@ module Aws::CleanRooms
|
|
4882
5355
|
# resp.membership.update_time #=> Time
|
4883
5356
|
# resp.membership.status #=> String, one of "ACTIVE", "REMOVED", "COLLABORATION_DELETED"
|
4884
5357
|
# resp.membership.member_abilities #=> Array
|
4885
|
-
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
5358
|
+
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS", "CAN_RUN_JOB"
|
4886
5359
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities #=> Array
|
4887
5360
|
# resp.membership.ml_member_abilities.custom_ml_member_abilities[0] #=> String, one of "CAN_RECEIVE_MODEL_OUTPUT", "CAN_RECEIVE_INFERENCE_OUTPUT"
|
4888
5361
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
5362
|
+
# resp.membership.job_log_status #=> String, one of "ENABLED", "DISABLED"
|
4889
5363
|
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
4890
5364
|
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
4891
5365
|
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
4892
5366
|
# resp.membership.default_result_configuration.output_configuration.s3.single_file_output #=> Boolean
|
4893
5367
|
# resp.membership.default_result_configuration.role_arn #=> String
|
5368
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.bucket #=> String
|
5369
|
+
# resp.membership.default_job_result_configuration.output_configuration.s3.key_prefix #=> String
|
5370
|
+
# resp.membership.default_job_result_configuration.role_arn #=> String
|
4894
5371
|
# resp.membership.payment_configuration.query_compute.is_responsible #=> Boolean
|
4895
5372
|
# resp.membership.payment_configuration.machine_learning.model_training.is_responsible #=> Boolean
|
4896
5373
|
# resp.membership.payment_configuration.machine_learning.model_inference.is_responsible #=> Boolean
|
5374
|
+
# resp.membership.payment_configuration.job_compute.is_responsible #=> Boolean
|
4897
5375
|
#
|
4898
5376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembership AWS API Documentation
|
4899
5377
|
#
|
@@ -4964,6 +5442,58 @@ module Aws::CleanRooms
|
|
4964
5442
|
req.send_request(options)
|
4965
5443
|
end
|
4966
5444
|
|
5445
|
+
# Updates the processing of a currently running job.
|
5446
|
+
#
|
5447
|
+
# @option params [required, String] :membership_identifier
|
5448
|
+
# The identifier for a member of a protected job instance.
|
5449
|
+
#
|
5450
|
+
# @option params [required, String] :protected_job_identifier
|
5451
|
+
# The identifier of the protected job to update.
|
5452
|
+
#
|
5453
|
+
# @option params [required, String] :target_status
|
5454
|
+
# The target status of a protected job. Used to update the execution
|
5455
|
+
# status of a currently running job.
|
5456
|
+
#
|
5457
|
+
# @return [Types::UpdateProtectedJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5458
|
+
#
|
5459
|
+
# * {Types::UpdateProtectedJobOutput#protected_job #protected_job} => Types::ProtectedJob
|
5460
|
+
#
|
5461
|
+
# @example Request syntax with placeholder values
|
5462
|
+
#
|
5463
|
+
# resp = client.update_protected_job({
|
5464
|
+
# membership_identifier: "MembershipIdentifier", # required
|
5465
|
+
# protected_job_identifier: "ProtectedJobIdentifier", # required
|
5466
|
+
# target_status: "CANCELLED", # required, accepts CANCELLED
|
5467
|
+
# })
|
5468
|
+
#
|
5469
|
+
# @example Response structure
|
5470
|
+
#
|
5471
|
+
# resp.protected_job.id #=> String
|
5472
|
+
# resp.protected_job.membership_id #=> String
|
5473
|
+
# resp.protected_job.membership_arn #=> String
|
5474
|
+
# resp.protected_job.create_time #=> Time
|
5475
|
+
# resp.protected_job.job_parameters.analysis_template_arn #=> String
|
5476
|
+
# resp.protected_job.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS"
|
5477
|
+
# resp.protected_job.result_configuration.output_configuration.s3.bucket #=> String
|
5478
|
+
# resp.protected_job.result_configuration.output_configuration.s3.key_prefix #=> String
|
5479
|
+
# resp.protected_job.result_configuration.output_configuration.member.account_id #=> String
|
5480
|
+
# resp.protected_job.statistics.total_duration_in_millis #=> Integer
|
5481
|
+
# resp.protected_job.statistics.billed_resource_utilization.units #=> Float
|
5482
|
+
# resp.protected_job.result.output.s3.location #=> String
|
5483
|
+
# resp.protected_job.result.output.member_list #=> Array
|
5484
|
+
# resp.protected_job.result.output.member_list[0].account_id #=> String
|
5485
|
+
# resp.protected_job.error.message #=> String
|
5486
|
+
# resp.protected_job.error.code #=> String
|
5487
|
+
#
|
5488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateProtectedJob AWS API Documentation
|
5489
|
+
#
|
5490
|
+
# @overload update_protected_job(params = {})
|
5491
|
+
# @param [Hash] params ({})
|
5492
|
+
def update_protected_job(params = {}, options = {})
|
5493
|
+
req = build_request(:update_protected_job, params)
|
5494
|
+
req.send_request(options)
|
5495
|
+
end
|
5496
|
+
|
4967
5497
|
# Updates the processing of a currently running query.
|
4968
5498
|
#
|
4969
5499
|
# @option params [required, String] :membership_identifier
|
@@ -5047,7 +5577,7 @@ module Aws::CleanRooms
|
|
5047
5577
|
tracer: tracer
|
5048
5578
|
)
|
5049
5579
|
context[:gem_name] = 'aws-sdk-cleanrooms'
|
5050
|
-
context[:gem_version] = '1.
|
5580
|
+
context[:gem_version] = '1.41.0'
|
5051
5581
|
Seahorse::Client::Request.new(handlers, context)
|
5052
5582
|
end
|
5053
5583
|
|