aws-sdk-cleanrooms 1.8.0 → 1.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanrooms/client.rb +524 -21
- data/lib/aws-sdk-cleanrooms/client_api.rb +360 -3
- data/lib/aws-sdk-cleanrooms/endpoints.rb +112 -0
- data/lib/aws-sdk-cleanrooms/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-cleanrooms/types.rb +813 -19
- data/lib/aws-sdk-cleanrooms.rb +2 -2
- metadata +2 -2
@@ -388,6 +388,63 @@ module Aws::CleanRooms
|
|
388
388
|
|
389
389
|
# @!group API Operations
|
390
390
|
|
391
|
+
# Retrieves multiple analysis templates within a collaboration by their
|
392
|
+
# Amazon Resource Names (ARNs).
|
393
|
+
#
|
394
|
+
# @option params [required, String] :collaboration_identifier
|
395
|
+
# A unique identifier for the collaboration that the analysis templates
|
396
|
+
# belong to. Currently accepts collaboration ID.
|
397
|
+
#
|
398
|
+
# @option params [required, Array<String>] :analysis_template_arns
|
399
|
+
# The Amazon Resource Name (ARN) associated with the analysis template
|
400
|
+
# within a collaboration.
|
401
|
+
#
|
402
|
+
# @return [Types::BatchGetCollaborationAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::BatchGetCollaborationAnalysisTemplateOutput#collaboration_analysis_templates #collaboration_analysis_templates} => Array<Types::CollaborationAnalysisTemplate>
|
405
|
+
# * {Types::BatchGetCollaborationAnalysisTemplateOutput#errors #errors} => Array<Types::BatchGetCollaborationAnalysisTemplateError>
|
406
|
+
#
|
407
|
+
# @example Request syntax with placeholder values
|
408
|
+
#
|
409
|
+
# resp = client.batch_get_collaboration_analysis_template({
|
410
|
+
# collaboration_identifier: "CollaborationIdentifier", # required
|
411
|
+
# analysis_template_arns: ["AnalysisTemplateArn"], # required
|
412
|
+
# })
|
413
|
+
#
|
414
|
+
# @example Response structure
|
415
|
+
#
|
416
|
+
# resp.collaboration_analysis_templates #=> Array
|
417
|
+
# resp.collaboration_analysis_templates[0].id #=> String
|
418
|
+
# resp.collaboration_analysis_templates[0].arn #=> String
|
419
|
+
# resp.collaboration_analysis_templates[0].collaboration_id #=> String
|
420
|
+
# resp.collaboration_analysis_templates[0].collaboration_arn #=> String
|
421
|
+
# resp.collaboration_analysis_templates[0].description #=> String
|
422
|
+
# resp.collaboration_analysis_templates[0].creator_account_id #=> String
|
423
|
+
# resp.collaboration_analysis_templates[0].name #=> String
|
424
|
+
# resp.collaboration_analysis_templates[0].create_time #=> Time
|
425
|
+
# resp.collaboration_analysis_templates[0].update_time #=> Time
|
426
|
+
# resp.collaboration_analysis_templates[0].schema.referenced_tables #=> Array
|
427
|
+
# resp.collaboration_analysis_templates[0].schema.referenced_tables[0] #=> String
|
428
|
+
# resp.collaboration_analysis_templates[0].format #=> String, one of "SQL"
|
429
|
+
# resp.collaboration_analysis_templates[0].source.text #=> String
|
430
|
+
# resp.collaboration_analysis_templates[0].analysis_parameters #=> Array
|
431
|
+
# resp.collaboration_analysis_templates[0].analysis_parameters[0].name #=> String
|
432
|
+
# 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"
|
433
|
+
# resp.collaboration_analysis_templates[0].analysis_parameters[0].default_value #=> String
|
434
|
+
# resp.errors #=> Array
|
435
|
+
# resp.errors[0].arn #=> String
|
436
|
+
# resp.errors[0].code #=> String
|
437
|
+
# resp.errors[0].message #=> String
|
438
|
+
#
|
439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate AWS API Documentation
|
440
|
+
#
|
441
|
+
# @overload batch_get_collaboration_analysis_template(params = {})
|
442
|
+
# @param [Hash] params ({})
|
443
|
+
def batch_get_collaboration_analysis_template(params = {}, options = {})
|
444
|
+
req = build_request(:batch_get_collaboration_analysis_template, params)
|
445
|
+
req.send_request(options)
|
446
|
+
end
|
447
|
+
|
391
448
|
# Retrieves multiple schemas by their identifiers.
|
392
449
|
#
|
393
450
|
# @option params [required, String] :collaboration_identifier
|
@@ -419,7 +476,7 @@ module Aws::CleanRooms
|
|
419
476
|
# resp.schemas[0].partition_keys[0].name #=> String
|
420
477
|
# resp.schemas[0].partition_keys[0].type #=> String
|
421
478
|
# resp.schemas[0].analysis_rule_types #=> Array
|
422
|
-
# resp.schemas[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
479
|
+
# resp.schemas[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
423
480
|
# resp.schemas[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
424
481
|
# resp.schemas[0].creator_account_id #=> String
|
425
482
|
# resp.schemas[0].name #=> String
|
@@ -443,6 +500,89 @@ module Aws::CleanRooms
|
|
443
500
|
req.send_request(options)
|
444
501
|
end
|
445
502
|
|
503
|
+
# Creates a new analysis template.
|
504
|
+
#
|
505
|
+
# @option params [String] :description
|
506
|
+
# The description of the analysis template.
|
507
|
+
#
|
508
|
+
# @option params [required, String] :membership_identifier
|
509
|
+
# The identifier for a membership resource.
|
510
|
+
#
|
511
|
+
# @option params [required, String] :name
|
512
|
+
# The name of the analysis template.
|
513
|
+
#
|
514
|
+
# @option params [required, String] :format
|
515
|
+
# The format of the analysis template.
|
516
|
+
#
|
517
|
+
# @option params [required, Types::AnalysisSource] :source
|
518
|
+
# The information in the analysis template. Currently supports `text`,
|
519
|
+
# the query text for the analysis template.
|
520
|
+
#
|
521
|
+
# @option params [Hash<String,String>] :tags
|
522
|
+
# An optional label that you can assign to a resource when you create
|
523
|
+
# it. Each tag consists of a key and an optional value, both of which
|
524
|
+
# you define. When you use tagging, you can also use tag-based access
|
525
|
+
# control in IAM policies to control access to this resource.
|
526
|
+
#
|
527
|
+
# @option params [Array<Types::AnalysisParameter>] :analysis_parameters
|
528
|
+
# The parameters of the analysis template.
|
529
|
+
#
|
530
|
+
# @return [Types::CreateAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
531
|
+
#
|
532
|
+
# * {Types::CreateAnalysisTemplateOutput#analysis_template #analysis_template} => Types::AnalysisTemplate
|
533
|
+
#
|
534
|
+
# @example Request syntax with placeholder values
|
535
|
+
#
|
536
|
+
# resp = client.create_analysis_template({
|
537
|
+
# description: "ResourceDescription",
|
538
|
+
# membership_identifier: "MembershipIdentifier", # required
|
539
|
+
# name: "TableAlias", # required
|
540
|
+
# format: "SQL", # required, accepts SQL
|
541
|
+
# source: { # required
|
542
|
+
# text: "AnalysisTemplateText",
|
543
|
+
# },
|
544
|
+
# tags: {
|
545
|
+
# "TagKey" => "TagValue",
|
546
|
+
# },
|
547
|
+
# analysis_parameters: [
|
548
|
+
# {
|
549
|
+
# name: "ParameterName", # required
|
550
|
+
# type: "SMALLINT", # required, accepts SMALLINT, INTEGER, BIGINT, DECIMAL, REAL, DOUBLE_PRECISION, BOOLEAN, CHAR, VARCHAR, DATE, TIMESTAMP, TIMESTAMPTZ, TIME, TIMETZ, VARBYTE
|
551
|
+
# default_value: "ParameterValue",
|
552
|
+
# },
|
553
|
+
# ],
|
554
|
+
# })
|
555
|
+
#
|
556
|
+
# @example Response structure
|
557
|
+
#
|
558
|
+
# resp.analysis_template.id #=> String
|
559
|
+
# resp.analysis_template.arn #=> String
|
560
|
+
# resp.analysis_template.collaboration_id #=> String
|
561
|
+
# resp.analysis_template.collaboration_arn #=> String
|
562
|
+
# resp.analysis_template.membership_id #=> String
|
563
|
+
# resp.analysis_template.membership_arn #=> String
|
564
|
+
# resp.analysis_template.description #=> String
|
565
|
+
# resp.analysis_template.name #=> String
|
566
|
+
# resp.analysis_template.create_time #=> Time
|
567
|
+
# resp.analysis_template.update_time #=> Time
|
568
|
+
# resp.analysis_template.schema.referenced_tables #=> Array
|
569
|
+
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
570
|
+
# resp.analysis_template.format #=> String, one of "SQL"
|
571
|
+
# resp.analysis_template.source.text #=> String
|
572
|
+
# resp.analysis_template.analysis_parameters #=> Array
|
573
|
+
# resp.analysis_template.analysis_parameters[0].name #=> String
|
574
|
+
# 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"
|
575
|
+
# resp.analysis_template.analysis_parameters[0].default_value #=> String
|
576
|
+
#
|
577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateAnalysisTemplate AWS API Documentation
|
578
|
+
#
|
579
|
+
# @overload create_analysis_template(params = {})
|
580
|
+
# @param [Hash] params ({})
|
581
|
+
def create_analysis_template(params = {}, options = {})
|
582
|
+
req = build_request(:create_analysis_template, params)
|
583
|
+
req.send_request(options)
|
584
|
+
end
|
585
|
+
|
446
586
|
# Creates a new collaboration.
|
447
587
|
#
|
448
588
|
# @option params [required, Array<Types::MemberSpecification>] :members
|
@@ -592,7 +732,7 @@ module Aws::CleanRooms
|
|
592
732
|
# resp.configured_table.create_time #=> Time
|
593
733
|
# resp.configured_table.update_time #=> Time
|
594
734
|
# resp.configured_table.analysis_rule_types #=> Array
|
595
|
-
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
735
|
+
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
596
736
|
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
597
737
|
# resp.configured_table.allowed_columns #=> Array
|
598
738
|
# resp.configured_table.allowed_columns[0] #=> String
|
@@ -614,7 +754,7 @@ module Aws::CleanRooms
|
|
614
754
|
# for. Currently accepts the configured table ID.
|
615
755
|
#
|
616
756
|
# @option params [required, String] :analysis_rule_type
|
617
|
-
# The type of analysis rule.
|
757
|
+
# The type of analysis rule.
|
618
758
|
#
|
619
759
|
# @option params [required, Types::ConfiguredTableAnalysisRulePolicy] :analysis_rule_policy
|
620
760
|
# The entire created configured table analysis rule object.
|
@@ -627,7 +767,7 @@ module Aws::CleanRooms
|
|
627
767
|
#
|
628
768
|
# resp = client.create_configured_table_analysis_rule({
|
629
769
|
# configured_table_identifier: "ConfiguredTableIdentifier", # required
|
630
|
-
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
|
770
|
+
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
|
631
771
|
# analysis_rule_policy: { # required
|
632
772
|
# v1: {
|
633
773
|
# list: {
|
@@ -655,6 +795,10 @@ module Aws::CleanRooms
|
|
655
795
|
# },
|
656
796
|
# ],
|
657
797
|
# },
|
798
|
+
# custom: {
|
799
|
+
# allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"], # required
|
800
|
+
# allowed_analysis_providers: ["AccountId"],
|
801
|
+
# },
|
658
802
|
# },
|
659
803
|
# },
|
660
804
|
# })
|
@@ -686,7 +830,11 @@ module Aws::CleanRooms
|
|
686
830
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
|
687
831
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
688
832
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
689
|
-
# resp.analysis_rule.
|
833
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
|
834
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
|
835
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
|
836
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
|
837
|
+
# resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
690
838
|
# resp.analysis_rule.create_time #=> Time
|
691
839
|
# resp.analysis_rule.update_time #=> Time
|
692
840
|
#
|
@@ -784,6 +932,10 @@ module Aws::CleanRooms
|
|
784
932
|
# you define. When you use tagging, you can also use tag-based access
|
785
933
|
# control in IAM policies to control access to this resource.
|
786
934
|
#
|
935
|
+
# @option params [Types::MembershipProtectedQueryResultConfiguration] :default_result_configuration
|
936
|
+
# The default protected query result configuration as specified by the
|
937
|
+
# member who can receive results.
|
938
|
+
#
|
787
939
|
# @return [Types::CreateMembershipOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
788
940
|
#
|
789
941
|
# * {Types::CreateMembershipOutput#membership #membership} => Types::Membership
|
@@ -796,6 +948,16 @@ module Aws::CleanRooms
|
|
796
948
|
# tags: {
|
797
949
|
# "TagKey" => "TagValue",
|
798
950
|
# },
|
951
|
+
# default_result_configuration: {
|
952
|
+
# output_configuration: { # required
|
953
|
+
# s3: {
|
954
|
+
# result_format: "CSV", # required, accepts CSV, PARQUET
|
955
|
+
# bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
|
956
|
+
# key_prefix: "KeyPrefix",
|
957
|
+
# },
|
958
|
+
# },
|
959
|
+
# role_arn: "RoleArn",
|
960
|
+
# },
|
799
961
|
# })
|
800
962
|
#
|
801
963
|
# @example Response structure
|
@@ -813,6 +975,10 @@ module Aws::CleanRooms
|
|
813
975
|
# resp.membership.member_abilities #=> Array
|
814
976
|
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
815
977
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
978
|
+
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
979
|
+
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
980
|
+
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
981
|
+
# resp.membership.default_result_configuration.role_arn #=> String
|
816
982
|
#
|
817
983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/CreateMembership AWS API Documentation
|
818
984
|
#
|
@@ -823,6 +989,32 @@ module Aws::CleanRooms
|
|
823
989
|
req.send_request(options)
|
824
990
|
end
|
825
991
|
|
992
|
+
# Deletes an analysis template.
|
993
|
+
#
|
994
|
+
# @option params [required, String] :membership_identifier
|
995
|
+
# The identifier for a membership resource.
|
996
|
+
#
|
997
|
+
# @option params [required, String] :analysis_template_identifier
|
998
|
+
# The identifier for the analysis template resource.
|
999
|
+
#
|
1000
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1001
|
+
#
|
1002
|
+
# @example Request syntax with placeholder values
|
1003
|
+
#
|
1004
|
+
# resp = client.delete_analysis_template({
|
1005
|
+
# membership_identifier: "MembershipIdentifier", # required
|
1006
|
+
# analysis_template_identifier: "AnalysisTemplateIdentifier", # required
|
1007
|
+
# })
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteAnalysisTemplate AWS API Documentation
|
1010
|
+
#
|
1011
|
+
# @overload delete_analysis_template(params = {})
|
1012
|
+
# @param [Hash] params ({})
|
1013
|
+
def delete_analysis_template(params = {}, options = {})
|
1014
|
+
req = build_request(:delete_analysis_template, params)
|
1015
|
+
req.send_request(options)
|
1016
|
+
end
|
1017
|
+
|
826
1018
|
# Deletes a collaboration. It can only be called by the collaboration
|
827
1019
|
# owner.
|
828
1020
|
#
|
@@ -885,7 +1077,7 @@ module Aws::CleanRooms
|
|
885
1077
|
#
|
886
1078
|
# resp = client.delete_configured_table_analysis_rule({
|
887
1079
|
# configured_table_identifier: "ConfiguredTableIdentifier", # required
|
888
|
-
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
|
1080
|
+
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
|
889
1081
|
# })
|
890
1082
|
#
|
891
1083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule AWS API Documentation
|
@@ -977,6 +1169,55 @@ module Aws::CleanRooms
|
|
977
1169
|
req.send_request(options)
|
978
1170
|
end
|
979
1171
|
|
1172
|
+
# Retrieves an analysis template.
|
1173
|
+
#
|
1174
|
+
# @option params [required, String] :membership_identifier
|
1175
|
+
# The identifier for a membership resource.
|
1176
|
+
#
|
1177
|
+
# @option params [required, String] :analysis_template_identifier
|
1178
|
+
# The identifier for the analysis template resource.
|
1179
|
+
#
|
1180
|
+
# @return [Types::GetAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1181
|
+
#
|
1182
|
+
# * {Types::GetAnalysisTemplateOutput#analysis_template #analysis_template} => Types::AnalysisTemplate
|
1183
|
+
#
|
1184
|
+
# @example Request syntax with placeholder values
|
1185
|
+
#
|
1186
|
+
# resp = client.get_analysis_template({
|
1187
|
+
# membership_identifier: "MembershipIdentifier", # required
|
1188
|
+
# analysis_template_identifier: "AnalysisTemplateIdentifier", # required
|
1189
|
+
# })
|
1190
|
+
#
|
1191
|
+
# @example Response structure
|
1192
|
+
#
|
1193
|
+
# resp.analysis_template.id #=> String
|
1194
|
+
# resp.analysis_template.arn #=> String
|
1195
|
+
# resp.analysis_template.collaboration_id #=> String
|
1196
|
+
# resp.analysis_template.collaboration_arn #=> String
|
1197
|
+
# resp.analysis_template.membership_id #=> String
|
1198
|
+
# resp.analysis_template.membership_arn #=> String
|
1199
|
+
# resp.analysis_template.description #=> String
|
1200
|
+
# resp.analysis_template.name #=> String
|
1201
|
+
# resp.analysis_template.create_time #=> Time
|
1202
|
+
# resp.analysis_template.update_time #=> Time
|
1203
|
+
# resp.analysis_template.schema.referenced_tables #=> Array
|
1204
|
+
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
1205
|
+
# resp.analysis_template.format #=> String, one of "SQL"
|
1206
|
+
# resp.analysis_template.source.text #=> String
|
1207
|
+
# resp.analysis_template.analysis_parameters #=> Array
|
1208
|
+
# resp.analysis_template.analysis_parameters[0].name #=> String
|
1209
|
+
# 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"
|
1210
|
+
# resp.analysis_template.analysis_parameters[0].default_value #=> String
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetAnalysisTemplate AWS API Documentation
|
1213
|
+
#
|
1214
|
+
# @overload get_analysis_template(params = {})
|
1215
|
+
# @param [Hash] params ({})
|
1216
|
+
def get_analysis_template(params = {}, options = {})
|
1217
|
+
req = build_request(:get_analysis_template, params)
|
1218
|
+
req.send_request(options)
|
1219
|
+
end
|
1220
|
+
|
980
1221
|
# Returns metadata about a collaboration.
|
981
1222
|
#
|
982
1223
|
# @option params [required, String] :collaboration_identifier
|
@@ -1020,6 +1261,56 @@ module Aws::CleanRooms
|
|
1020
1261
|
req.send_request(options)
|
1021
1262
|
end
|
1022
1263
|
|
1264
|
+
# Retrieves an analysis template within a collaboration.
|
1265
|
+
#
|
1266
|
+
# @option params [required, String] :collaboration_identifier
|
1267
|
+
# A unique identifier for the collaboration that the analysis templates
|
1268
|
+
# belong to. Currently accepts collaboration ID.
|
1269
|
+
#
|
1270
|
+
# @option params [required, String] :analysis_template_arn
|
1271
|
+
# The Amazon Resource Name (ARN) associated with the analysis template
|
1272
|
+
# within a collaboration.
|
1273
|
+
#
|
1274
|
+
# @return [Types::GetCollaborationAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1275
|
+
#
|
1276
|
+
# * {Types::GetCollaborationAnalysisTemplateOutput#collaboration_analysis_template #collaboration_analysis_template} => Types::CollaborationAnalysisTemplate
|
1277
|
+
#
|
1278
|
+
# @example Request syntax with placeholder values
|
1279
|
+
#
|
1280
|
+
# resp = client.get_collaboration_analysis_template({
|
1281
|
+
# collaboration_identifier: "CollaborationIdentifier", # required
|
1282
|
+
# analysis_template_arn: "AnalysisTemplateArn", # required
|
1283
|
+
# })
|
1284
|
+
#
|
1285
|
+
# @example Response structure
|
1286
|
+
#
|
1287
|
+
# resp.collaboration_analysis_template.id #=> String
|
1288
|
+
# resp.collaboration_analysis_template.arn #=> String
|
1289
|
+
# resp.collaboration_analysis_template.collaboration_id #=> String
|
1290
|
+
# resp.collaboration_analysis_template.collaboration_arn #=> String
|
1291
|
+
# resp.collaboration_analysis_template.description #=> String
|
1292
|
+
# resp.collaboration_analysis_template.creator_account_id #=> String
|
1293
|
+
# resp.collaboration_analysis_template.name #=> String
|
1294
|
+
# resp.collaboration_analysis_template.create_time #=> Time
|
1295
|
+
# resp.collaboration_analysis_template.update_time #=> Time
|
1296
|
+
# resp.collaboration_analysis_template.schema.referenced_tables #=> Array
|
1297
|
+
# resp.collaboration_analysis_template.schema.referenced_tables[0] #=> String
|
1298
|
+
# resp.collaboration_analysis_template.format #=> String, one of "SQL"
|
1299
|
+
# resp.collaboration_analysis_template.source.text #=> String
|
1300
|
+
# resp.collaboration_analysis_template.analysis_parameters #=> Array
|
1301
|
+
# resp.collaboration_analysis_template.analysis_parameters[0].name #=> String
|
1302
|
+
# 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"
|
1303
|
+
# resp.collaboration_analysis_template.analysis_parameters[0].default_value #=> String
|
1304
|
+
#
|
1305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate AWS API Documentation
|
1306
|
+
#
|
1307
|
+
# @overload get_collaboration_analysis_template(params = {})
|
1308
|
+
# @param [Hash] params ({})
|
1309
|
+
def get_collaboration_analysis_template(params = {}, options = {})
|
1310
|
+
req = build_request(:get_collaboration_analysis_template, params)
|
1311
|
+
req.send_request(options)
|
1312
|
+
end
|
1313
|
+
|
1023
1314
|
# Retrieves a configured table.
|
1024
1315
|
#
|
1025
1316
|
# @option params [required, String] :configured_table_identifier
|
@@ -1046,7 +1337,7 @@ module Aws::CleanRooms
|
|
1046
1337
|
# resp.configured_table.create_time #=> Time
|
1047
1338
|
# resp.configured_table.update_time #=> Time
|
1048
1339
|
# resp.configured_table.analysis_rule_types #=> Array
|
1049
|
-
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
1340
|
+
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1050
1341
|
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
1051
1342
|
# resp.configured_table.allowed_columns #=> Array
|
1052
1343
|
# resp.configured_table.allowed_columns[0] #=> String
|
@@ -1079,7 +1370,7 @@ module Aws::CleanRooms
|
|
1079
1370
|
#
|
1080
1371
|
# resp = client.get_configured_table_analysis_rule({
|
1081
1372
|
# configured_table_identifier: "ConfiguredTableIdentifier", # required
|
1082
|
-
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
|
1373
|
+
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
|
1083
1374
|
# })
|
1084
1375
|
#
|
1085
1376
|
# @example Response structure
|
@@ -1109,7 +1400,11 @@ module Aws::CleanRooms
|
|
1109
1400
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
|
1110
1401
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
1111
1402
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
1112
|
-
# resp.analysis_rule.
|
1403
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
|
1404
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
|
1405
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
|
1406
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
|
1407
|
+
# resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1113
1408
|
# resp.analysis_rule.create_time #=> Time
|
1114
1409
|
# resp.analysis_rule.update_time #=> Time
|
1115
1410
|
#
|
@@ -1196,6 +1491,10 @@ module Aws::CleanRooms
|
|
1196
1491
|
# resp.membership.member_abilities #=> Array
|
1197
1492
|
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
1198
1493
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
1494
|
+
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
1495
|
+
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
1496
|
+
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
1497
|
+
# resp.membership.default_result_configuration.role_arn #=> String
|
1199
1498
|
#
|
1200
1499
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetMembership AWS API Documentation
|
1201
1500
|
#
|
@@ -1232,12 +1531,17 @@ module Aws::CleanRooms
|
|
1232
1531
|
# resp.protected_query.membership_arn #=> String
|
1233
1532
|
# resp.protected_query.create_time #=> Time
|
1234
1533
|
# resp.protected_query.sql_parameters.query_string #=> String
|
1534
|
+
# resp.protected_query.sql_parameters.analysis_template_arn #=> String
|
1535
|
+
# resp.protected_query.sql_parameters.parameters #=> Hash
|
1536
|
+
# resp.protected_query.sql_parameters.parameters["ParameterName"] #=> String
|
1235
1537
|
# resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
|
1236
1538
|
# resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
1237
1539
|
# resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
|
1238
1540
|
# resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
|
1239
1541
|
# resp.protected_query.statistics.total_duration_in_millis #=> Integer
|
1240
1542
|
# resp.protected_query.result.output.s3.location #=> String
|
1543
|
+
# resp.protected_query.result.output.member_list #=> Array
|
1544
|
+
# resp.protected_query.result.output.member_list[0].account_id #=> String
|
1241
1545
|
# resp.protected_query.error.message #=> String
|
1242
1546
|
# resp.protected_query.error.code #=> String
|
1243
1547
|
#
|
@@ -1279,7 +1583,7 @@ module Aws::CleanRooms
|
|
1279
1583
|
# resp.schema.partition_keys[0].name #=> String
|
1280
1584
|
# resp.schema.partition_keys[0].type #=> String
|
1281
1585
|
# resp.schema.analysis_rule_types #=> Array
|
1282
|
-
# resp.schema.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
1586
|
+
# resp.schema.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1283
1587
|
# resp.schema.analysis_method #=> String, one of "DIRECT_QUERY"
|
1284
1588
|
# resp.schema.creator_account_id #=> String
|
1285
1589
|
# resp.schema.name #=> String
|
@@ -1322,13 +1626,13 @@ module Aws::CleanRooms
|
|
1322
1626
|
# resp = client.get_schema_analysis_rule({
|
1323
1627
|
# collaboration_identifier: "CollaborationIdentifier", # required
|
1324
1628
|
# name: "TableAlias", # required
|
1325
|
-
# type: "AGGREGATION", # required, accepts AGGREGATION, LIST
|
1629
|
+
# type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
|
1326
1630
|
# })
|
1327
1631
|
#
|
1328
1632
|
# @example Response structure
|
1329
1633
|
#
|
1330
1634
|
# resp.analysis_rule.collaboration_id #=> String
|
1331
|
-
# resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST"
|
1635
|
+
# resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1332
1636
|
# resp.analysis_rule.name #=> String
|
1333
1637
|
# resp.analysis_rule.create_time #=> Time
|
1334
1638
|
# resp.analysis_rule.update_time #=> Time
|
@@ -1355,6 +1659,10 @@ module Aws::CleanRooms
|
|
1355
1659
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
|
1356
1660
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
1357
1661
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
1662
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
|
1663
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
|
1664
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
|
1665
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
|
1358
1666
|
#
|
1359
1667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetSchemaAnalysisRule AWS API Documentation
|
1360
1668
|
#
|
@@ -1365,6 +1673,108 @@ module Aws::CleanRooms
|
|
1365
1673
|
req.send_request(options)
|
1366
1674
|
end
|
1367
1675
|
|
1676
|
+
# Lists analysis templates that the caller owns.
|
1677
|
+
#
|
1678
|
+
# @option params [required, String] :membership_identifier
|
1679
|
+
# The identifier for a membership resource.
|
1680
|
+
#
|
1681
|
+
# @option params [String] :next_token
|
1682
|
+
# The token value retrieved from a previous call to access the next page
|
1683
|
+
# of results.
|
1684
|
+
#
|
1685
|
+
# @option params [Integer] :max_results
|
1686
|
+
# The maximum size of the results that is returned per call.
|
1687
|
+
#
|
1688
|
+
# @return [Types::ListAnalysisTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1689
|
+
#
|
1690
|
+
# * {Types::ListAnalysisTemplatesOutput#next_token #next_token} => String
|
1691
|
+
# * {Types::ListAnalysisTemplatesOutput#analysis_template_summaries #analysis_template_summaries} => Array<Types::AnalysisTemplateSummary>
|
1692
|
+
#
|
1693
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1694
|
+
#
|
1695
|
+
# @example Request syntax with placeholder values
|
1696
|
+
#
|
1697
|
+
# resp = client.list_analysis_templates({
|
1698
|
+
# membership_identifier: "MembershipIdentifier", # required
|
1699
|
+
# next_token: "PaginationToken",
|
1700
|
+
# max_results: 1,
|
1701
|
+
# })
|
1702
|
+
#
|
1703
|
+
# @example Response structure
|
1704
|
+
#
|
1705
|
+
# resp.next_token #=> String
|
1706
|
+
# resp.analysis_template_summaries #=> Array
|
1707
|
+
# resp.analysis_template_summaries[0].arn #=> String
|
1708
|
+
# resp.analysis_template_summaries[0].create_time #=> Time
|
1709
|
+
# resp.analysis_template_summaries[0].id #=> String
|
1710
|
+
# resp.analysis_template_summaries[0].name #=> String
|
1711
|
+
# resp.analysis_template_summaries[0].update_time #=> Time
|
1712
|
+
# resp.analysis_template_summaries[0].membership_arn #=> String
|
1713
|
+
# resp.analysis_template_summaries[0].membership_id #=> String
|
1714
|
+
# resp.analysis_template_summaries[0].collaboration_arn #=> String
|
1715
|
+
# resp.analysis_template_summaries[0].collaboration_id #=> String
|
1716
|
+
# resp.analysis_template_summaries[0].description #=> String
|
1717
|
+
#
|
1718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListAnalysisTemplates AWS API Documentation
|
1719
|
+
#
|
1720
|
+
# @overload list_analysis_templates(params = {})
|
1721
|
+
# @param [Hash] params ({})
|
1722
|
+
def list_analysis_templates(params = {}, options = {})
|
1723
|
+
req = build_request(:list_analysis_templates, params)
|
1724
|
+
req.send_request(options)
|
1725
|
+
end
|
1726
|
+
|
1727
|
+
# Lists analysis templates within a collaboration.
|
1728
|
+
#
|
1729
|
+
# @option params [required, String] :collaboration_identifier
|
1730
|
+
# A unique identifier for the collaboration that the analysis templates
|
1731
|
+
# belong to. Currently accepts collaboration ID.
|
1732
|
+
#
|
1733
|
+
# @option params [String] :next_token
|
1734
|
+
# The token value retrieved from a previous call to access the next page
|
1735
|
+
# of results.
|
1736
|
+
#
|
1737
|
+
# @option params [Integer] :max_results
|
1738
|
+
# The maximum size of the results that is returned per call.
|
1739
|
+
#
|
1740
|
+
# @return [Types::ListCollaborationAnalysisTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1741
|
+
#
|
1742
|
+
# * {Types::ListCollaborationAnalysisTemplatesOutput#next_token #next_token} => String
|
1743
|
+
# * {Types::ListCollaborationAnalysisTemplatesOutput#collaboration_analysis_template_summaries #collaboration_analysis_template_summaries} => Array<Types::CollaborationAnalysisTemplateSummary>
|
1744
|
+
#
|
1745
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1746
|
+
#
|
1747
|
+
# @example Request syntax with placeholder values
|
1748
|
+
#
|
1749
|
+
# resp = client.list_collaboration_analysis_templates({
|
1750
|
+
# collaboration_identifier: "CollaborationIdentifier", # required
|
1751
|
+
# next_token: "PaginationToken",
|
1752
|
+
# max_results: 1,
|
1753
|
+
# })
|
1754
|
+
#
|
1755
|
+
# @example Response structure
|
1756
|
+
#
|
1757
|
+
# resp.next_token #=> String
|
1758
|
+
# resp.collaboration_analysis_template_summaries #=> Array
|
1759
|
+
# resp.collaboration_analysis_template_summaries[0].arn #=> String
|
1760
|
+
# resp.collaboration_analysis_template_summaries[0].create_time #=> Time
|
1761
|
+
# resp.collaboration_analysis_template_summaries[0].id #=> String
|
1762
|
+
# resp.collaboration_analysis_template_summaries[0].name #=> String
|
1763
|
+
# resp.collaboration_analysis_template_summaries[0].update_time #=> Time
|
1764
|
+
# resp.collaboration_analysis_template_summaries[0].collaboration_arn #=> String
|
1765
|
+
# resp.collaboration_analysis_template_summaries[0].collaboration_id #=> String
|
1766
|
+
# resp.collaboration_analysis_template_summaries[0].creator_account_id #=> String
|
1767
|
+
# resp.collaboration_analysis_template_summaries[0].description #=> String
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates AWS API Documentation
|
1770
|
+
#
|
1771
|
+
# @overload list_collaboration_analysis_templates(params = {})
|
1772
|
+
# @param [Hash] params ({})
|
1773
|
+
def list_collaboration_analysis_templates(params = {}, options = {})
|
1774
|
+
req = build_request(:list_collaboration_analysis_templates, params)
|
1775
|
+
req.send_request(options)
|
1776
|
+
end
|
1777
|
+
|
1368
1778
|
# Lists collaborations the caller owns, is active in, or has been
|
1369
1779
|
# invited to.
|
1370
1780
|
#
|
@@ -1501,7 +1911,7 @@ module Aws::CleanRooms
|
|
1501
1911
|
# resp.configured_table_summaries[0].create_time #=> Time
|
1502
1912
|
# resp.configured_table_summaries[0].update_time #=> Time
|
1503
1913
|
# resp.configured_table_summaries[0].analysis_rule_types #=> Array
|
1504
|
-
# resp.configured_table_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
1914
|
+
# resp.configured_table_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1505
1915
|
# resp.configured_table_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
1506
1916
|
# resp.next_token #=> String
|
1507
1917
|
#
|
@@ -1713,7 +2123,7 @@ module Aws::CleanRooms
|
|
1713
2123
|
# resp.schema_summaries[0].collaboration_id #=> String
|
1714
2124
|
# resp.schema_summaries[0].collaboration_arn #=> String
|
1715
2125
|
# resp.schema_summaries[0].analysis_rule_types #=> Array
|
1716
|
-
# resp.schema_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
2126
|
+
# resp.schema_summaries[0].analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1717
2127
|
# resp.schema_summaries[0].analysis_method #=> String, one of "DIRECT_QUERY"
|
1718
2128
|
# resp.next_token #=> String
|
1719
2129
|
#
|
@@ -1756,7 +2166,7 @@ module Aws::CleanRooms
|
|
1756
2166
|
req.send_request(options)
|
1757
2167
|
end
|
1758
2168
|
|
1759
|
-
# Creates a protected query that is started by Clean Rooms
|
2169
|
+
# Creates a protected query that is started by Clean Rooms.
|
1760
2170
|
#
|
1761
2171
|
# @option params [required, String] :type
|
1762
2172
|
# The type of the protected query to be started.
|
@@ -1768,7 +2178,7 @@ module Aws::CleanRooms
|
|
1768
2178
|
# @option params [required, Types::ProtectedQuerySQLParameters] :sql_parameters
|
1769
2179
|
# The protected SQL query parameters.
|
1770
2180
|
#
|
1771
|
-
# @option params [
|
2181
|
+
# @option params [Types::ProtectedQueryResultConfiguration] :result_configuration
|
1772
2182
|
# The details needed to write the query results.
|
1773
2183
|
#
|
1774
2184
|
# @return [Types::StartProtectedQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1782,8 +2192,12 @@ module Aws::CleanRooms
|
|
1782
2192
|
# membership_identifier: "MembershipIdentifier", # required
|
1783
2193
|
# sql_parameters: { # required
|
1784
2194
|
# query_string: "ProtectedQuerySQLParametersQueryStringString",
|
2195
|
+
# analysis_template_arn: "AnalysisTemplateArn",
|
2196
|
+
# parameters: {
|
2197
|
+
# "ParameterName" => "ParameterValue",
|
2198
|
+
# },
|
1785
2199
|
# },
|
1786
|
-
# result_configuration: {
|
2200
|
+
# result_configuration: {
|
1787
2201
|
# output_configuration: { # required
|
1788
2202
|
# s3: {
|
1789
2203
|
# result_format: "CSV", # required, accepts CSV, PARQUET
|
@@ -1801,12 +2215,17 @@ module Aws::CleanRooms
|
|
1801
2215
|
# resp.protected_query.membership_arn #=> String
|
1802
2216
|
# resp.protected_query.create_time #=> Time
|
1803
2217
|
# resp.protected_query.sql_parameters.query_string #=> String
|
2218
|
+
# resp.protected_query.sql_parameters.analysis_template_arn #=> String
|
2219
|
+
# resp.protected_query.sql_parameters.parameters #=> Hash
|
2220
|
+
# resp.protected_query.sql_parameters.parameters["ParameterName"] #=> String
|
1804
2221
|
# resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
|
1805
2222
|
# resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
1806
2223
|
# resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
|
1807
2224
|
# resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
|
1808
2225
|
# resp.protected_query.statistics.total_duration_in_millis #=> Integer
|
1809
2226
|
# resp.protected_query.result.output.s3.location #=> String
|
2227
|
+
# resp.protected_query.result.output.member_list #=> Array
|
2228
|
+
# resp.protected_query.result.output.member_list[0].account_id #=> String
|
1810
2229
|
# resp.protected_query.error.message #=> String
|
1811
2230
|
# resp.protected_query.error.code #=> String
|
1812
2231
|
#
|
@@ -1875,6 +2294,59 @@ module Aws::CleanRooms
|
|
1875
2294
|
req.send_request(options)
|
1876
2295
|
end
|
1877
2296
|
|
2297
|
+
# Updates the analysis template metadata.
|
2298
|
+
#
|
2299
|
+
# @option params [required, String] :membership_identifier
|
2300
|
+
# The identifier for a membership resource.
|
2301
|
+
#
|
2302
|
+
# @option params [required, String] :analysis_template_identifier
|
2303
|
+
# The identifier for the analysis template resource.
|
2304
|
+
#
|
2305
|
+
# @option params [String] :description
|
2306
|
+
# A new description for the analysis template.
|
2307
|
+
#
|
2308
|
+
# @return [Types::UpdateAnalysisTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2309
|
+
#
|
2310
|
+
# * {Types::UpdateAnalysisTemplateOutput#analysis_template #analysis_template} => Types::AnalysisTemplate
|
2311
|
+
#
|
2312
|
+
# @example Request syntax with placeholder values
|
2313
|
+
#
|
2314
|
+
# resp = client.update_analysis_template({
|
2315
|
+
# membership_identifier: "MembershipIdentifier", # required
|
2316
|
+
# analysis_template_identifier: "AnalysisTemplateIdentifier", # required
|
2317
|
+
# description: "ResourceDescription",
|
2318
|
+
# })
|
2319
|
+
#
|
2320
|
+
# @example Response structure
|
2321
|
+
#
|
2322
|
+
# resp.analysis_template.id #=> String
|
2323
|
+
# resp.analysis_template.arn #=> String
|
2324
|
+
# resp.analysis_template.collaboration_id #=> String
|
2325
|
+
# resp.analysis_template.collaboration_arn #=> String
|
2326
|
+
# resp.analysis_template.membership_id #=> String
|
2327
|
+
# resp.analysis_template.membership_arn #=> String
|
2328
|
+
# resp.analysis_template.description #=> String
|
2329
|
+
# resp.analysis_template.name #=> String
|
2330
|
+
# resp.analysis_template.create_time #=> Time
|
2331
|
+
# resp.analysis_template.update_time #=> Time
|
2332
|
+
# resp.analysis_template.schema.referenced_tables #=> Array
|
2333
|
+
# resp.analysis_template.schema.referenced_tables[0] #=> String
|
2334
|
+
# resp.analysis_template.format #=> String, one of "SQL"
|
2335
|
+
# resp.analysis_template.source.text #=> String
|
2336
|
+
# resp.analysis_template.analysis_parameters #=> Array
|
2337
|
+
# resp.analysis_template.analysis_parameters[0].name #=> String
|
2338
|
+
# 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"
|
2339
|
+
# resp.analysis_template.analysis_parameters[0].default_value #=> String
|
2340
|
+
#
|
2341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateAnalysisTemplate AWS API Documentation
|
2342
|
+
#
|
2343
|
+
# @overload update_analysis_template(params = {})
|
2344
|
+
# @param [Hash] params ({})
|
2345
|
+
def update_analysis_template(params = {}, options = {})
|
2346
|
+
req = build_request(:update_analysis_template, params)
|
2347
|
+
req.send_request(options)
|
2348
|
+
end
|
2349
|
+
|
1878
2350
|
# Updates collaboration metadata and can only be called by the
|
1879
2351
|
# collaboration owner.
|
1880
2352
|
#
|
@@ -1963,7 +2435,7 @@ module Aws::CleanRooms
|
|
1963
2435
|
# resp.configured_table.create_time #=> Time
|
1964
2436
|
# resp.configured_table.update_time #=> Time
|
1965
2437
|
# resp.configured_table.analysis_rule_types #=> Array
|
1966
|
-
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST"
|
2438
|
+
# resp.configured_table.analysis_rule_types[0] #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
1967
2439
|
# resp.configured_table.analysis_method #=> String, one of "DIRECT_QUERY"
|
1968
2440
|
# resp.configured_table.allowed_columns #=> Array
|
1969
2441
|
# resp.configured_table.allowed_columns[0] #=> String
|
@@ -1999,7 +2471,7 @@ module Aws::CleanRooms
|
|
1999
2471
|
#
|
2000
2472
|
# resp = client.update_configured_table_analysis_rule({
|
2001
2473
|
# configured_table_identifier: "ConfiguredTableIdentifier", # required
|
2002
|
-
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST
|
2474
|
+
# analysis_rule_type: "AGGREGATION", # required, accepts AGGREGATION, LIST, CUSTOM
|
2003
2475
|
# analysis_rule_policy: { # required
|
2004
2476
|
# v1: {
|
2005
2477
|
# list: {
|
@@ -2027,6 +2499,10 @@ module Aws::CleanRooms
|
|
2027
2499
|
# },
|
2028
2500
|
# ],
|
2029
2501
|
# },
|
2502
|
+
# custom: {
|
2503
|
+
# allowed_analyses: ["AnalysisTemplateArnOrQueryWildcard"], # required
|
2504
|
+
# allowed_analysis_providers: ["AccountId"],
|
2505
|
+
# },
|
2030
2506
|
# },
|
2031
2507
|
# },
|
2032
2508
|
# })
|
@@ -2058,7 +2534,11 @@ module Aws::CleanRooms
|
|
2058
2534
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].column_name #=> String
|
2059
2535
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].minimum #=> Integer
|
2060
2536
|
# resp.analysis_rule.policy.v1.aggregation.output_constraints[0].type #=> String, one of "COUNT_DISTINCT"
|
2061
|
-
# resp.analysis_rule.
|
2537
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses #=> Array
|
2538
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analyses[0] #=> String
|
2539
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers #=> Array
|
2540
|
+
# resp.analysis_rule.policy.v1.custom.allowed_analysis_providers[0] #=> String
|
2541
|
+
# resp.analysis_rule.type #=> String, one of "AGGREGATION", "LIST", "CUSTOM"
|
2062
2542
|
# resp.analysis_rule.create_time #=> Time
|
2063
2543
|
# resp.analysis_rule.update_time #=> Time
|
2064
2544
|
#
|
@@ -2133,6 +2613,10 @@ module Aws::CleanRooms
|
|
2133
2613
|
# An indicator as to whether query logging has been enabled or disabled
|
2134
2614
|
# for the collaboration.
|
2135
2615
|
#
|
2616
|
+
# @option params [Types::MembershipProtectedQueryResultConfiguration] :default_result_configuration
|
2617
|
+
# The default protected query result configuration as specified by the
|
2618
|
+
# member who can receive results.
|
2619
|
+
#
|
2136
2620
|
# @return [Types::UpdateMembershipOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2137
2621
|
#
|
2138
2622
|
# * {Types::UpdateMembershipOutput#membership #membership} => Types::Membership
|
@@ -2142,6 +2626,16 @@ module Aws::CleanRooms
|
|
2142
2626
|
# resp = client.update_membership({
|
2143
2627
|
# membership_identifier: "MembershipIdentifier", # required
|
2144
2628
|
# query_log_status: "ENABLED", # accepts ENABLED, DISABLED
|
2629
|
+
# default_result_configuration: {
|
2630
|
+
# output_configuration: { # required
|
2631
|
+
# s3: {
|
2632
|
+
# result_format: "CSV", # required, accepts CSV, PARQUET
|
2633
|
+
# bucket: "ProtectedQueryS3OutputConfigurationBucketString", # required
|
2634
|
+
# key_prefix: "KeyPrefix",
|
2635
|
+
# },
|
2636
|
+
# },
|
2637
|
+
# role_arn: "RoleArn",
|
2638
|
+
# },
|
2145
2639
|
# })
|
2146
2640
|
#
|
2147
2641
|
# @example Response structure
|
@@ -2159,6 +2653,10 @@ module Aws::CleanRooms
|
|
2159
2653
|
# resp.membership.member_abilities #=> Array
|
2160
2654
|
# resp.membership.member_abilities[0] #=> String, one of "CAN_QUERY", "CAN_RECEIVE_RESULTS"
|
2161
2655
|
# resp.membership.query_log_status #=> String, one of "ENABLED", "DISABLED"
|
2656
|
+
# resp.membership.default_result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
2657
|
+
# resp.membership.default_result_configuration.output_configuration.s3.bucket #=> String
|
2658
|
+
# resp.membership.default_result_configuration.output_configuration.s3.key_prefix #=> String
|
2659
|
+
# resp.membership.default_result_configuration.role_arn #=> String
|
2162
2660
|
#
|
2163
2661
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/UpdateMembership AWS API Documentation
|
2164
2662
|
#
|
@@ -2200,12 +2698,17 @@ module Aws::CleanRooms
|
|
2200
2698
|
# resp.protected_query.membership_arn #=> String
|
2201
2699
|
# resp.protected_query.create_time #=> Time
|
2202
2700
|
# resp.protected_query.sql_parameters.query_string #=> String
|
2701
|
+
# resp.protected_query.sql_parameters.analysis_template_arn #=> String
|
2702
|
+
# resp.protected_query.sql_parameters.parameters #=> Hash
|
2703
|
+
# resp.protected_query.sql_parameters.parameters["ParameterName"] #=> String
|
2203
2704
|
# resp.protected_query.status #=> String, one of "SUBMITTED", "STARTED", "CANCELLED", "CANCELLING", "FAILED", "SUCCESS", "TIMED_OUT"
|
2204
2705
|
# resp.protected_query.result_configuration.output_configuration.s3.result_format #=> String, one of "CSV", "PARQUET"
|
2205
2706
|
# resp.protected_query.result_configuration.output_configuration.s3.bucket #=> String
|
2206
2707
|
# resp.protected_query.result_configuration.output_configuration.s3.key_prefix #=> String
|
2207
2708
|
# resp.protected_query.statistics.total_duration_in_millis #=> Integer
|
2208
2709
|
# resp.protected_query.result.output.s3.location #=> String
|
2710
|
+
# resp.protected_query.result.output.member_list #=> Array
|
2711
|
+
# resp.protected_query.result.output.member_list[0].account_id #=> String
|
2209
2712
|
# resp.protected_query.error.message #=> String
|
2210
2713
|
# resp.protected_query.error.code #=> String
|
2211
2714
|
#
|
@@ -2231,7 +2734,7 @@ module Aws::CleanRooms
|
|
2231
2734
|
params: params,
|
2232
2735
|
config: config)
|
2233
2736
|
context[:gem_name] = 'aws-sdk-cleanrooms'
|
2234
|
-
context[:gem_version] = '1.
|
2737
|
+
context[:gem_version] = '1.10.0'
|
2235
2738
|
Seahorse::Client::Request.new(handlers, context)
|
2236
2739
|
end
|
2237
2740
|
|