feat(client-cleanrooms): This release decouples member abilities in a…

… collaboration. With this change, the member who can run queries no longer needs to be the same as the member who can receive results.
aws · Aug 30, 2023 · 915b7c9 · 915b7c9
1 parent 6d84166
commit 915b7c9
Show file tree

Hide file tree

Showing 14 changed files with 717 additions and 315 deletions.
diff --git a/clients/client-cleanrooms/README.md b/clients/client-cleanrooms/README.md
@@ -7,12 +7,14 @@
 AWS SDK for JavaScript CleanRooms Client for Node.js, Browser and React Native.
 
 <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
-<p>Clean Rooms  is an Amazon Web Services service that helps multiple parties to join their data
-together in a secure collaboration workspace. In the collaboration, members who can query
-and receive results can get insights into the collective datasets without either party getting
-access to the other party's raw data.</p>
-<p>To learn more about Clean Rooms  concepts, procedures, and best practices, see the
+<p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
+their data together in a secure collaboration workspace. In the collaboration, members who
+can query and receive results can get insights into the collective datasets without either
+party getting access to the other party's raw data.</p>
+<p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
 <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.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
 

diff --git a/clients/client-cleanrooms/src/CleanRooms.ts b/clients/client-cleanrooms/src/CleanRooms.ts
@@ -983,12 +983,14 @@ export interface CleanRooms {
 /**
  * @public
  * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
- *          <p>Clean Rooms  is an Amazon Web Services service that helps multiple parties to join their data
- *          together in a secure collaboration workspace. In the collaboration, members who can query
- *          and receive results can get insights into the collective datasets without either party getting
- *          access to the other party's raw data.</p>
- *          <p>To learn more about Clean Rooms  concepts, procedures, and best practices, see the
- *          <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
+ *          <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
+ *          their data together in a secure collaboration workspace. In the collaboration, members who
+ *          can query and receive results can get insights into the collective datasets without either
+ *          party getting access to the other party's raw data.</p>
+ *          <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
+ *             <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.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>
  */
 export class CleanRooms extends CleanRoomsClient implements CleanRooms {}
 createAggregatedClient(commands, CleanRooms);
diff --git a/clients/client-cleanrooms/src/CleanRoomsClient.ts b/clients/client-cleanrooms/src/CleanRoomsClient.ts
@@ -464,12 +464,14 @@ export interface CleanRoomsClientResolvedConfig extends CleanRoomsClientResolved
 /**
  * @public
  * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
- *          <p>Clean Rooms  is an Amazon Web Services service that helps multiple parties to join their data
- *          together in a secure collaboration workspace. In the collaboration, members who can query
- *          and receive results can get insights into the collective datasets without either party getting
- *          access to the other party's raw data.</p>
- *          <p>To learn more about Clean Rooms  concepts, procedures, and best practices, see the
- *          <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
+ *          <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
+ *          their data together in a secure collaboration workspace. In the collaboration, members who
+ *          can query and receive results can get insights into the collective datasets without either
+ *          party getting access to the other party's raw data.</p>
+ *          <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
+ *             <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.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>
  */
 export class CleanRoomsClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts b/clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts
@@ -45,7 +45,8 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput
 
 /**
  * @public
- * <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).</p>
+ * <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource
+ *          Names (ARNs).</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts
@@ -50,6 +50,16 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
+ *     outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
+ *       s3: { // ProtectedQueryS3OutputConfiguration
+ *         resultFormat: "STRING_VALUE", // required
+ *         bucket: "STRING_VALUE", // required
+ *         keyPrefix: "STRING_VALUE",
+ *       },
+ *     },
+ *     roleArn: "STRING_VALUE",
+ *   },
  * };
  * const command = new CreateMembershipCommand(input);
  * const response = await client.send(command);
@@ -69,6 +79,16 @@ export interface CreateMembershipCommandOutput extends CreateMembershipOutput, _
  * //       "STRING_VALUE",
  * //     ],
  * //     queryLogStatus: "STRING_VALUE", // required
+ * //     defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
+ * //       outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
+ * //         s3: { // ProtectedQueryS3OutputConfiguration
+ * //           resultFormat: "STRING_VALUE", // required
+ * //           bucket: "STRING_VALUE", // required
+ * //           keyPrefix: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       roleArn: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts b/clients/client-cleanrooms/src/commands/GetMembershipCommand.ts
@@ -64,6 +64,16 @@ export interface GetMembershipCommandOutput extends GetMembershipOutput, __Metad
  * //       "STRING_VALUE",
  * //     ],
  * //     queryLogStatus: "STRING_VALUE", // required
+ * //     defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
+ * //       outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
+ * //         s3: { // ProtectedQueryS3OutputConfiguration
+ * //           resultFormat: "STRING_VALUE", // required
+ * //           bucket: "STRING_VALUE", // required
+ * //           keyPrefix: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       roleArn: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts
@@ -84,6 +84,11 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

diff --git a/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts
@@ -41,7 +41,7 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
 
 /**
  * @public
- * <p>Creates a protected query that is started by Clean Rooms .</p>
+ * <p>Creates a protected query that is started by Clean Rooms.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -101,6 +101,11 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

diff --git a/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts b/clients/client-cleanrooms/src/commands/UpdateMembershipCommand.ts
@@ -46,6 +46,16 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _
  * const input = { // UpdateMembershipInput
  *   membershipIdentifier: "STRING_VALUE", // required
  *   queryLogStatus: "STRING_VALUE",
+ *   defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
+ *     outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
+ *       s3: { // ProtectedQueryS3OutputConfiguration
+ *         resultFormat: "STRING_VALUE", // required
+ *         bucket: "STRING_VALUE", // required
+ *         keyPrefix: "STRING_VALUE",
+ *       },
+ *     },
+ *     roleArn: "STRING_VALUE",
+ *   },
  * };
  * const command = new UpdateMembershipCommand(input);
  * const response = await client.send(command);
@@ -65,6 +75,16 @@ export interface UpdateMembershipCommandOutput extends UpdateMembershipOutput, _
  * //       "STRING_VALUE",
  * //     ],
  * //     queryLogStatus: "STRING_VALUE", // required
+ * //     defaultResultConfiguration: { // MembershipProtectedQueryResultConfiguration
+ * //       outputConfiguration: { // MembershipProtectedQueryOutputConfiguration Union: only one key present
+ * //         s3: { // ProtectedQueryS3OutputConfiguration
+ * //           resultFormat: "STRING_VALUE", // required
+ * //           bucket: "STRING_VALUE", // required
+ * //           keyPrefix: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       roleArn: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts b/clients/client-cleanrooms/src/commands/UpdateProtectedQueryCommand.ts
@@ -85,6 +85,11 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

diff --git a/clients/client-cleanrooms/src/index.ts b/clients/client-cleanrooms/src/index.ts
@@ -2,12 +2,14 @@
 /* eslint-disable */
 /**
  * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
- *          <p>Clean Rooms  is an Amazon Web Services service that helps multiple parties to join their data
- *          together in a secure collaboration workspace. In the collaboration, members who can query
- *          and receive results can get insights into the collective datasets without either party getting
- *          access to the other party's raw data.</p>
- *          <p>To learn more about Clean Rooms  concepts, procedures, and best practices, see the
- *          <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
+ *          <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
+ *          their data together in a secure collaboration workspace. In the collaboration, members who
+ *          can query and receive results can get insights into the collective datasets without either
+ *          party getting access to the other party's raw data.</p>
+ *          <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
+ *             <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.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>
  *
  * @packageDocumentation
  */