aws-sdk-cleanroomsml 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fed523477437c6508e855a8be097ca93bb73d3ba0777de8402df35306010750
-  data.tar.gz: 79b3e81cb5bf0bae366c2c65cc72135357ee58680e2d906ec802a27c0294054a
+  metadata.gz: 20d07ae0b5fec9b1c5cb41ec4fc068a026185cca22a69dbb4c46b77fa5b9547b
+  data.tar.gz: eed75c6adb6b07b0d59d330cc1f15b8787b86a048c15d6a9e0c04b68970aa7de
 SHA512:
-  metadata.gz: 38e6b95d2aa1415e61094e8817ec8bbc5be14dc540d516da925552f6a949b0227bef603b3d1f19389314883e7992ad83cfbf5145bb465997a4f76710e757beed
-  data.tar.gz: ea5b9b8bda9c778de53c614e3520a9fa95505682731251683dc1ab6fba77c94552f90be4b056bcaec7cd83cb70d8a19aaf0debc80030d8d9db9b2a835365793e
+  metadata.gz: 4350a15a82a36e2f7c84cb241c3ba5113f0255223461d2f181a308d266ec68796cf066c07331ee42ed8274ec0c3c65b90e3396b930b9eb427f2018dfa6b505be
+  data.tar.gz: 6a3c062339d480d88611870bde84ed39d64b2e64446c7efe8b604ab0cea911cab8c650e9f133e56f30164d2fc4cdcc4ab0bb1a418a65fe15f2f158d7a5aeba71

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.3.0 (2024-04-03)
+------------------
+
+* Feature - The release includes a public SDK for AWS Clean Rooms ML APIs, making them globally available to developers worldwide.
+
 1.2.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/aws-sdk-cleanroomsml/client.rb

@@ -432,8 +432,8 @@ module Aws::CleanRoomsML
     #   * Do not use aws:, AWS:, or any upper or lowercase combination of such
     #     as a prefix for keys as it is reserved for AWS use. You cannot edit
     #     or delete tag keys with this prefix. Values can have this prefix. If
-    #     a tag value has aws as its prefix but the key does not, then
-    #     Forecast considers it to be a user tag and will count against the
+    #     a tag value has aws as its prefix but the key does not, then Clean
+    #     Rooms ML considers it to be a user tag and will count against the
     #     limit of 50 tags. Tags with only the key prefix of aws do not count
     #     against your tags per resource limit.
     #
@@ -512,7 +512,8 @@ module Aws::CleanRoomsML
     #
     # @option params [Integer] :min_matching_seed_size
     #   The minimum number of users from the seed audience that must match
-    #   with users in the training data of the audience model.
+    #   with users in the training data of the audience model. The default
+    #   value is 500.
     #
     # @option params [required, String] :name
     #   The name of the configured audience model.
@@ -555,8 +556,8 @@ module Aws::CleanRoomsML
     #   * Do not use aws:, AWS:, or any upper or lowercase combination of such
     #     as a prefix for keys as it is reserved for AWS use. You cannot edit
     #     or delete tag keys with this prefix. Values can have this prefix. If
-    #     a tag value has aws as its prefix but the key does not, then
-    #     Forecast considers it to be a user tag and will count against the
+    #     a tag value has aws as its prefix but the key does not, then Clean
+    #     Rooms ML considers it to be a user tag and will count against the
     #     limit of 50 tags. Tags with only the key prefix of aws do not count
     #     against your tags per resource limit.
     #
@@ -603,10 +604,9 @@ module Aws::CleanRoomsML
       req.send_request(options)
     end
 
-    # Defines the information necessary to create a training dataset, or
-    # seed audience. In Clean Rooms ML, the `TrainingDataset` is metadata
-    # that points to a Glue table, which is read only during `AudienceModel`
-    # creation.
+    # Defines the information necessary to create a training dataset. In
+    # Clean Rooms ML, the `TrainingDataset` is metadata that points to a
+    # Glue table, which is read only during `AudienceModel` creation.
     #
     # @option params [String] :description
     #   The description of the training dataset.
@@ -870,6 +870,7 @@ module Aws::CleanRoomsML
     #   resp.create_time #=> Time
     #   resp.description #=> String
     #   resp.include_seed_in_output #=> Boolean
+    #   resp.metrics.recall_metric #=> Float
     #   resp.metrics.relevance_metrics #=> Array
     #   resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
     #   resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
@@ -906,7 +907,6 @@ module Aws::CleanRoomsML
     #   * {Types::GetAudienceModelResponse#create_time #create_time} => Time
     #   * {Types::GetAudienceModelResponse#description #description} => String
     #   * {Types::GetAudienceModelResponse#kms_key_arn #kms_key_arn} => String
-    #   * {Types::GetAudienceModelResponse#metrics #metrics} => Array<Types::AudienceModelMetric>
     #   * {Types::GetAudienceModelResponse#name #name} => String
     #   * {Types::GetAudienceModelResponse#status #status} => String
     #   * {Types::GetAudienceModelResponse#status_details #status_details} => Types::StatusDetails
@@ -928,10 +928,6 @@ module Aws::CleanRoomsML
     #   resp.create_time #=> Time
     #   resp.description #=> String
     #   resp.kms_key_arn #=> String
-    #   resp.metrics #=> Array
-    #   resp.metrics[0].for_top_k_item_predictions #=> Integer
-    #   resp.metrics[0].type #=> String, one of "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN", "MEAN_RECIPROCAL_RANK", "PRECISION", "RECALL"
-    #   resp.metrics[0].value #=> Float
     #   resp.name #=> String
     #   resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
     #   resp.status_details.message #=> String
@@ -1503,8 +1499,8 @@ module Aws::CleanRoomsML
     #   * Do not use aws:, AWS:, or any upper or lowercase combination of such
     #     as a prefix for keys as it is reserved for AWS use. You cannot edit
     #     or delete tag keys with this prefix. Values can have this prefix. If
-    #     a tag value has aws as its prefix but the key does not, then
-    #     Forecast considers it to be a user tag and will count against the
+    #     a tag value has aws as its prefix but the key does not, then Clean
+    #     Rooms ML considers it to be a user tag and will count against the
     #     limit of 50 tags. Tags with only the key prefix of aws do not count
     #     against your tags per resource limit.
     #
@@ -1577,9 +1573,9 @@ module Aws::CleanRoomsML
     #   * Do not use aws:, AWS:, or any upper or lowercase combination of such
     #     as a prefix for keys as it is reserved for AWS use. You cannot edit
     #     or delete tag keys with this prefix. Values can have this prefix. If
-    #     a tag value has aws as its prefix but the key does not, then
-    #     Forecast considers it to be a user tag and will count against the
-    #     limit of 50 tags. Tags with only the key prefix of aws do not count
+    #     a tag value has aws as its prefix but the key does not, then Clean
+    #     Rooms considers it to be a user tag and will count against the limit
+    #     of 50 tags. Tags with only the key prefix of aws do not count
     #     against your tags per resource limit.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -1709,7 +1705,7 @@ module Aws::CleanRoomsML
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cleanroomsml'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cleanroomsml/client_api.rb

@@ -26,9 +26,6 @@ module Aws::CleanRoomsML
     AudienceGenerationJobSummary = Shapes::StructureShape.new(name: 'AudienceGenerationJobSummary')
     AudienceModelArn = Shapes::StringShape.new(name: 'AudienceModelArn')
     AudienceModelList = Shapes::ListShape.new(name: 'AudienceModelList')
-    AudienceModelMetric = Shapes::StructureShape.new(name: 'AudienceModelMetric')
-    AudienceModelMetricType = Shapes::StringShape.new(name: 'AudienceModelMetricType')
-    AudienceModelMetrics = Shapes::ListShape.new(name: 'AudienceModelMetrics')
     AudienceModelStatus = Shapes::StringShape.new(name: 'AudienceModelStatus')
     AudienceModelSummary = Shapes::StructureShape.new(name: 'AudienceModelSummary')
     AudienceQualityMetrics = Shapes::StructureShape.new(name: 'AudienceQualityMetrics')
@@ -82,7 +79,6 @@ module Aws::CleanRoomsML
     GlueTableName = Shapes::StringShape.new(name: 'GlueTableName')
     Hash = Shapes::StringShape.new(name: 'Hash')
     IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
-    Integer = Shapes::IntegerShape.new(name: 'Integer')
     KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
     ListAudienceExportJobsRequest = Shapes::StructureShape.new(name: 'ListAudienceExportJobsRequest')
     ListAudienceExportJobsResponse = Shapes::StructureShape.new(name: 'ListAudienceExportJobsResponse')
@@ -176,13 +172,6 @@ module Aws::CleanRoomsML
 
     AudienceModelList.member = Shapes::ShapeRef.new(shape: AudienceModelSummary)
 
-    AudienceModelMetric.add_member(:for_top_k_item_predictions, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "forTopKItemPredictions"))
-    AudienceModelMetric.add_member(:type, Shapes::ShapeRef.new(shape: AudienceModelMetricType, required: true, location_name: "type"))
-    AudienceModelMetric.add_member(:value, Shapes::ShapeRef.new(shape: Double, required: true, location_name: "value"))
-    AudienceModelMetric.struct_class = Types::AudienceModelMetric
-
-    AudienceModelMetrics.member = Shapes::ShapeRef.new(shape: AudienceModelMetric)
-
     AudienceModelSummary.add_member(:audience_model_arn, Shapes::ShapeRef.new(shape: AudienceModelArn, required: true, location_name: "audienceModelArn"))
     AudienceModelSummary.add_member(:create_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "createTime"))
     AudienceModelSummary.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "description"))
@@ -192,6 +181,7 @@ module Aws::CleanRoomsML
     AudienceModelSummary.add_member(:update_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "updateTime"))
     AudienceModelSummary.struct_class = Types::AudienceModelSummary
 
+    AudienceQualityMetrics.add_member(:recall_metric, Shapes::ShapeRef.new(shape: Double, location_name: "recallMetric"))
     AudienceQualityMetrics.add_member(:relevance_metrics, Shapes::ShapeRef.new(shape: RelevanceMetrics, required: true, location_name: "relevanceMetrics"))
     AudienceQualityMetrics.struct_class = Types::AudienceQualityMetrics
 
@@ -324,7 +314,6 @@ module Aws::CleanRoomsML
     GetAudienceModelResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "createTime"))
     GetAudienceModelResponse.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "description"))
     GetAudienceModelResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
-    GetAudienceModelResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: AudienceModelMetrics, location_name: "metrics"))
     GetAudienceModelResponse.add_member(:name, Shapes::ShapeRef.new(shape: NameString, required: true, location_name: "name"))
     GetAudienceModelResponse.add_member(:status, Shapes::ShapeRef.new(shape: AudienceModelStatus, required: true, location_name: "status"))
     GetAudienceModelResponse.add_member(:status_details, Shapes::ShapeRef.new(shape: StatusDetails, location_name: "statusDetails"))

data/lib/aws-sdk-cleanroomsml/types.rb

@@ -93,12 +93,19 @@ module Aws::CleanRoomsML
       include Aws::Structure
     end
 
-    # Defines the Amazon S3 bucket where the training data for the
-    # configured audience is stored.
+    # Defines the Amazon S3 bucket where the seed audience for the
+    # generating audience is stored.
     #
     # @!attribute [rw] data_source
-    #   The Amazon S3 bucket where the training data for the configured
-    #   audience is stored.
+    #   Defines the Amazon S3 bucket where the seed audience for the
+    #   generating audience is stored. A valid data source is a JSON line
+    #   file in the following format:
+    #
+    #   `\{"user_id": "111111"\}`
+    #
+    #   `\{"user_id": "222222"\}`
+    #
+    #   `...`
     #   @return [Types::S3ConfigMap]
     #
     # @!attribute [rw] role_arn
@@ -172,30 +179,6 @@ module Aws::CleanRoomsML
       include Aws::Structure
     end
 
-    # The audience model metrics.
-    #
-    # @!attribute [rw] for_top_k_item_predictions
-    #   The number of users that were used to generate these model metrics.
-    #   @return [Integer]
-    #
-    # @!attribute [rw] type
-    #   The audience model metric.
-    #   @return [String]
-    #
-    # @!attribute [rw] value
-    #   The value of the audience model metric
-    #   @return [Float]
-    #
-    # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceModelMetric AWS API Documentation
-    #
-    class AudienceModelMetric < Struct.new(
-      :for_top_k_item_predictions,
-      :type,
-      :value)
-      SENSITIVE = []
-      include Aws::Structure
-    end
-
     # Information about the audience model.
     #
     # @!attribute [rw] audience_model_arn
@@ -243,6 +226,16 @@ module Aws::CleanRoomsML
 
     # Metrics that describe the quality of the generated audience.
     #
+    # @!attribute [rw] recall_metric
+    #   The recall score of the generated audience. Recall is the percentage
+    #   of the most similar users (by default, the most similar 20%) from a
+    #   sample of the training data that are included in the seed audience
+    #   by the audience generation job. Values range from 0-1, larger values
+    #   indicate a better audience. A recall value approximately equal to
+    #   the maximum bin size indicates that the audience model is equivalent
+    #   to random selection.
+    #   @return [Float]
+    #
     # @!attribute [rw] relevance_metrics
     #   The relevance scores of the generated audience.
     #   @return [Array<Types::RelevanceMetric>]
@@ -250,6 +243,7 @@ module Aws::CleanRoomsML
     # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceQualityMetrics AWS API Documentation
     #
     class AudienceQualityMetrics < Struct.new(
+      :recall_metric,
       :relevance_metrics)
       SENSITIVE = []
       include Aws::Structure
@@ -397,7 +391,8 @@ module Aws::CleanRoomsML
       include Aws::Structure
     end
 
-    # A resource with that name already exists in this region.
+    # You can't complete this action because another resource depends on
+    # this resource.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -452,9 +447,9 @@ module Aws::CleanRoomsML
     #     such as a prefix for keys as it is reserved for AWS use. You
     #     cannot edit or delete tag keys with this prefix. Values can have
     #     this prefix. If a tag value has aws as its prefix but the key does
-    #     not, then Forecast considers it to be a user tag and will count
-    #     against the limit of 50 tags. Tags with only the key prefix of aws
-    #     do not count against your tags per resource limit.
+    #     not, then Clean Rooms ML considers it to be a user tag and will
+    #     count against the limit of 50 tags. Tags with only the key prefix
+    #     of aws do not count against your tags per resource limit.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] training_data_end_time
@@ -531,7 +526,8 @@ module Aws::CleanRoomsML
     #
     # @!attribute [rw] min_matching_seed_size
     #   The minimum number of users from the seed audience that must match
-    #   with users in the training data of the audience model.
+    #   with users in the training data of the audience model. The default
+    #   value is 500.
     #   @return [Integer]
     #
     # @!attribute [rw] name
@@ -579,9 +575,9 @@ module Aws::CleanRoomsML
     #     such as a prefix for keys as it is reserved for AWS use. You
     #     cannot edit or delete tag keys with this prefix. Values can have
     #     this prefix. If a tag value has aws as its prefix but the key does
-    #     not, then Forecast considers it to be a user tag and will count
-    #     against the limit of 50 tags. Tags with only the key prefix of aws
-    #     do not count against your tags per resource limit.
+    #     not, then Clean Rooms ML considers it to be a user tag and will
+    #     count against the limit of 50 tags. Tags with only the key prefix
+    #     of aws do not count against your tags per resource limit.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModelRequest AWS API Documentation
@@ -861,7 +857,8 @@ module Aws::CleanRoomsML
     #   @return [Boolean]
     #
     # @!attribute [rw] metrics
-    #   The relevance scores for different audience sizes.
+    #   The relevance scores for different audience sizes and the recall
+    #   score of the generated audience.
     #   @return [Types::AudienceQualityMetrics]
     #
     # @!attribute [rw] name
@@ -945,10 +942,6 @@ module Aws::CleanRoomsML
     #   The KMS key ARN used for the audience model.
     #   @return [String]
     #
-    # @!attribute [rw] metrics
-    #   Accuracy metrics for the model.
-    #   @return [Array<Types::AudienceModelMetric>]
-    #
     # @!attribute [rw] name
     #   The name of the audience model.
     #   @return [String]
@@ -989,7 +982,6 @@ module Aws::CleanRoomsML
       :create_time,
       :description,
       :kms_key_arn,
-      :metrics,
       :name,
       :status,
       :status_details,
@@ -1639,9 +1631,9 @@ module Aws::CleanRoomsML
     #     such as a prefix for keys as it is reserved for AWS use. You
     #     cannot edit or delete tag keys with this prefix. Values can have
     #     this prefix. If a tag value has aws as its prefix but the key does
-    #     not, then Forecast considers it to be a user tag and will count
-    #     against the limit of 50 tags. Tags with only the key prefix of aws
-    #     do not count against your tags per resource limit.
+    #     not, then Clean Rooms ML considers it to be a user tag and will
+    #     count against the limit of 50 tags. Tags with only the key prefix
+    #     of aws do not count against your tags per resource limit.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJobRequest AWS API Documentation
@@ -1726,7 +1718,7 @@ module Aws::CleanRoomsML
     #     such as a prefix for keys as it is reserved for AWS use. You
     #     cannot edit or delete tag keys with this prefix. Values can have
     #     this prefix. If a tag value has aws as its prefix but the key does
-    #     not, then Forecast considers it to be a user tag and will count
+    #     not, then Clean Rooms considers it to be a user tag and will count
     #     against the limit of 50 tags. Tags with only the key prefix of aws
     #     do not count against your tags per resource limit.
     #   @return [Hash<String,String>]

data/lib/aws-sdk-cleanroomsml.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-cleanroomsml/customizations'
 # @!group service
 module Aws::CleanRoomsML
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end

data/sig/client.rbs

@@ -208,7 +208,6 @@ module Aws
         def create_time: () -> ::Time
         def description: () -> ::String
         def kms_key_arn: () -> ::String
-        def metrics: () -> ::Array[Types::AudienceModelMetric]
         def name: () -> ::String
         def status: () -> ("CREATE_PENDING" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_PENDING" | "DELETE_IN_PROGRESS" | "DELETE_FAILED")
         def status_details: () -> Types::StatusDetails

data/sig/types.rbs

@@ -50,13 +50,6 @@ module Aws::CleanRoomsML
       SENSITIVE: []
     end
 
-    class AudienceModelMetric
-      attr_accessor for_top_k_item_predictions: ::Integer
-      attr_accessor type: ("NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN" | "MEAN_RECIPROCAL_RANK" | "PRECISION" | "RECALL")
-      attr_accessor value: ::Float
-      SENSITIVE: []
-    end
-
     class AudienceModelSummary
       attr_accessor audience_model_arn: ::String
       attr_accessor create_time: ::Time
@@ -69,6 +62,7 @@ module Aws::CleanRoomsML
     end
 
     class AudienceQualityMetrics
+      attr_accessor recall_metric: ::Float
       attr_accessor relevance_metrics: ::Array[Types::RelevanceMetric]
       SENSITIVE: []
     end
@@ -237,7 +231,6 @@ module Aws::CleanRoomsML
       attr_accessor create_time: ::Time
       attr_accessor description: ::String
       attr_accessor kms_key_arn: ::String
-      attr_accessor metrics: ::Array[Types::AudienceModelMetric]
       attr_accessor name: ::String
       attr_accessor status: ("CREATE_PENDING" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_PENDING" | "DELETE_IN_PROGRESS" | "DELETE_FAILED")
       attr_accessor status_details: Types::StatusDetails

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cleanroomsml
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core