AWS Clean Rooms ML Update: The release includes a public SDK for AWS Clean Rooms ML APIs, making them globally available to developers worldwide.

AWS · AWS · commit 5cdcdaab704d · 2024-04-03T18:09:46.000Z
diff --git a/.changes/next-release/feature-AWSCleanRoomsML-644b26e.json b/.changes/next-release/feature-AWSCleanRoomsML-644b26e.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS Clean Rooms ML",
+    "contributor": "",
+    "description": "The release includes a public SDK for AWS Clean Rooms ML APIs, making them globally available to developers worldwide."
+}
diff --git a/services/cleanroomsml/src/main/resources/codegen-resources/service-2.json b/services/cleanroomsml/src/main/resources/codegen-resources/service-2.json
@@ -64,7 +64,7 @@
         {"shape":"ValidationException"},
         {"shape":"AccessDeniedException"}
       ],
-      "documentation":"<p>Defines the information necessary to create a training dataset, or seed audience. In Clean Rooms ML, the <code>TrainingDataset</code> is metadata that points to a Glue table, which is read only during <code>AudienceModel</code> creation.</p>",
+      "documentation":"<p>Defines the information necessary to create a training dataset. In Clean Rooms ML, the <code>TrainingDataset</code> is metadata that points to a Glue table, which is read only during <code>AudienceModel</code> creation.</p>",
       "idempotent":true
     },
     "DeleteAudienceGenerationJob":{
@@ -531,14 +531,14 @@
       "members":{
         "dataSource":{
           "shape":"S3ConfigMap",
-          "documentation":"<p>The Amazon S3 bucket where the training data for the configured audience is stored.</p>"
+          "documentation":"<p>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:</p> <p> <code>{\"user_id\": \"111111\"}</code> </p> <p> <code>{\"user_id\": \"222222\"}</code> </p> <p> <code>...</code> </p>"
         },
         "roleArn":{
           "shape":"IamRoleArn",
           "documentation":"<p>The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.</p>"
         }
       },
-      "documentation":"<p>Defines the Amazon S3 bucket where the training data for the configured audience is stored.</p>"
+      "documentation":"<p>Defines the Amazon S3 bucket where the seed audience for the generating audience is stored.</p>"
     },
     "AudienceGenerationJobList":{
       "type":"list",
@@ -616,42 +616,6 @@
       "type":"list",
       "member":{"shape":"AudienceModelSummary"}
     },
-    "AudienceModelMetric":{
-      "type":"structure",
-      "required":[
-        "forTopKItemPredictions",
-        "type",
-        "value"
-      ],
-      "members":{
-        "forTopKItemPredictions":{
-          "shape":"Integer",
-          "documentation":"<p>The number of users that were used to generate these model metrics.</p>"
-        },
-        "type":{
-          "shape":"AudienceModelMetricType",
-          "documentation":"<p>The audience model metric.</p>"
-        },
-        "value":{
-          "shape":"Double",
-          "documentation":"<p>The value of the audience model metric</p>"
-        }
-      },
-      "documentation":"<p>The audience model metrics.</p>"
-    },
-    "AudienceModelMetricType":{
-      "type":"string",
-      "enum":[
-        "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN",
-        "MEAN_RECIPROCAL_RANK",
-        "PRECISION",
-        "RECALL"
-      ]
-    },
-    "AudienceModelMetrics":{
-      "type":"list",
-      "member":{"shape":"AudienceModelMetric"}
-    },
     "AudienceModelStatus":{
       "type":"string",
       "enum":[
@@ -710,6 +674,10 @@
       "type":"structure",
       "required":["relevanceMetrics"],
       "members":{
+        "recallMetric":{
+          "shape":"Double",
+          "documentation":"<p>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. </p>"
+        },
         "relevanceMetrics":{
           "shape":"RelevanceMetrics",
           "documentation":"<p>The relevance scores of the generated audience.</p>"
@@ -898,7 +866,7 @@
       "members":{
         "message":{"shape":"String"}
       },
-      "documentation":"<p>A resource with that name already exists in this region.</p>",
+      "documentation":"<p>You can't complete this action because another resource depends on this resource.</p>",
       "error":{
         "httpStatusCode":409,
         "senderFault":true
@@ -926,7 +894,7 @@
         },
         "tags":{
           "shape":"TagMap",
-          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 against your tags per resource limit.</p> </li> </ul>"
+          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 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.</p> </li> </ul>"
         },
         "trainingDataEndTime":{
           "shape":"SyntheticTimestamp_date_time",
@@ -979,7 +947,7 @@
         },
         "minMatchingSeedSize":{
           "shape":"MinMatchingSeedSize",
-          "documentation":"<p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>"
+          "documentation":"<p>The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.</p>"
         },
         "name":{
           "shape":"NameString",
@@ -995,7 +963,7 @@
         },
         "tags":{
           "shape":"TagMap",
-          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 against your tags per resource limit.</p> </li> </ul>"
+          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 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.</p> </li> </ul>"
         }
       }
     },
@@ -1229,7 +1197,7 @@
         },
         "metrics":{
           "shape":"AudienceQualityMetrics",
-          "documentation":"<p>The relevance scores for different audience sizes. </p>"
+          "documentation":"<p>The relevance scores for different audience sizes and the recall score of the generated audience. </p>"
         },
         "name":{
           "shape":"NameString",
@@ -1300,10 +1268,6 @@
           "shape":"KmsKeyArn",
           "documentation":"<p>The KMS key ARN used for the audience model.</p>"
         },
-        "metrics":{
-          "shape":"AudienceModelMetrics",
-          "documentation":"<p>Accuracy metrics for the model.</p>"
-        },
         "name":{
           "shape":"NameString",
           "documentation":"<p>The name of the audience model.</p>"
@@ -1559,10 +1523,6 @@
       "min":20,
       "pattern":"^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$"
     },
-    "Integer":{
-      "type":"integer",
-      "box":true
-    },
     "KmsKeyArn":{
       "type":"string",
       "max":2048,
@@ -1978,7 +1938,7 @@
         },
         "tags":{
           "shape":"TagMap",
-          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 against your tags per resource limit.</p> </li> </ul>"
+          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 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.</p> </li> </ul>"
         }
       }
     },
@@ -2014,8 +1974,7 @@
     "TagKey":{
       "type":"string",
       "max":128,
-      "min":1,
-      "pattern":"^(?!aws:).{1,128}$"
+      "min":1
     },
     "TagKeys":{
       "type":"list",
@@ -2052,7 +2011,7 @@
         },
         "tags":{
           "shape":"TagMap",
-          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 against your tags per resource limit.</p> </li> </ul>"
+          "documentation":"<p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>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 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.</p> </li> </ul>"
         }
       }
     },
