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