feat(client-cleanroomsml): This release introduces support for incremental training and distributed training for custom models in AWS Clean Rooms ML.

Author: awstools

clients/client-cleanroomsml/README.md

@@ -6,12 +6,7 @@
 
 AWS SDK for JavaScript CleanRoomsML Client for Node.js, Browser and React Native.
 
-<p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p>
-<p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms  and generates an audience (lookalike segment) that resembles the training data.</p>
-<p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the
-<a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p>
-<p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
-<a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
+<p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p> <p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.</p> <p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p> <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
 
 ## Installing
 
@@ -591,6 +586,14 @@ ListTrainedModels
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanroomsml/command/ListTrainedModelsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanroomsml/Interface/ListTrainedModelsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanroomsml/Interface/ListTrainedModelsCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListTrainedModelVersions
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanroomsml/command/ListTrainedModelVersionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanroomsml/Interface/ListTrainedModelVersionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanroomsml/Interface/ListTrainedModelVersionsCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-cleanroomsml/src/CleanRoomsML.ts

@@ -243,6 +243,11 @@ import {
   ListTrainedModelsCommandInput,
   ListTrainedModelsCommandOutput,
 } from "./commands/ListTrainedModelsCommand";
+import {
+  ListTrainedModelVersionsCommand,
+  ListTrainedModelVersionsCommandInput,
+  ListTrainedModelVersionsCommandOutput,
+} from "./commands/ListTrainedModelVersionsCommand";
 import {
   ListTrainingDatasetsCommand,
   ListTrainingDatasetsCommandInput,
@@ -339,6 +344,7 @@ const commands = {
   ListTagsForResourceCommand,
   ListTrainedModelInferenceJobsCommand,
   ListTrainedModelsCommand,
+  ListTrainedModelVersionsCommand,
   ListTrainingDatasetsCommand,
   PutConfiguredAudienceModelPolicyCommand,
   PutMLConfigurationCommand,
@@ -1170,6 +1176,23 @@ export interface CleanRoomsML {
     cb: (err: any, data?: ListTrainedModelsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListTrainedModelVersionsCommand}
+   */
+  listTrainedModelVersions(
+    args: ListTrainedModelVersionsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListTrainedModelVersionsCommandOutput>;
+  listTrainedModelVersions(
+    args: ListTrainedModelVersionsCommandInput,
+    cb: (err: any, data?: ListTrainedModelVersionsCommandOutput) => void
+  ): void;
+  listTrainedModelVersions(
+    args: ListTrainedModelVersionsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListTrainedModelVersionsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListTrainingDatasetsCommand}
    */
@@ -1331,12 +1354,7 @@ export interface CleanRoomsML {
 }
 
 /**
- * <p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p>
- *          <p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms  and generates an audience (lookalike segment) that resembles the training data.</p>
- *          <p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the
- *        <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p>
- *          <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
- *        <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
+ * <p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p> <p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.</p> <p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p> <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
  * @public
  */
 export class CleanRoomsML extends CleanRoomsMLClient implements CleanRoomsML {}

clients/client-cleanroomsml/src/CleanRoomsMLClient.ts

@@ -218,6 +218,10 @@ import {
   ListTrainedModelInferenceJobsCommandOutput,
 } from "./commands/ListTrainedModelInferenceJobsCommand";
 import { ListTrainedModelsCommandInput, ListTrainedModelsCommandOutput } from "./commands/ListTrainedModelsCommand";
+import {
+  ListTrainedModelVersionsCommandInput,
+  ListTrainedModelVersionsCommandOutput,
+} from "./commands/ListTrainedModelVersionsCommand";
 import {
   ListTrainingDatasetsCommandInput,
   ListTrainingDatasetsCommandOutput,
@@ -311,6 +315,7 @@ export type ServiceInputTypes =
   | ListMLInputChannelsCommandInput
   | ListTagsForResourceCommandInput
   | ListTrainedModelInferenceJobsCommandInput
+  | ListTrainedModelVersionsCommandInput
   | ListTrainedModelsCommandInput
   | ListTrainingDatasetsCommandInput
   | PutConfiguredAudienceModelPolicyCommandInput
@@ -374,6 +379,7 @@ export type ServiceOutputTypes =
   | ListMLInputChannelsCommandOutput
   | ListTagsForResourceCommandOutput
   | ListTrainedModelInferenceJobsCommandOutput
+  | ListTrainedModelVersionsCommandOutput
   | ListTrainedModelsCommandOutput
   | ListTrainingDatasetsCommandOutput
   | PutConfiguredAudienceModelPolicyCommandOutput
@@ -577,12 +583,7 @@ export type CleanRoomsMLClientResolvedConfigType = __SmithyResolvedConfiguration
 export interface CleanRoomsMLClientResolvedConfig extends CleanRoomsMLClientResolvedConfigType {}
 
 /**
- * <p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p>
- *          <p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms  and generates an audience (lookalike segment) that resembles the training data.</p>
- *          <p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the
- *        <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p>
- *          <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
- *        <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
+ * <p>Welcome to the <i>Amazon Web Services Clean Rooms ML API Reference</i>.</p> <p>Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.</p> <p>To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html">Clean Rooms User Guide</a>.</p> <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
  * @public
  */
 export class CleanRoomsMLClient extends __Client<

clients/client-cleanroomsml/src/commands/CancelTrainedModelCommand.ts

@@ -38,6 +38,7 @@ export interface CancelTrainedModelCommandOutput extends __MetadataBearer {}
  * const input = { // CancelTrainedModelRequest
  *   membershipIdentifier: "STRING_VALUE", // required
  *   trainedModelArn: "STRING_VALUE", // required
+ *   versionIdentifier: "STRING_VALUE",
  * };
  * const command = new CancelTrainedModelCommand(input);
  * const response = await client.send(command);
@@ -60,6 +61,9 @@ export interface CancelTrainedModelCommandOutput extends __MetadataBearer {}
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you are requesting does not exist.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/CancelTrainedModelInferenceJobCommand.ts

@@ -63,6 +63,9 @@ export interface CancelTrainedModelInferenceJobCommandOutput extends __MetadataB
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you are requesting does not exist.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmAssociationCommand.ts

@@ -63,6 +63,10 @@ export interface CreateConfiguredModelAlgorithmAssociationCommandOutput
  *         containerMetrics: { // MetricsConfigurationPolicy
  *           noiseLevel: "HIGH" || "MEDIUM" || "LOW" || "NONE", // required
  *         },
+ *         maxArtifactSize: { // TrainedModelArtifactMaxSize
+ *           unit: "GB", // required
+ *           value: Number("double"), // required
+ *         },
  *       },
  *       trainedModelExports: { // TrainedModelExportsConfigurationPolicy
  *         maxSize: { // TrainedModelExportsMaxSize
@@ -119,6 +123,9 @@ export interface CreateConfiguredModelAlgorithmAssociationCommandOutput
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded your service quota.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/CreateMLInputChannelCommand.ts

@@ -98,6 +98,9 @@ export interface CreateMLInputChannelCommandOutput extends CreateMLInputChannelR
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded your service quota.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/CreateTrainedModelCommand.ts

@@ -53,12 +53,21 @@ export interface CreateTrainedModelCommandOutput extends CreateTrainedModelRespo
  *   stoppingCondition: { // StoppingCondition
  *     maxRuntimeInSeconds: Number("int"),
  *   },
+ *   incrementalTrainingDataChannels: [ // IncrementalTrainingDataChannels
+ *     { // IncrementalTrainingDataChannel
+ *       trainedModelArn: "STRING_VALUE", // required
+ *       versionIdentifier: "STRING_VALUE",
+ *       channelName: "STRING_VALUE", // required
+ *     },
+ *   ],
  *   dataChannels: [ // ModelTrainingDataChannels // required
  *     { // ModelTrainingDataChannel
  *       mlInputChannelArn: "STRING_VALUE", // required
  *       channelName: "STRING_VALUE", // required
+ *       s3DataDistributionType: "FullyReplicated" || "ShardedByS3Key",
  *     },
  *   ],
+ *   trainingInputMode: "File" || "FastFile" || "Pipe",
  *   description: "STRING_VALUE",
  *   kmsKeyArn: "STRING_VALUE",
  *   tags: { // TagMap
@@ -69,6 +78,7 @@ export interface CreateTrainedModelCommandOutput extends CreateTrainedModelRespo
  * const response = await client.send(command);
  * // { // CreateTrainedModelResponse
  * //   trainedModelArn: "STRING_VALUE", // required
+ * //   versionIdentifier: "STRING_VALUE",
  * // };
  *
  * ```
@@ -85,12 +95,18 @@ export interface CreateTrainedModelCommandOutput extends CreateTrainedModelRespo
  * @throws {@link ConflictException} (client fault)
  *  <p>You can't complete this action because another resource depends on this resource.</p>
  *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>An internal service error occurred. Retry your request. If the problem persists, contact AWS Support.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you are requesting does not exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded your service quota.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmAssociationCommand.ts

@@ -64,6 +64,9 @@ export interface DeleteConfiguredModelAlgorithmAssociationCommandOutput extends
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you are requesting does not exist.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *

clients/client-cleanroomsml/src/commands/DeleteMLConfigurationCommand.ts

@@ -56,6 +56,9 @@ export interface DeleteMLConfigurationCommandOutput extends __MetadataBearer {}
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you are requesting does not exist.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request parameters for this request are incorrect.</p>
  *