@aws-sdk/client-cleanrooms 3.398.0 → 3.403.0

package/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
 

package/dist-cjs/models/models_0.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetCollaborationAnalysisTemplateOutputFilterSensitiveLog = exports.BatchGetCollaborationAnalysisTemplateOutputFilterSensitiveLog = exports.CollaborationAnalysisTemplateFilterSensitiveLog = exports.UpdateAnalysisTemplateOutputFilterSensitiveLog = exports.GetAnalysisTemplateOutputFilterSensitiveLog = exports.CreateAnalysisTemplateOutputFilterSensitiveLog = exports.CreateAnalysisTemplateInputFilterSensitiveLog = exports.AnalysisTemplateFilterSensitiveLog = exports.AnalysisSourceFilterSensitiveLog = exports.AnalysisParameterFilterSensitiveLog = exports.TargetProtectedQueryStatus = exports.ProtectedQueryType = exports.ProtectedQueryStatus = exports.ProtectedQueryOutputConfiguration = exports.ResultFormat = exports.ProtectedQueryOutput = exports.MembershipStatus = exports.MembershipQueryLogStatus = exports.ConfiguredTableAnalysisRulePolicy = exports.ConfiguredTableAnalysisRulePolicyV1 = exports.ConfiguredTableAnalysisRuleType = exports.TableReference = exports.FilterableMemberStatus = exports.MemberStatus = exports.CollaborationQueryLogStatus = exports.MemberAbility = exports.SchemaType = exports.ValidationException = exports.ValidationExceptionReason = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ConflictException = exports.ResourceType = exports.ConflictExceptionReason = exports.AnalysisSource = exports.AnalysisRuleType = exports.AnalysisRulePolicy = exports.AnalysisRulePolicyV1 = exports.ScalarFunctions = exports.JoinRequiredOption = exports.JoinOperator = exports.ParameterType = exports.AnalysisMethod = exports.AnalysisFormat = exports.AggregationType = exports.AggregateFunctionName = exports.AccessDeniedException = exports.AccessDeniedExceptionReason = void 0;
-exports.UpdateProtectedQueryOutputFilterSensitiveLog = exports.StartProtectedQueryOutputFilterSensitiveLog = exports.StartProtectedQueryInputFilterSensitiveLog = exports.GetProtectedQueryOutputFilterSensitiveLog = exports.ProtectedQueryFilterSensitiveLog = exports.ProtectedQuerySQLParametersFilterSensitiveLog = void 0;
+exports.BatchGetCollaborationAnalysisTemplateOutputFilterSensitiveLog = exports.CollaborationAnalysisTemplateFilterSensitiveLog = exports.UpdateAnalysisTemplateOutputFilterSensitiveLog = exports.GetAnalysisTemplateOutputFilterSensitiveLog = exports.CreateAnalysisTemplateOutputFilterSensitiveLog = exports.CreateAnalysisTemplateInputFilterSensitiveLog = exports.AnalysisTemplateFilterSensitiveLog = exports.AnalysisSourceFilterSensitiveLog = exports.AnalysisParameterFilterSensitiveLog = exports.TargetProtectedQueryStatus = exports.ProtectedQueryType = exports.ProtectedQueryStatus = exports.ProtectedQueryOutputConfiguration = exports.ProtectedQueryOutput = exports.MembershipStatus = exports.MembershipQueryLogStatus = exports.MembershipProtectedQueryOutputConfiguration = exports.ResultFormat = exports.ConfiguredTableAnalysisRulePolicy = exports.ConfiguredTableAnalysisRulePolicyV1 = exports.ConfiguredTableAnalysisRuleType = exports.TableReference = exports.FilterableMemberStatus = exports.MemberStatus = exports.CollaborationQueryLogStatus = exports.MemberAbility = exports.SchemaType = exports.ValidationException = exports.ValidationExceptionReason = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ConflictException = exports.ResourceType = exports.ConflictExceptionReason = exports.AnalysisSource = exports.AnalysisRuleType = exports.AnalysisRulePolicy = exports.AnalysisRulePolicyV1 = exports.ScalarFunctions = exports.JoinRequiredOption = exports.JoinOperator = exports.ParameterType = exports.AnalysisMethod = exports.AnalysisFormat = exports.AggregationType = exports.AggregateFunctionName = exports.AccessDeniedException = exports.AccessDeniedExceptionReason = void 0;
+exports.UpdateProtectedQueryOutputFilterSensitiveLog = exports.StartProtectedQueryOutputFilterSensitiveLog = exports.StartProtectedQueryInputFilterSensitiveLog = exports.GetProtectedQueryOutputFilterSensitiveLog = exports.ProtectedQueryFilterSensitiveLog = exports.ProtectedQuerySQLParametersFilterSensitiveLog = exports.GetCollaborationAnalysisTemplateOutputFilterSensitiveLog = void 0;
 const smithy_client_1 = require("@smithy/smithy-client");
 const CleanRoomsServiceException_1 = require("./CleanRoomsServiceException");
 exports.AccessDeniedExceptionReason = {
@@ -267,6 +267,18 @@ var ConfiguredTableAnalysisRulePolicy;
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(ConfiguredTableAnalysisRulePolicy = exports.ConfiguredTableAnalysisRulePolicy || (exports.ConfiguredTableAnalysisRulePolicy = {}));
+exports.ResultFormat = {
+    CSV: "CSV",
+    PARQUET: "PARQUET",
+};
+var MembershipProtectedQueryOutputConfiguration;
+(function (MembershipProtectedQueryOutputConfiguration) {
+    MembershipProtectedQueryOutputConfiguration.visit = (value, visitor) => {
+        if (value.s3 !== undefined)
+            return visitor.s3(value.s3);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(MembershipProtectedQueryOutputConfiguration = exports.MembershipProtectedQueryOutputConfiguration || (exports.MembershipProtectedQueryOutputConfiguration = {}));
 exports.MembershipQueryLogStatus = {
     DISABLED: "DISABLED",
     ENABLED: "ENABLED",
@@ -281,13 +293,11 @@ var ProtectedQueryOutput;
     ProtectedQueryOutput.visit = (value, visitor) => {
         if (value.s3 !== undefined)
             return visitor.s3(value.s3);
+        if (value.memberList !== undefined)
+            return visitor.memberList(value.memberList);
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(ProtectedQueryOutput = exports.ProtectedQueryOutput || (exports.ProtectedQueryOutput = {}));
-exports.ResultFormat = {
-    CSV: "CSV",
-    PARQUET: "PARQUET",
-};
 var ProtectedQueryOutputConfiguration;
 (function (ProtectedQueryOutputConfiguration) {
     ProtectedQueryOutputConfiguration.visit = (value, visitor) => {

package/dist-cjs/protocols/Aws_restJson1.js

@@ -194,6 +194,7 @@ const se_CreateMembershipCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         collaborationIdentifier: [],
+        defaultResultConfiguration: (_) => (0, smithy_client_1._json)(_),
         queryLogStatus: [],
         tags: (_) => (0, smithy_client_1._json)(_),
     }));
@@ -944,6 +945,7 @@ const se_UpdateMembershipCommand = async (input, context) => {
     resolvedPath = (0, smithy_client_1.resolvedPath)(resolvedPath, input, "membershipIdentifier", () => input.membershipIdentifier, "{membershipIdentifier}", false);
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
+        defaultResultConfiguration: (_) => (0, smithy_client_1._json)(_),
         queryLogStatus: [],
     }));
     return new protocol_http_1.HttpRequest({
@@ -3365,6 +3367,7 @@ const de_Membership = (output, context) => {
         collaborationId: smithy_client_1.expectString,
         collaborationName: smithy_client_1.expectString,
         createTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
+        defaultResultConfiguration: smithy_client_1._json,
         id: smithy_client_1.expectString,
         memberAbilities: smithy_client_1._json,
         queryLogStatus: smithy_client_1.expectString,

package/dist-es/models/models_0.js

@@ -256,6 +256,18 @@ export var ConfiguredTableAnalysisRulePolicy;
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(ConfiguredTableAnalysisRulePolicy || (ConfiguredTableAnalysisRulePolicy = {}));
+export const ResultFormat = {
+    CSV: "CSV",
+    PARQUET: "PARQUET",
+};
+export var MembershipProtectedQueryOutputConfiguration;
+(function (MembershipProtectedQueryOutputConfiguration) {
+    MembershipProtectedQueryOutputConfiguration.visit = (value, visitor) => {
+        if (value.s3 !== undefined)
+            return visitor.s3(value.s3);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(MembershipProtectedQueryOutputConfiguration || (MembershipProtectedQueryOutputConfiguration = {}));
 export const MembershipQueryLogStatus = {
     DISABLED: "DISABLED",
     ENABLED: "ENABLED",
@@ -270,13 +282,11 @@ export var ProtectedQueryOutput;
     ProtectedQueryOutput.visit = (value, visitor) => {
         if (value.s3 !== undefined)
             return visitor.s3(value.s3);
+        if (value.memberList !== undefined)
+            return visitor.memberList(value.memberList);
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(ProtectedQueryOutput || (ProtectedQueryOutput = {}));
-export const ResultFormat = {
-    CSV: "CSV",
-    PARQUET: "PARQUET",
-};
 export var ProtectedQueryOutputConfiguration;
 (function (ProtectedQueryOutputConfiguration) {
     ProtectedQueryOutputConfiguration.visit = (value, visitor) => {

package/dist-es/protocols/Aws_restJson1.js

@@ -183,6 +183,7 @@ export const se_CreateMembershipCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         collaborationIdentifier: [],
+        defaultResultConfiguration: (_) => _json(_),
         queryLogStatus: [],
         tags: (_) => _json(_),
     }));
@@ -897,6 +898,7 @@ export const se_UpdateMembershipCommand = async (input, context) => {
     resolvedPath = __resolvedPath(resolvedPath, input, "membershipIdentifier", () => input.membershipIdentifier, "{membershipIdentifier}", false);
     let body;
     body = JSON.stringify(take(input, {
+        defaultResultConfiguration: (_) => _json(_),
         queryLogStatus: [],
     }));
     return new __HttpRequest({
@@ -3271,6 +3273,7 @@ const de_Membership = (output, context) => {
         collaborationId: __expectString,
         collaborationName: __expectString,
         createTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+        defaultResultConfiguration: _json,
         id: __expectString,
         memberAbilities: _json,
         queryLogStatus: __expectString,

package/dist-types/CleanRooms.d.ts

@@ -320,12 +320,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 declare class CleanRooms extends CleanRoomsClient implements CleanRooms {
 }

package/dist-types/CleanRoomsClient.d.ts

@@ -196,12 +196,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 declare class CleanRoomsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CleanRoomsClientResolvedConfig> {
     /**

package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts

@@ -23,7 +23,8 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput extends Batc
 }
 /**
  * @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

package/dist-types/commands/CreateMembershipCommand.d.ts

@@ -37,6 +37,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);
@@ -56,6 +66,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",
+ * //     },
  * //   },
  * // };
  *

package/dist-types/commands/GetMembershipCommand.d.ts

@@ -51,6 +51,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",
+ * //     },
  * //   },
  * // };
  *

package/dist-types/commands/GetProtectedQueryCommand.d.ts

@@ -67,6 +67,11 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

package/dist-types/commands/StartProtectedQueryCommand.d.ts

@@ -23,7 +23,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
@@ -83,6 +83,11 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

package/dist-types/commands/UpdateMembershipCommand.d.ts

@@ -33,6 +33,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);
@@ -52,6 +62,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",
+ * //     },
  * //   },
  * // };
  *

package/dist-types/commands/UpdateProtectedQueryCommand.d.ts

@@ -68,6 +68,11 @@ export interface UpdateProtectedQueryCommandOutput extends UpdateProtectedQueryO
  * //         s3: { // ProtectedQueryS3Output
  * //           location: "STRING_VALUE", // required
  * //         },
+ * //         memberList: [ // ProtectedQueryMemberOutputList
+ * //           { // ProtectedQuerySingleMemberOutput
+ * //             accountId: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //     },
  * //     error: { // ProtectedQueryError

package/dist-types/index.d.ts

@@ -1,11 +1,13 @@
 /**
  * <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
  */