aws-sdk-cleanroomsml 1.9.0 → 1.10.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-cleanroomsml/client.rb +265 -252
- data/lib/aws-sdk-cleanroomsml/client_api.rb +109 -92
- data/lib/aws-sdk-cleanroomsml/types.rb +513 -475
- data/lib/aws-sdk-cleanroomsml/waiters.rb +15 -0
- data/lib/aws-sdk-cleanroomsml.rb +2 -1
- data/sig/client.rbs +94 -88
- data/sig/types.rbs +100 -91
- metadata +5 -4
@@ -431,17 +431,24 @@ module Aws::CleanRoomsML
|
|
431
431
|
# and storing the audience model. The audience model can be used in
|
432
432
|
# multiple calls to the StartAudienceGenerationJob API.
|
433
433
|
#
|
434
|
-
# @option params [String] :
|
435
|
-
# The
|
434
|
+
# @option params [Time,DateTime,Date,Integer,String] :training_data_start_time
|
435
|
+
# The start date and time of the training window.
|
436
|
+
#
|
437
|
+
# @option params [Time,DateTime,Date,Integer,String] :training_data_end_time
|
438
|
+
# The end date and time of the training window.
|
439
|
+
#
|
440
|
+
# @option params [required, String] :name
|
441
|
+
# The name of the audience model resource.
|
442
|
+
#
|
443
|
+
# @option params [required, String] :training_dataset_arn
|
444
|
+
# The Amazon Resource Name (ARN) of the training dataset for this
|
445
|
+
# audience model.
|
436
446
|
#
|
437
447
|
# @option params [String] :kms_key_arn
|
438
448
|
# The Amazon Resource Name (ARN) of the KMS key. This key is used to
|
439
449
|
# encrypt and decrypt customer-owned data in the trained ML model and
|
440
450
|
# the associated data.
|
441
451
|
#
|
442
|
-
# @option params [required, String] :name
|
443
|
-
# The name of the audience model resource.
|
444
|
-
#
|
445
452
|
# @option params [Hash<String,String>] :tags
|
446
453
|
# The optional metadata that you apply to the resource to help you
|
447
454
|
# categorize and organize them. Each tag consists of a key and an
|
@@ -474,15 +481,8 @@ module Aws::CleanRoomsML
|
|
474
481
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
475
482
|
# against your tags per resource limit.
|
476
483
|
#
|
477
|
-
# @option params [
|
478
|
-
# The
|
479
|
-
#
|
480
|
-
# @option params [Time,DateTime,Date,Integer,String] :training_data_start_time
|
481
|
-
# The start date and time of the training window.
|
482
|
-
#
|
483
|
-
# @option params [required, String] :training_dataset_arn
|
484
|
-
# The Amazon Resource Name (ARN) of the training dataset for this
|
485
|
-
# audience model.
|
484
|
+
# @option params [String] :description
|
485
|
+
# The description of the audience model.
|
486
486
|
#
|
487
487
|
# @return [Types::CreateAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
488
488
|
#
|
@@ -491,15 +491,15 @@ module Aws::CleanRoomsML
|
|
491
491
|
# @example Request syntax with placeholder values
|
492
492
|
#
|
493
493
|
# resp = client.create_audience_model({
|
494
|
-
#
|
495
|
-
#
|
494
|
+
# training_data_start_time: Time.now,
|
495
|
+
# training_data_end_time: Time.now,
|
496
496
|
# name: "NameString", # required
|
497
|
+
# training_dataset_arn: "TrainingDatasetArn", # required
|
498
|
+
# kms_key_arn: "KmsKeyArn",
|
497
499
|
# tags: {
|
498
500
|
# "TagKey" => "TagValue",
|
499
501
|
# },
|
500
|
-
#
|
501
|
-
# training_data_start_time: Time.now,
|
502
|
-
# training_dataset_arn: "TrainingDatasetArn", # required
|
502
|
+
# description: "ResourceDescription",
|
503
503
|
# })
|
504
504
|
#
|
505
505
|
# @example Response structure
|
@@ -518,43 +518,13 @@ module Aws::CleanRoomsML
|
|
518
518
|
# Defines the information necessary to create a configured audience
|
519
519
|
# model.
|
520
520
|
#
|
521
|
+
# @option params [required, String] :name
|
522
|
+
# The name of the configured audience model.
|
523
|
+
#
|
521
524
|
# @option params [required, String] :audience_model_arn
|
522
525
|
# The Amazon Resource Name (ARN) of the audience model to use for the
|
523
526
|
# configured audience model.
|
524
527
|
#
|
525
|
-
# @option params [Types::AudienceSizeConfig] :audience_size_config
|
526
|
-
# Configure the list of output sizes of audiences that can be created
|
527
|
-
# using this configured audience model. A request to
|
528
|
-
# StartAudienceGenerationJob that uses this configured audience model
|
529
|
-
# must have an `audienceSize` selected from this list. You can use the
|
530
|
-
# `ABSOLUTE` AudienceSize to configure out audience sizes using the
|
531
|
-
# count of identifiers in the output. You can use the `Percentage`
|
532
|
-
# AudienceSize to configure sizes in the range 1-100 percent.
|
533
|
-
#
|
534
|
-
# @option params [String] :child_resource_tag_on_create_policy
|
535
|
-
# Configure how the service tags audience generation jobs created using
|
536
|
-
# this configured audience model. If you specify `NONE`, the tags from
|
537
|
-
# the StartAudienceGenerationJob request determine the tags of the
|
538
|
-
# audience generation job. If you specify `FROM_PARENT_RESOURCE`, the
|
539
|
-
# audience generation job inherits the tags from the configured audience
|
540
|
-
# model, by default. Tags in the StartAudienceGenerationJob will
|
541
|
-
# override the default.
|
542
|
-
#
|
543
|
-
# When the client is in a different account than the configured audience
|
544
|
-
# model, the tags from the client are never applied to a resource in the
|
545
|
-
# caller's account.
|
546
|
-
#
|
547
|
-
# @option params [String] :description
|
548
|
-
# The description of the configured audience model.
|
549
|
-
#
|
550
|
-
# @option params [Integer] :min_matching_seed_size
|
551
|
-
# The minimum number of users from the seed audience that must match
|
552
|
-
# with users in the training data of the audience model. The default
|
553
|
-
# value is 500.
|
554
|
-
#
|
555
|
-
# @option params [required, String] :name
|
556
|
-
# The name of the configured audience model.
|
557
|
-
#
|
558
528
|
# @option params [required, Types::ConfiguredAudienceModelOutputConfig] :output_config
|
559
529
|
# Configure the Amazon S3 location and IAM Role for audiences created
|
560
530
|
# using this configured audience model. Each audience will have a unique
|
@@ -563,9 +533,26 @@ module Aws::CleanRoomsML
|
|
563
533
|
# Amazon S3 KMS-SSE, then the Role must also have the required KMS
|
564
534
|
# permissions.
|
565
535
|
#
|
536
|
+
# @option params [String] :description
|
537
|
+
# The description of the configured audience model.
|
538
|
+
#
|
566
539
|
# @option params [required, Array<String>] :shared_audience_metrics
|
567
540
|
# Whether audience metrics are shared.
|
568
541
|
#
|
542
|
+
# @option params [Integer] :min_matching_seed_size
|
543
|
+
# The minimum number of users from the seed audience that must match
|
544
|
+
# with users in the training data of the audience model. The default
|
545
|
+
# value is 500.
|
546
|
+
#
|
547
|
+
# @option params [Types::AudienceSizeConfig] :audience_size_config
|
548
|
+
# Configure the list of output sizes of audiences that can be created
|
549
|
+
# using this configured audience model. A request to
|
550
|
+
# StartAudienceGenerationJob that uses this configured audience model
|
551
|
+
# must have an `audienceSize` selected from this list. You can use the
|
552
|
+
# `ABSOLUTE` AudienceSize to configure out audience sizes using the
|
553
|
+
# count of identifiers in the output. You can use the `Percentage`
|
554
|
+
# AudienceSize to configure sizes in the range 1-100 percent.
|
555
|
+
#
|
569
556
|
# @option params [Hash<String,String>] :tags
|
570
557
|
# The optional metadata that you apply to the resource to help you
|
571
558
|
# categorize and organize them. Each tag consists of a key and an
|
@@ -598,6 +585,19 @@ module Aws::CleanRoomsML
|
|
598
585
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
599
586
|
# against your tags per resource limit.
|
600
587
|
#
|
588
|
+
# @option params [String] :child_resource_tag_on_create_policy
|
589
|
+
# Configure how the service tags audience generation jobs created using
|
590
|
+
# this configured audience model. If you specify `NONE`, the tags from
|
591
|
+
# the StartAudienceGenerationJob request determine the tags of the
|
592
|
+
# audience generation job. If you specify `FROM_PARENT_RESOURCE`, the
|
593
|
+
# audience generation job inherits the tags from the configured audience
|
594
|
+
# model, by default. Tags in the StartAudienceGenerationJob will
|
595
|
+
# override the default.
|
596
|
+
#
|
597
|
+
# When the client is in a different account than the configured audience
|
598
|
+
# model, the tags from the client are never applied to a resource in the
|
599
|
+
# caller's account.
|
600
|
+
#
|
601
601
|
# @return [Types::CreateConfiguredAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
602
602
|
#
|
603
603
|
# * {Types::CreateConfiguredAudienceModelResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
@@ -605,15 +605,8 @@ module Aws::CleanRoomsML
|
|
605
605
|
# @example Request syntax with placeholder values
|
606
606
|
#
|
607
607
|
# resp = client.create_configured_audience_model({
|
608
|
-
# audience_model_arn: "AudienceModelArn", # required
|
609
|
-
# audience_size_config: {
|
610
|
-
# audience_size_bins: [1], # required
|
611
|
-
# audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
|
612
|
-
# },
|
613
|
-
# child_resource_tag_on_create_policy: "FROM_PARENT_RESOURCE", # accepts FROM_PARENT_RESOURCE, NONE
|
614
|
-
# description: "ResourceDescription",
|
615
|
-
# min_matching_seed_size: 1,
|
616
608
|
# name: "NameString", # required
|
609
|
+
# audience_model_arn: "AudienceModelArn", # required
|
617
610
|
# output_config: { # required
|
618
611
|
# destination: { # required
|
619
612
|
# s3_destination: { # required
|
@@ -622,10 +615,17 @@ module Aws::CleanRoomsML
|
|
622
615
|
# },
|
623
616
|
# role_arn: "IamRoleArn", # required
|
624
617
|
# },
|
618
|
+
# description: "ResourceDescription",
|
625
619
|
# shared_audience_metrics: ["ALL"], # required, accepts ALL, NONE
|
620
|
+
# min_matching_seed_size: 1,
|
621
|
+
# audience_size_config: {
|
622
|
+
# audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
|
623
|
+
# audience_size_bins: [1], # required
|
624
|
+
# },
|
626
625
|
# tags: {
|
627
626
|
# "TagKey" => "TagValue",
|
628
627
|
# },
|
628
|
+
# child_resource_tag_on_create_policy: "FROM_PARENT_RESOURCE", # accepts FROM_PARENT_RESOURCE, NONE
|
629
629
|
# })
|
630
630
|
#
|
631
631
|
# @example Response structure
|
@@ -645,9 +645,6 @@ module Aws::CleanRoomsML
|
|
645
645
|
# Clean Rooms ML, the `TrainingDataset` is metadata that points to a
|
646
646
|
# Glue table, which is read only during `AudienceModel` creation.
|
647
647
|
#
|
648
|
-
# @option params [String] :description
|
649
|
-
# The description of the training dataset.
|
650
|
-
#
|
651
648
|
# @option params [required, String] :name
|
652
649
|
# The name of the training dataset. This name must be unique in your
|
653
650
|
# account and region.
|
@@ -659,6 +656,11 @@ module Aws::CleanRoomsML
|
|
659
656
|
# Passing a role across AWS accounts is not allowed. If you pass a role
|
660
657
|
# that isn't in your account, you get an `AccessDeniedException` error.
|
661
658
|
#
|
659
|
+
# @option params [required, Array<Types::Dataset>] :training_data
|
660
|
+
# An array of information that lists the Dataset objects, which
|
661
|
+
# specifies the dataset type and details on its location and schema. You
|
662
|
+
# must provide a role that has read access to these tables.
|
663
|
+
#
|
662
664
|
# @option params [Hash<String,String>] :tags
|
663
665
|
# The optional metadata that you apply to the resource to help you
|
664
666
|
# categorize and organize them. Each tag consists of a key and an
|
@@ -691,10 +693,8 @@ module Aws::CleanRoomsML
|
|
691
693
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
692
694
|
# against your tags per resource limit.
|
693
695
|
#
|
694
|
-
# @option params [
|
695
|
-
#
|
696
|
-
# specifies the dataset type and details on its location and schema. You
|
697
|
-
# must provide a role that has read access to these tables.
|
696
|
+
# @option params [String] :description
|
697
|
+
# The description of the training dataset.
|
698
698
|
#
|
699
699
|
# @return [Types::CreateTrainingDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
700
700
|
#
|
@@ -703,32 +703,32 @@ module Aws::CleanRoomsML
|
|
703
703
|
# @example Request syntax with placeholder values
|
704
704
|
#
|
705
705
|
# resp = client.create_training_dataset({
|
706
|
-
# description: "ResourceDescription",
|
707
706
|
# name: "NameString", # required
|
708
707
|
# role_arn: "IamRoleArn", # required
|
709
|
-
# tags: {
|
710
|
-
# "TagKey" => "TagValue",
|
711
|
-
# },
|
712
708
|
# training_data: [ # required
|
713
709
|
# {
|
710
|
+
# type: "INTERACTIONS", # required, accepts INTERACTIONS
|
714
711
|
# input_config: { # required
|
715
|
-
# data_source: { # required
|
716
|
-
# glue_data_source: { # required
|
717
|
-
# catalog_id: "AccountId",
|
718
|
-
# database_name: "GlueDatabaseName", # required
|
719
|
-
# table_name: "GlueTableName", # required
|
720
|
-
# },
|
721
|
-
# },
|
722
712
|
# schema: [ # required
|
723
713
|
# {
|
724
714
|
# column_name: "ColumnName", # required
|
725
715
|
# column_types: ["USER_ID"], # required, accepts USER_ID, ITEM_ID, TIMESTAMP, CATEGORICAL_FEATURE, NUMERICAL_FEATURE
|
726
716
|
# },
|
727
717
|
# ],
|
718
|
+
# data_source: { # required
|
719
|
+
# glue_data_source: { # required
|
720
|
+
# table_name: "GlueTableName", # required
|
721
|
+
# database_name: "GlueDatabaseName", # required
|
722
|
+
# catalog_id: "AccountId",
|
723
|
+
# },
|
724
|
+
# },
|
728
725
|
# },
|
729
|
-
# type: "INTERACTIONS", # required, accepts INTERACTIONS
|
730
726
|
# },
|
731
727
|
# ],
|
728
|
+
# tags: {
|
729
|
+
# "TagKey" => "TagValue",
|
730
|
+
# },
|
731
|
+
# description: "ResourceDescription",
|
732
732
|
# })
|
733
733
|
#
|
734
734
|
# @example Response structure
|
@@ -878,20 +878,21 @@ module Aws::CleanRoomsML
|
|
878
878
|
#
|
879
879
|
# @return [Types::GetAudienceGenerationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
880
880
|
#
|
881
|
-
# * {Types::GetAudienceGenerationJobResponse#audience_generation_job_arn #audience_generation_job_arn} => String
|
882
|
-
# * {Types::GetAudienceGenerationJobResponse#collaboration_id #collaboration_id} => String
|
883
|
-
# * {Types::GetAudienceGenerationJobResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
884
881
|
# * {Types::GetAudienceGenerationJobResponse#create_time #create_time} => Time
|
882
|
+
# * {Types::GetAudienceGenerationJobResponse#update_time #update_time} => Time
|
883
|
+
# * {Types::GetAudienceGenerationJobResponse#audience_generation_job_arn #audience_generation_job_arn} => String
|
884
|
+
# * {Types::GetAudienceGenerationJobResponse#name #name} => String
|
885
885
|
# * {Types::GetAudienceGenerationJobResponse#description #description} => String
|
886
|
+
# * {Types::GetAudienceGenerationJobResponse#status #status} => String
|
887
|
+
# * {Types::GetAudienceGenerationJobResponse#status_details #status_details} => Types::StatusDetails
|
888
|
+
# * {Types::GetAudienceGenerationJobResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
889
|
+
# * {Types::GetAudienceGenerationJobResponse#seed_audience #seed_audience} => Types::AudienceGenerationJobDataSource
|
886
890
|
# * {Types::GetAudienceGenerationJobResponse#include_seed_in_output #include_seed_in_output} => Boolean
|
891
|
+
# * {Types::GetAudienceGenerationJobResponse#collaboration_id #collaboration_id} => String
|
887
892
|
# * {Types::GetAudienceGenerationJobResponse#metrics #metrics} => Types::AudienceQualityMetrics
|
888
|
-
# * {Types::GetAudienceGenerationJobResponse#name #name} => String
|
889
|
-
# * {Types::GetAudienceGenerationJobResponse#seed_audience #seed_audience} => Types::AudienceGenerationJobDataSource
|
890
893
|
# * {Types::GetAudienceGenerationJobResponse#started_by #started_by} => String
|
891
|
-
# * {Types::GetAudienceGenerationJobResponse#status #status} => String
|
892
|
-
# * {Types::GetAudienceGenerationJobResponse#status_details #status_details} => Types::StatusDetails
|
893
894
|
# * {Types::GetAudienceGenerationJobResponse#tags #tags} => Hash<String,String>
|
894
|
-
# * {Types::GetAudienceGenerationJobResponse#
|
895
|
+
# * {Types::GetAudienceGenerationJobResponse#protected_query_identifier #protected_query_identifier} => String
|
895
896
|
#
|
896
897
|
# @example Request syntax with placeholder values
|
897
898
|
#
|
@@ -901,27 +902,32 @@ module Aws::CleanRoomsML
|
|
901
902
|
#
|
902
903
|
# @example Response structure
|
903
904
|
#
|
904
|
-
# resp.audience_generation_job_arn #=> String
|
905
|
-
# resp.collaboration_id #=> String
|
906
|
-
# resp.configured_audience_model_arn #=> String
|
907
905
|
# resp.create_time #=> Time
|
906
|
+
# resp.update_time #=> Time
|
907
|
+
# resp.audience_generation_job_arn #=> String
|
908
|
+
# resp.name #=> String
|
908
909
|
# resp.description #=> String
|
910
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
911
|
+
# resp.status_details.status_code #=> String
|
912
|
+
# resp.status_details.message #=> String
|
913
|
+
# resp.configured_audience_model_arn #=> String
|
914
|
+
# resp.seed_audience.data_source.s3_uri #=> String
|
915
|
+
# resp.seed_audience.role_arn #=> String
|
916
|
+
# resp.seed_audience.sql_parameters.query_string #=> String
|
917
|
+
# resp.seed_audience.sql_parameters.analysis_template_arn #=> String
|
918
|
+
# resp.seed_audience.sql_parameters.parameters #=> Hash
|
919
|
+
# resp.seed_audience.sql_parameters.parameters["ParameterKey"] #=> String
|
909
920
|
# resp.include_seed_in_output #=> Boolean
|
910
|
-
# resp.
|
921
|
+
# resp.collaboration_id #=> String
|
911
922
|
# resp.metrics.relevance_metrics #=> Array
|
912
923
|
# resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
913
924
|
# resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
|
914
925
|
# resp.metrics.relevance_metrics[0].score #=> Float
|
915
|
-
# resp.
|
916
|
-
# resp.seed_audience.data_source.s3_uri #=> String
|
917
|
-
# resp.seed_audience.role_arn #=> String
|
926
|
+
# resp.metrics.recall_metric #=> Float
|
918
927
|
# resp.started_by #=> String
|
919
|
-
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
920
|
-
# resp.status_details.message #=> String
|
921
|
-
# resp.status_details.status_code #=> String
|
922
928
|
# resp.tags #=> Hash
|
923
929
|
# resp.tags["TagKey"] #=> String
|
924
|
-
# resp.
|
930
|
+
# resp.protected_query_identifier #=> String
|
925
931
|
#
|
926
932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJob AWS API Documentation
|
927
933
|
#
|
@@ -940,18 +946,18 @@ module Aws::CleanRoomsML
|
|
940
946
|
#
|
941
947
|
# @return [Types::GetAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
942
948
|
#
|
943
|
-
# * {Types::GetAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
944
949
|
# * {Types::GetAudienceModelResponse#create_time #create_time} => Time
|
945
|
-
# * {Types::GetAudienceModelResponse#
|
946
|
-
# * {Types::GetAudienceModelResponse#
|
950
|
+
# * {Types::GetAudienceModelResponse#update_time #update_time} => Time
|
951
|
+
# * {Types::GetAudienceModelResponse#training_data_start_time #training_data_start_time} => Time
|
952
|
+
# * {Types::GetAudienceModelResponse#training_data_end_time #training_data_end_time} => Time
|
953
|
+
# * {Types::GetAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
947
954
|
# * {Types::GetAudienceModelResponse#name #name} => String
|
955
|
+
# * {Types::GetAudienceModelResponse#training_dataset_arn #training_dataset_arn} => String
|
948
956
|
# * {Types::GetAudienceModelResponse#status #status} => String
|
949
957
|
# * {Types::GetAudienceModelResponse#status_details #status_details} => Types::StatusDetails
|
958
|
+
# * {Types::GetAudienceModelResponse#kms_key_arn #kms_key_arn} => String
|
950
959
|
# * {Types::GetAudienceModelResponse#tags #tags} => Hash<String,String>
|
951
|
-
# * {Types::GetAudienceModelResponse#
|
952
|
-
# * {Types::GetAudienceModelResponse#training_data_start_time #training_data_start_time} => Time
|
953
|
-
# * {Types::GetAudienceModelResponse#training_dataset_arn #training_dataset_arn} => String
|
954
|
-
# * {Types::GetAudienceModelResponse#update_time #update_time} => Time
|
960
|
+
# * {Types::GetAudienceModelResponse#description #description} => String
|
955
961
|
#
|
956
962
|
# @example Request syntax with placeholder values
|
957
963
|
#
|
@@ -961,20 +967,20 @@ module Aws::CleanRoomsML
|
|
961
967
|
#
|
962
968
|
# @example Response structure
|
963
969
|
#
|
964
|
-
# resp.audience_model_arn #=> String
|
965
970
|
# resp.create_time #=> Time
|
966
|
-
# resp.
|
967
|
-
# resp.
|
971
|
+
# resp.update_time #=> Time
|
972
|
+
# resp.training_data_start_time #=> Time
|
973
|
+
# resp.training_data_end_time #=> Time
|
974
|
+
# resp.audience_model_arn #=> String
|
968
975
|
# resp.name #=> String
|
976
|
+
# resp.training_dataset_arn #=> String
|
969
977
|
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
970
|
-
# resp.status_details.message #=> String
|
971
978
|
# resp.status_details.status_code #=> String
|
979
|
+
# resp.status_details.message #=> String
|
980
|
+
# resp.kms_key_arn #=> String
|
972
981
|
# resp.tags #=> Hash
|
973
982
|
# resp.tags["TagKey"] #=> String
|
974
|
-
# resp.
|
975
|
-
# resp.training_data_start_time #=> Time
|
976
|
-
# resp.training_dataset_arn #=> String
|
977
|
-
# resp.update_time #=> Time
|
983
|
+
# resp.description #=> String
|
978
984
|
#
|
979
985
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModel AWS API Documentation
|
980
986
|
#
|
@@ -993,19 +999,19 @@ module Aws::CleanRoomsML
|
|
993
999
|
#
|
994
1000
|
# @return [Types::GetConfiguredAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
995
1001
|
#
|
996
|
-
# * {Types::GetConfiguredAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
997
|
-
# * {Types::GetConfiguredAudienceModelResponse#audience_size_config #audience_size_config} => Types::AudienceSizeConfig
|
998
|
-
# * {Types::GetConfiguredAudienceModelResponse#child_resource_tag_on_create_policy #child_resource_tag_on_create_policy} => String
|
999
|
-
# * {Types::GetConfiguredAudienceModelResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
1000
1002
|
# * {Types::GetConfiguredAudienceModelResponse#create_time #create_time} => Time
|
1001
|
-
# * {Types::GetConfiguredAudienceModelResponse#
|
1002
|
-
# * {Types::GetConfiguredAudienceModelResponse#
|
1003
|
+
# * {Types::GetConfiguredAudienceModelResponse#update_time #update_time} => Time
|
1004
|
+
# * {Types::GetConfiguredAudienceModelResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
1003
1005
|
# * {Types::GetConfiguredAudienceModelResponse#name #name} => String
|
1006
|
+
# * {Types::GetConfiguredAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
1004
1007
|
# * {Types::GetConfiguredAudienceModelResponse#output_config #output_config} => Types::ConfiguredAudienceModelOutputConfig
|
1005
|
-
# * {Types::GetConfiguredAudienceModelResponse#
|
1008
|
+
# * {Types::GetConfiguredAudienceModelResponse#description #description} => String
|
1006
1009
|
# * {Types::GetConfiguredAudienceModelResponse#status #status} => String
|
1010
|
+
# * {Types::GetConfiguredAudienceModelResponse#shared_audience_metrics #shared_audience_metrics} => Array<String>
|
1011
|
+
# * {Types::GetConfiguredAudienceModelResponse#min_matching_seed_size #min_matching_seed_size} => Integer
|
1012
|
+
# * {Types::GetConfiguredAudienceModelResponse#audience_size_config #audience_size_config} => Types::AudienceSizeConfig
|
1007
1013
|
# * {Types::GetConfiguredAudienceModelResponse#tags #tags} => Hash<String,String>
|
1008
|
-
# * {Types::GetConfiguredAudienceModelResponse#
|
1014
|
+
# * {Types::GetConfiguredAudienceModelResponse#child_resource_tag_on_create_policy #child_resource_tag_on_create_policy} => String
|
1009
1015
|
#
|
1010
1016
|
# @example Request syntax with placeholder values
|
1011
1017
|
#
|
@@ -1015,24 +1021,24 @@ module Aws::CleanRoomsML
|
|
1015
1021
|
#
|
1016
1022
|
# @example Response structure
|
1017
1023
|
#
|
1018
|
-
# resp.audience_model_arn #=> String
|
1019
|
-
# resp.audience_size_config.audience_size_bins #=> Array
|
1020
|
-
# resp.audience_size_config.audience_size_bins[0] #=> Integer
|
1021
|
-
# resp.audience_size_config.audience_size_type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
1022
|
-
# resp.child_resource_tag_on_create_policy #=> String, one of "FROM_PARENT_RESOURCE", "NONE"
|
1023
|
-
# resp.configured_audience_model_arn #=> String
|
1024
1024
|
# resp.create_time #=> Time
|
1025
|
-
# resp.
|
1026
|
-
# resp.
|
1025
|
+
# resp.update_time #=> Time
|
1026
|
+
# resp.configured_audience_model_arn #=> String
|
1027
1027
|
# resp.name #=> String
|
1028
|
+
# resp.audience_model_arn #=> String
|
1028
1029
|
# resp.output_config.destination.s3_destination.s3_uri #=> String
|
1029
1030
|
# resp.output_config.role_arn #=> String
|
1031
|
+
# resp.description #=> String
|
1032
|
+
# resp.status #=> String, one of "ACTIVE"
|
1030
1033
|
# resp.shared_audience_metrics #=> Array
|
1031
1034
|
# resp.shared_audience_metrics[0] #=> String, one of "ALL", "NONE"
|
1032
|
-
# resp.
|
1035
|
+
# resp.min_matching_seed_size #=> Integer
|
1036
|
+
# resp.audience_size_config.audience_size_type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
1037
|
+
# resp.audience_size_config.audience_size_bins #=> Array
|
1038
|
+
# resp.audience_size_config.audience_size_bins[0] #=> Integer
|
1033
1039
|
# resp.tags #=> Hash
|
1034
1040
|
# resp.tags["TagKey"] #=> String
|
1035
|
-
# resp.
|
1041
|
+
# resp.child_resource_tag_on_create_policy #=> String, one of "FROM_PARENT_RESOURCE", "NONE"
|
1036
1042
|
#
|
1037
1043
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModel AWS API Documentation
|
1038
1044
|
#
|
@@ -1085,14 +1091,14 @@ module Aws::CleanRoomsML
|
|
1085
1091
|
# @return [Types::GetTrainingDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1086
1092
|
#
|
1087
1093
|
# * {Types::GetTrainingDatasetResponse#create_time #create_time} => Time
|
1088
|
-
# * {Types::GetTrainingDatasetResponse#
|
1094
|
+
# * {Types::GetTrainingDatasetResponse#update_time #update_time} => Time
|
1095
|
+
# * {Types::GetTrainingDatasetResponse#training_dataset_arn #training_dataset_arn} => String
|
1089
1096
|
# * {Types::GetTrainingDatasetResponse#name #name} => String
|
1090
|
-
# * {Types::GetTrainingDatasetResponse#
|
1097
|
+
# * {Types::GetTrainingDatasetResponse#training_data #training_data} => Array<Types::Dataset>
|
1091
1098
|
# * {Types::GetTrainingDatasetResponse#status #status} => String
|
1099
|
+
# * {Types::GetTrainingDatasetResponse#role_arn #role_arn} => String
|
1092
1100
|
# * {Types::GetTrainingDatasetResponse#tags #tags} => Hash<String,String>
|
1093
|
-
# * {Types::GetTrainingDatasetResponse#
|
1094
|
-
# * {Types::GetTrainingDatasetResponse#training_dataset_arn #training_dataset_arn} => String
|
1095
|
-
# * {Types::GetTrainingDatasetResponse#update_time #update_time} => Time
|
1101
|
+
# * {Types::GetTrainingDatasetResponse#description #description} => String
|
1096
1102
|
#
|
1097
1103
|
# @example Request syntax with placeholder values
|
1098
1104
|
#
|
@@ -1103,23 +1109,23 @@ module Aws::CleanRoomsML
|
|
1103
1109
|
# @example Response structure
|
1104
1110
|
#
|
1105
1111
|
# resp.create_time #=> Time
|
1106
|
-
# resp.
|
1112
|
+
# resp.update_time #=> Time
|
1113
|
+
# resp.training_dataset_arn #=> String
|
1107
1114
|
# resp.name #=> String
|
1108
|
-
# resp.role_arn #=> String
|
1109
|
-
# resp.status #=> String, one of "ACTIVE"
|
1110
|
-
# resp.tags #=> Hash
|
1111
|
-
# resp.tags["TagKey"] #=> String
|
1112
1115
|
# resp.training_data #=> Array
|
1113
|
-
# resp.training_data[0].
|
1114
|
-
# resp.training_data[0].input_config.data_source.glue_data_source.database_name #=> String
|
1115
|
-
# resp.training_data[0].input_config.data_source.glue_data_source.table_name #=> String
|
1116
|
+
# resp.training_data[0].type #=> String, one of "INTERACTIONS"
|
1116
1117
|
# resp.training_data[0].input_config.schema #=> Array
|
1117
1118
|
# resp.training_data[0].input_config.schema[0].column_name #=> String
|
1118
1119
|
# resp.training_data[0].input_config.schema[0].column_types #=> Array
|
1119
1120
|
# resp.training_data[0].input_config.schema[0].column_types[0] #=> String, one of "USER_ID", "ITEM_ID", "TIMESTAMP", "CATEGORICAL_FEATURE", "NUMERICAL_FEATURE"
|
1120
|
-
# resp.training_data[0].
|
1121
|
-
# resp.
|
1122
|
-
# resp.
|
1121
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.table_name #=> String
|
1122
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.database_name #=> String
|
1123
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.catalog_id #=> String
|
1124
|
+
# resp.status #=> String, one of "ACTIVE"
|
1125
|
+
# resp.role_arn #=> String
|
1126
|
+
# resp.tags #=> Hash
|
1127
|
+
# resp.tags["TagKey"] #=> String
|
1128
|
+
# resp.description #=> String
|
1123
1129
|
#
|
1124
1130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDataset AWS API Documentation
|
1125
1131
|
#
|
@@ -1132,47 +1138,47 @@ module Aws::CleanRoomsML
|
|
1132
1138
|
|
1133
1139
|
# Returns a list of the audience export jobs.
|
1134
1140
|
#
|
1135
|
-
# @option params [String] :
|
1136
|
-
# The
|
1137
|
-
#
|
1141
|
+
# @option params [String] :next_token
|
1142
|
+
# The token value retrieved from a previous call to access the next page
|
1143
|
+
# of results.
|
1138
1144
|
#
|
1139
1145
|
# @option params [Integer] :max_results
|
1140
1146
|
# The maximum size of the results that is returned per call.
|
1141
1147
|
#
|
1142
|
-
# @option params [String] :
|
1143
|
-
# The
|
1144
|
-
#
|
1148
|
+
# @option params [String] :audience_generation_job_arn
|
1149
|
+
# The Amazon Resource Name (ARN) of the audience generation job that you
|
1150
|
+
# are interested in.
|
1145
1151
|
#
|
1146
1152
|
# @return [Types::ListAudienceExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1147
1153
|
#
|
1148
|
-
# * {Types::ListAudienceExportJobsResponse#audience_export_jobs #audience_export_jobs} => Array<Types::AudienceExportJobSummary>
|
1149
1154
|
# * {Types::ListAudienceExportJobsResponse#next_token #next_token} => String
|
1155
|
+
# * {Types::ListAudienceExportJobsResponse#audience_export_jobs #audience_export_jobs} => Array<Types::AudienceExportJobSummary>
|
1150
1156
|
#
|
1151
1157
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1152
1158
|
#
|
1153
1159
|
# @example Request syntax with placeholder values
|
1154
1160
|
#
|
1155
1161
|
# resp = client.list_audience_export_jobs({
|
1156
|
-
# audience_generation_job_arn: "AudienceGenerationJobArn",
|
1157
|
-
# max_results: 1,
|
1158
1162
|
# next_token: "NextToken",
|
1163
|
+
# max_results: 1,
|
1164
|
+
# audience_generation_job_arn: "AudienceGenerationJobArn",
|
1159
1165
|
# })
|
1160
1166
|
#
|
1161
1167
|
# @example Response structure
|
1162
1168
|
#
|
1169
|
+
# resp.next_token #=> String
|
1163
1170
|
# resp.audience_export_jobs #=> Array
|
1171
|
+
# resp.audience_export_jobs[0].create_time #=> Time
|
1172
|
+
# resp.audience_export_jobs[0].update_time #=> Time
|
1173
|
+
# resp.audience_export_jobs[0].name #=> String
|
1164
1174
|
# resp.audience_export_jobs[0].audience_generation_job_arn #=> String
|
1165
1175
|
# resp.audience_export_jobs[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
1166
1176
|
# resp.audience_export_jobs[0].audience_size.value #=> Integer
|
1167
|
-
# resp.audience_export_jobs[0].create_time #=> Time
|
1168
1177
|
# resp.audience_export_jobs[0].description #=> String
|
1169
|
-
# resp.audience_export_jobs[0].name #=> String
|
1170
|
-
# resp.audience_export_jobs[0].output_location #=> String
|
1171
1178
|
# resp.audience_export_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE"
|
1172
|
-
# resp.audience_export_jobs[0].status_details.message #=> String
|
1173
1179
|
# resp.audience_export_jobs[0].status_details.status_code #=> String
|
1174
|
-
# resp.audience_export_jobs[0].
|
1175
|
-
# resp.
|
1180
|
+
# resp.audience_export_jobs[0].status_details.message #=> String
|
1181
|
+
# resp.audience_export_jobs[0].output_location #=> String
|
1176
1182
|
#
|
1177
1183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobs AWS API Documentation
|
1178
1184
|
#
|
@@ -1185,50 +1191,50 @@ module Aws::CleanRoomsML
|
|
1185
1191
|
|
1186
1192
|
# Returns a list of audience generation jobs.
|
1187
1193
|
#
|
1188
|
-
# @option params [String] :
|
1189
|
-
# The
|
1190
|
-
#
|
1194
|
+
# @option params [String] :next_token
|
1195
|
+
# The token value retrieved from a previous call to access the next page
|
1196
|
+
# of results.
|
1197
|
+
#
|
1198
|
+
# @option params [Integer] :max_results
|
1199
|
+
# The maximum size of the results that is returned per call.
|
1191
1200
|
#
|
1192
1201
|
# @option params [String] :configured_audience_model_arn
|
1193
1202
|
# The Amazon Resource Name (ARN) of the configured audience model that
|
1194
1203
|
# was used for the audience generation jobs that you are interested in.
|
1195
1204
|
#
|
1196
|
-
# @option params [
|
1197
|
-
# The
|
1198
|
-
#
|
1199
|
-
# @option params [String] :next_token
|
1200
|
-
# The token value retrieved from a previous call to access the next page
|
1201
|
-
# of results.
|
1205
|
+
# @option params [String] :collaboration_id
|
1206
|
+
# The identifier of the collaboration that contains the audience
|
1207
|
+
# generation jobs that you are interested in.
|
1202
1208
|
#
|
1203
1209
|
# @return [Types::ListAudienceGenerationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1204
1210
|
#
|
1205
|
-
# * {Types::ListAudienceGenerationJobsResponse#audience_generation_jobs #audience_generation_jobs} => Array<Types::AudienceGenerationJobSummary>
|
1206
1211
|
# * {Types::ListAudienceGenerationJobsResponse#next_token #next_token} => String
|
1212
|
+
# * {Types::ListAudienceGenerationJobsResponse#audience_generation_jobs #audience_generation_jobs} => Array<Types::AudienceGenerationJobSummary>
|
1207
1213
|
#
|
1208
1214
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1209
1215
|
#
|
1210
1216
|
# @example Request syntax with placeholder values
|
1211
1217
|
#
|
1212
1218
|
# resp = client.list_audience_generation_jobs({
|
1213
|
-
# collaboration_id: "UUID",
|
1214
|
-
# configured_audience_model_arn: "ConfiguredAudienceModelArn",
|
1215
|
-
# max_results: 1,
|
1216
1219
|
# next_token: "NextToken",
|
1220
|
+
# max_results: 1,
|
1221
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn",
|
1222
|
+
# collaboration_id: "UUID",
|
1217
1223
|
# })
|
1218
1224
|
#
|
1219
1225
|
# @example Response structure
|
1220
1226
|
#
|
1227
|
+
# resp.next_token #=> String
|
1221
1228
|
# resp.audience_generation_jobs #=> Array
|
1222
|
-
# resp.audience_generation_jobs[0].audience_generation_job_arn #=> String
|
1223
|
-
# resp.audience_generation_jobs[0].collaboration_id #=> String
|
1224
|
-
# resp.audience_generation_jobs[0].configured_audience_model_arn #=> String
|
1225
1229
|
# resp.audience_generation_jobs[0].create_time #=> Time
|
1226
|
-
# resp.audience_generation_jobs[0].
|
1230
|
+
# resp.audience_generation_jobs[0].update_time #=> Time
|
1231
|
+
# resp.audience_generation_jobs[0].audience_generation_job_arn #=> String
|
1227
1232
|
# resp.audience_generation_jobs[0].name #=> String
|
1228
|
-
# resp.audience_generation_jobs[0].
|
1233
|
+
# resp.audience_generation_jobs[0].description #=> String
|
1229
1234
|
# resp.audience_generation_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1230
|
-
# resp.audience_generation_jobs[0].
|
1231
|
-
# resp.
|
1235
|
+
# resp.audience_generation_jobs[0].configured_audience_model_arn #=> String
|
1236
|
+
# resp.audience_generation_jobs[0].collaboration_id #=> String
|
1237
|
+
# resp.audience_generation_jobs[0].started_by #=> String
|
1232
1238
|
#
|
1233
1239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobs AWS API Documentation
|
1234
1240
|
#
|
@@ -1241,38 +1247,38 @@ module Aws::CleanRoomsML
|
|
1241
1247
|
|
1242
1248
|
# Returns a list of audience models.
|
1243
1249
|
#
|
1244
|
-
# @option params [Integer] :max_results
|
1245
|
-
# The maximum size of the results that is returned per call.
|
1246
|
-
#
|
1247
1250
|
# @option params [String] :next_token
|
1248
1251
|
# The token value retrieved from a previous call to access the next page
|
1249
1252
|
# of results.
|
1250
1253
|
#
|
1254
|
+
# @option params [Integer] :max_results
|
1255
|
+
# The maximum size of the results that is returned per call.
|
1256
|
+
#
|
1251
1257
|
# @return [Types::ListAudienceModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1252
1258
|
#
|
1253
|
-
# * {Types::ListAudienceModelsResponse#audience_models #audience_models} => Array<Types::AudienceModelSummary>
|
1254
1259
|
# * {Types::ListAudienceModelsResponse#next_token #next_token} => String
|
1260
|
+
# * {Types::ListAudienceModelsResponse#audience_models #audience_models} => Array<Types::AudienceModelSummary>
|
1255
1261
|
#
|
1256
1262
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1257
1263
|
#
|
1258
1264
|
# @example Request syntax with placeholder values
|
1259
1265
|
#
|
1260
1266
|
# resp = client.list_audience_models({
|
1261
|
-
# max_results: 1,
|
1262
1267
|
# next_token: "NextToken",
|
1268
|
+
# max_results: 1,
|
1263
1269
|
# })
|
1264
1270
|
#
|
1265
1271
|
# @example Response structure
|
1266
1272
|
#
|
1273
|
+
# resp.next_token #=> String
|
1267
1274
|
# resp.audience_models #=> Array
|
1268
|
-
# resp.audience_models[0].audience_model_arn #=> String
|
1269
1275
|
# resp.audience_models[0].create_time #=> Time
|
1270
|
-
# resp.audience_models[0].
|
1276
|
+
# resp.audience_models[0].update_time #=> Time
|
1277
|
+
# resp.audience_models[0].audience_model_arn #=> String
|
1271
1278
|
# resp.audience_models[0].name #=> String
|
1272
|
-
# resp.audience_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1273
1279
|
# resp.audience_models[0].training_dataset_arn #=> String
|
1274
|
-
# resp.audience_models[0].
|
1275
|
-
# resp.
|
1280
|
+
# resp.audience_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1281
|
+
# resp.audience_models[0].description #=> String
|
1276
1282
|
#
|
1277
1283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModels AWS API Documentation
|
1278
1284
|
#
|
@@ -1285,40 +1291,40 @@ module Aws::CleanRoomsML
|
|
1285
1291
|
|
1286
1292
|
# Returns a list of the configured audience models.
|
1287
1293
|
#
|
1288
|
-
# @option params [Integer] :max_results
|
1289
|
-
# The maximum size of the results that is returned per call.
|
1290
|
-
#
|
1291
1294
|
# @option params [String] :next_token
|
1292
1295
|
# The token value retrieved from a previous call to access the next page
|
1293
1296
|
# of results.
|
1294
1297
|
#
|
1298
|
+
# @option params [Integer] :max_results
|
1299
|
+
# The maximum size of the results that is returned per call.
|
1300
|
+
#
|
1295
1301
|
# @return [Types::ListConfiguredAudienceModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1296
1302
|
#
|
1297
|
-
# * {Types::ListConfiguredAudienceModelsResponse#configured_audience_models #configured_audience_models} => Array<Types::ConfiguredAudienceModelSummary>
|
1298
1303
|
# * {Types::ListConfiguredAudienceModelsResponse#next_token #next_token} => String
|
1304
|
+
# * {Types::ListConfiguredAudienceModelsResponse#configured_audience_models #configured_audience_models} => Array<Types::ConfiguredAudienceModelSummary>
|
1299
1305
|
#
|
1300
1306
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1301
1307
|
#
|
1302
1308
|
# @example Request syntax with placeholder values
|
1303
1309
|
#
|
1304
1310
|
# resp = client.list_configured_audience_models({
|
1305
|
-
# max_results: 1,
|
1306
1311
|
# next_token: "NextToken",
|
1312
|
+
# max_results: 1,
|
1307
1313
|
# })
|
1308
1314
|
#
|
1309
1315
|
# @example Response structure
|
1310
1316
|
#
|
1317
|
+
# resp.next_token #=> String
|
1311
1318
|
# resp.configured_audience_models #=> Array
|
1312
|
-
# resp.configured_audience_models[0].audience_model_arn #=> String
|
1313
|
-
# resp.configured_audience_models[0].configured_audience_model_arn #=> String
|
1314
1319
|
# resp.configured_audience_models[0].create_time #=> Time
|
1315
|
-
# resp.configured_audience_models[0].
|
1320
|
+
# resp.configured_audience_models[0].update_time #=> Time
|
1316
1321
|
# resp.configured_audience_models[0].name #=> String
|
1322
|
+
# resp.configured_audience_models[0].audience_model_arn #=> String
|
1317
1323
|
# resp.configured_audience_models[0].output_config.destination.s3_destination.s3_uri #=> String
|
1318
1324
|
# resp.configured_audience_models[0].output_config.role_arn #=> String
|
1325
|
+
# resp.configured_audience_models[0].description #=> String
|
1326
|
+
# resp.configured_audience_models[0].configured_audience_model_arn #=> String
|
1319
1327
|
# resp.configured_audience_models[0].status #=> String, one of "ACTIVE"
|
1320
|
-
# resp.configured_audience_models[0].update_time #=> Time
|
1321
|
-
# resp.next_token #=> String
|
1322
1328
|
#
|
1323
1329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModels AWS API Documentation
|
1324
1330
|
#
|
@@ -1361,13 +1367,13 @@ module Aws::CleanRoomsML
|
|
1361
1367
|
|
1362
1368
|
# Returns a list of training datasets.
|
1363
1369
|
#
|
1364
|
-
# @option params [Integer] :max_results
|
1365
|
-
# The maximum size of the results that is returned per call.
|
1366
|
-
#
|
1367
1370
|
# @option params [String] :next_token
|
1368
1371
|
# The token value retrieved from a previous call to access the next page
|
1369
1372
|
# of results.
|
1370
1373
|
#
|
1374
|
+
# @option params [Integer] :max_results
|
1375
|
+
# The maximum size of the results that is returned per call.
|
1376
|
+
#
|
1371
1377
|
# @return [Types::ListTrainingDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1372
1378
|
#
|
1373
1379
|
# * {Types::ListTrainingDatasetsResponse#next_token #next_token} => String
|
@@ -1378,8 +1384,8 @@ module Aws::CleanRoomsML
|
|
1378
1384
|
# @example Request syntax with placeholder values
|
1379
1385
|
#
|
1380
1386
|
# resp = client.list_training_datasets({
|
1381
|
-
# max_results: 1,
|
1382
1387
|
# next_token: "NextToken",
|
1388
|
+
# max_results: 1,
|
1383
1389
|
# })
|
1384
1390
|
#
|
1385
1391
|
# @example Response structure
|
@@ -1387,11 +1393,11 @@ module Aws::CleanRoomsML
|
|
1387
1393
|
# resp.next_token #=> String
|
1388
1394
|
# resp.training_datasets #=> Array
|
1389
1395
|
# resp.training_datasets[0].create_time #=> Time
|
1390
|
-
# resp.training_datasets[0].
|
1396
|
+
# resp.training_datasets[0].update_time #=> Time
|
1397
|
+
# resp.training_datasets[0].training_dataset_arn #=> String
|
1391
1398
|
# resp.training_datasets[0].name #=> String
|
1392
1399
|
# resp.training_datasets[0].status #=> String, one of "ACTIVE"
|
1393
|
-
# resp.training_datasets[0].
|
1394
|
-
# resp.training_datasets[0].update_time #=> Time
|
1400
|
+
# resp.training_datasets[0].description #=> String
|
1395
1401
|
#
|
1396
1402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasets AWS API Documentation
|
1397
1403
|
#
|
@@ -1411,13 +1417,13 @@ module Aws::CleanRoomsML
|
|
1411
1417
|
# @option params [required, String] :configured_audience_model_policy
|
1412
1418
|
# The IAM resource policy.
|
1413
1419
|
#
|
1414
|
-
# @option params [String] :policy_existence_condition
|
1415
|
-
# Use this to prevent unexpected concurrent modification of the policy.
|
1416
|
-
#
|
1417
1420
|
# @option params [String] :previous_policy_hash
|
1418
1421
|
# A cryptographic hash of the contents of the policy used to prevent
|
1419
1422
|
# unexpected concurrent modification of the policy.
|
1420
1423
|
#
|
1424
|
+
# @option params [String] :policy_existence_condition
|
1425
|
+
# Use this to prevent unexpected concurrent modification of the policy.
|
1426
|
+
#
|
1421
1427
|
# @return [Types::PutConfiguredAudienceModelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1422
1428
|
#
|
1423
1429
|
# * {Types::PutConfiguredAudienceModelPolicyResponse#configured_audience_model_policy #configured_audience_model_policy} => String
|
@@ -1428,8 +1434,8 @@ module Aws::CleanRoomsML
|
|
1428
1434
|
# resp = client.put_configured_audience_model_policy({
|
1429
1435
|
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1430
1436
|
# configured_audience_model_policy: "ResourcePolicy", # required
|
1431
|
-
# policy_existence_condition: "POLICY_MUST_EXIST", # accepts POLICY_MUST_EXIST, POLICY_MUST_NOT_EXIST
|
1432
1437
|
# previous_policy_hash: "Hash",
|
1438
|
+
# policy_existence_condition: "POLICY_MUST_EXIST", # accepts POLICY_MUST_EXIST, POLICY_MUST_NOT_EXIST
|
1433
1439
|
# })
|
1434
1440
|
#
|
1435
1441
|
# @example Response structure
|
@@ -1449,6 +1455,9 @@ module Aws::CleanRoomsML
|
|
1449
1455
|
# Export an audience of a specified size after you have generated an
|
1450
1456
|
# audience.
|
1451
1457
|
#
|
1458
|
+
# @option params [required, String] :name
|
1459
|
+
# The name of the audience export job.
|
1460
|
+
#
|
1452
1461
|
# @option params [required, String] :audience_generation_job_arn
|
1453
1462
|
# The Amazon Resource Name (ARN) of the audience generation job that you
|
1454
1463
|
# want to export.
|
@@ -1460,21 +1469,18 @@ module Aws::CleanRoomsML
|
|
1460
1469
|
# @option params [String] :description
|
1461
1470
|
# The description of the audience export job.
|
1462
1471
|
#
|
1463
|
-
# @option params [required, String] :name
|
1464
|
-
# The name of the audience export job.
|
1465
|
-
#
|
1466
1472
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1467
1473
|
#
|
1468
1474
|
# @example Request syntax with placeholder values
|
1469
1475
|
#
|
1470
1476
|
# resp = client.start_audience_export_job({
|
1477
|
+
# name: "NameString", # required
|
1471
1478
|
# audience_generation_job_arn: "AudienceGenerationJobArn", # required
|
1472
1479
|
# audience_size: { # required
|
1473
1480
|
# type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
|
1474
1481
|
# value: 1, # required
|
1475
1482
|
# },
|
1476
1483
|
# description: "ResourceDescription",
|
1477
|
-
# name: "NameString", # required
|
1478
1484
|
# })
|
1479
1485
|
#
|
1480
1486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceExportJob AWS API Documentation
|
@@ -1488,26 +1494,26 @@ module Aws::CleanRoomsML
|
|
1488
1494
|
|
1489
1495
|
# Information necessary to start the audience generation job.
|
1490
1496
|
#
|
1491
|
-
# @option params [String] :
|
1492
|
-
# The
|
1493
|
-
# generation job.
|
1497
|
+
# @option params [required, String] :name
|
1498
|
+
# The name of the audience generation job.
|
1494
1499
|
#
|
1495
1500
|
# @option params [required, String] :configured_audience_model_arn
|
1496
1501
|
# The Amazon Resource Name (ARN) of the configured audience model that
|
1497
1502
|
# is used for this audience generation job.
|
1498
1503
|
#
|
1499
|
-
# @option params [
|
1500
|
-
# The
|
1504
|
+
# @option params [required, Types::AudienceGenerationJobDataSource] :seed_audience
|
1505
|
+
# The seed audience that is used to generate the audience.
|
1501
1506
|
#
|
1502
1507
|
# @option params [Boolean] :include_seed_in_output
|
1503
1508
|
# Whether the seed audience is included in the audience generation
|
1504
1509
|
# output.
|
1505
1510
|
#
|
1506
|
-
# @option params [
|
1507
|
-
# The
|
1511
|
+
# @option params [String] :collaboration_id
|
1512
|
+
# The identifier of the collaboration that contains the audience
|
1513
|
+
# generation job.
|
1508
1514
|
#
|
1509
|
-
# @option params [
|
1510
|
-
# The
|
1515
|
+
# @option params [String] :description
|
1516
|
+
# The description of the audience generation job.
|
1511
1517
|
#
|
1512
1518
|
# @option params [Hash<String,String>] :tags
|
1513
1519
|
# The optional metadata that you apply to the resource to help you
|
@@ -1548,17 +1554,24 @@ module Aws::CleanRoomsML
|
|
1548
1554
|
# @example Request syntax with placeholder values
|
1549
1555
|
#
|
1550
1556
|
# resp = client.start_audience_generation_job({
|
1551
|
-
# collaboration_id: "UUID",
|
1552
|
-
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1553
|
-
# description: "ResourceDescription",
|
1554
|
-
# include_seed_in_output: false,
|
1555
1557
|
# name: "NameString", # required
|
1558
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1556
1559
|
# seed_audience: { # required
|
1557
|
-
# data_source: {
|
1560
|
+
# data_source: {
|
1558
1561
|
# s3_uri: "S3Path", # required
|
1559
1562
|
# },
|
1560
1563
|
# role_arn: "IamRoleArn", # required
|
1564
|
+
# sql_parameters: {
|
1565
|
+
# query_string: "ProtectedQuerySQLParametersQueryStringString",
|
1566
|
+
# analysis_template_arn: "AnalysisTemplateArn",
|
1567
|
+
# parameters: {
|
1568
|
+
# "ParameterKey" => "ParameterValue",
|
1569
|
+
# },
|
1570
|
+
# },
|
1561
1571
|
# },
|
1572
|
+
# include_seed_in_output: false,
|
1573
|
+
# collaboration_id: "UUID",
|
1574
|
+
# description: "ResourceDescription",
|
1562
1575
|
# tags: {
|
1563
1576
|
# "TagKey" => "TagValue",
|
1564
1577
|
# },
|
@@ -1666,29 +1679,29 @@ module Aws::CleanRoomsML
|
|
1666
1679
|
# model. Updates that impact audience generation jobs take effect when a
|
1667
1680
|
# new job starts, but do not impact currently running jobs.
|
1668
1681
|
#
|
1669
|
-
# @option params [String] :audience_model_arn
|
1670
|
-
# The Amazon Resource Name (ARN) of the new audience model that you want
|
1671
|
-
# to use.
|
1672
|
-
#
|
1673
|
-
# @option params [Types::AudienceSizeConfig] :audience_size_config
|
1674
|
-
# The new audience size configuration.
|
1675
|
-
#
|
1676
1682
|
# @option params [required, String] :configured_audience_model_arn
|
1677
1683
|
# The Amazon Resource Name (ARN) of the configured audience model that
|
1678
1684
|
# you want to update.
|
1679
1685
|
#
|
1680
|
-
# @option params [
|
1681
|
-
# The new
|
1686
|
+
# @option params [Types::ConfiguredAudienceModelOutputConfig] :output_config
|
1687
|
+
# The new output configuration.
|
1688
|
+
#
|
1689
|
+
# @option params [String] :audience_model_arn
|
1690
|
+
# The Amazon Resource Name (ARN) of the new audience model that you want
|
1691
|
+
# to use.
|
1692
|
+
#
|
1693
|
+
# @option params [Array<String>] :shared_audience_metrics
|
1694
|
+
# The new value for whether to share audience metrics.
|
1682
1695
|
#
|
1683
1696
|
# @option params [Integer] :min_matching_seed_size
|
1684
1697
|
# The minimum number of users from the seed audience that must match
|
1685
1698
|
# with users in the training data of the audience model.
|
1686
1699
|
#
|
1687
|
-
# @option params [Types::
|
1688
|
-
# The new
|
1700
|
+
# @option params [Types::AudienceSizeConfig] :audience_size_config
|
1701
|
+
# The new audience size configuration.
|
1689
1702
|
#
|
1690
|
-
# @option params [
|
1691
|
-
# The new
|
1703
|
+
# @option params [String] :description
|
1704
|
+
# The new description of the configured audience model.
|
1692
1705
|
#
|
1693
1706
|
# @return [Types::UpdateConfiguredAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1694
1707
|
#
|
@@ -1697,14 +1710,7 @@ module Aws::CleanRoomsML
|
|
1697
1710
|
# @example Request syntax with placeholder values
|
1698
1711
|
#
|
1699
1712
|
# resp = client.update_configured_audience_model({
|
1700
|
-
# audience_model_arn: "AudienceModelArn",
|
1701
|
-
# audience_size_config: {
|
1702
|
-
# audience_size_bins: [1], # required
|
1703
|
-
# audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
|
1704
|
-
# },
|
1705
1713
|
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1706
|
-
# description: "ResourceDescription",
|
1707
|
-
# min_matching_seed_size: 1,
|
1708
1714
|
# output_config: {
|
1709
1715
|
# destination: { # required
|
1710
1716
|
# s3_destination: { # required
|
@@ -1713,7 +1719,14 @@ module Aws::CleanRoomsML
|
|
1713
1719
|
# },
|
1714
1720
|
# role_arn: "IamRoleArn", # required
|
1715
1721
|
# },
|
1722
|
+
# audience_model_arn: "AudienceModelArn",
|
1716
1723
|
# shared_audience_metrics: ["ALL"], # accepts ALL, NONE
|
1724
|
+
# min_matching_seed_size: 1,
|
1725
|
+
# audience_size_config: {
|
1726
|
+
# audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
|
1727
|
+
# audience_size_bins: [1], # required
|
1728
|
+
# },
|
1729
|
+
# description: "ResourceDescription",
|
1717
1730
|
# })
|
1718
1731
|
#
|
1719
1732
|
# @example Response structure
|
@@ -1742,7 +1755,7 @@ module Aws::CleanRoomsML
|
|
1742
1755
|
params: params,
|
1743
1756
|
config: config)
|
1744
1757
|
context[:gem_name] = 'aws-sdk-cleanroomsml'
|
1745
|
-
context[:gem_version] = '1.
|
1758
|
+
context[:gem_version] = '1.10.0'
|
1746
1759
|
Seahorse::Client::Request.new(handlers, context)
|
1747
1760
|
end
|
1748
1761
|
|