@aws-sdk/client-cleanrooms 3.799.0 → 3.800.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,15 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript CleanRooms Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
10
- <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
11
- their data together in a secure collaboration workspace. In the collaboration, members who
12
- can run queries and jobs and receive results can get insights into the collective datasets without either
13
- party getting access to the other party's raw data.</p>
14
- <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
15
- <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
16
- <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
17
- <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
9
+ <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 run queries and jobs 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>
18
10
 
19
11
  ## Installing
20
12
 
package/dist-cjs/index.js CHANGED
@@ -161,6 +161,7 @@ __export(index_exports, {
161
161
  ProtectedJobOutputConfigurationOutput: () => ProtectedJobOutputConfigurationOutput,
162
162
  ProtectedJobStatus: () => ProtectedJobStatus,
163
163
  ProtectedJobType: () => ProtectedJobType,
164
+ ProtectedQueryDistributeOutputConfigurationLocation: () => ProtectedQueryDistributeOutputConfigurationLocation,
164
165
  ProtectedQueryFilterSensitiveLog: () => ProtectedQueryFilterSensitiveLog,
165
166
  ProtectedQueryOutput: () => ProtectedQueryOutput,
166
167
  ProtectedQueryOutputConfiguration: () => ProtectedQueryOutputConfiguration,
@@ -5001,14 +5002,24 @@ var ProtectedQueryOutput;
5001
5002
  ProtectedQueryOutput2.visit = /* @__PURE__ */ __name((value, visitor) => {
5002
5003
  if (value.s3 !== void 0) return visitor.s3(value.s3);
5003
5004
  if (value.memberList !== void 0) return visitor.memberList(value.memberList);
5005
+ if (value.distribute !== void 0) return visitor.distribute(value.distribute);
5004
5006
  return visitor._(value.$unknown[0], value.$unknown[1]);
5005
5007
  }, "visit");
5006
5008
  })(ProtectedQueryOutput || (ProtectedQueryOutput = {}));
5009
+ var ProtectedQueryDistributeOutputConfigurationLocation;
5010
+ ((ProtectedQueryDistributeOutputConfigurationLocation2) => {
5011
+ ProtectedQueryDistributeOutputConfigurationLocation2.visit = /* @__PURE__ */ __name((value, visitor) => {
5012
+ if (value.s3 !== void 0) return visitor.s3(value.s3);
5013
+ if (value.member !== void 0) return visitor.member(value.member);
5014
+ return visitor._(value.$unknown[0], value.$unknown[1]);
5015
+ }, "visit");
5016
+ })(ProtectedQueryDistributeOutputConfigurationLocation || (ProtectedQueryDistributeOutputConfigurationLocation = {}));
5007
5017
  var ProtectedQueryOutputConfiguration;
5008
5018
  ((ProtectedQueryOutputConfiguration2) => {
5009
5019
  ProtectedQueryOutputConfiguration2.visit = /* @__PURE__ */ __name((value, visitor) => {
5010
5020
  if (value.s3 !== void 0) return visitor.s3(value.s3);
5011
5021
  if (value.member !== void 0) return visitor.member(value.member);
5022
+ if (value.distribute !== void 0) return visitor.distribute(value.distribute);
5012
5023
  return visitor._(value.$unknown[0], value.$unknown[1]);
5013
5024
  }, "visit");
5014
5025
  })(ProtectedQueryOutputConfiguration || (ProtectedQueryOutputConfiguration = {}));
@@ -6109,6 +6120,7 @@ var paginateListSchemas = (0, import_core.createPaginator)(CleanRoomsClient, Lis
6109
6120
  WorkerComputeType,
6110
6121
  ComputeConfiguration,
6111
6122
  ProtectedQueryOutput,
6123
+ ProtectedQueryDistributeOutputConfigurationLocation,
6112
6124
  ProtectedQueryOutputConfiguration,
6113
6125
  ProtectedQueryStatus,
6114
6126
  ProtectedJobAnalysisType,
@@ -26,9 +26,21 @@ export var ProtectedQueryOutput;
26
26
  return visitor.s3(value.s3);
27
27
  if (value.memberList !== undefined)
28
28
  return visitor.memberList(value.memberList);
29
+ if (value.distribute !== undefined)
30
+ return visitor.distribute(value.distribute);
29
31
  return visitor._(value.$unknown[0], value.$unknown[1]);
30
32
  };
31
33
  })(ProtectedQueryOutput || (ProtectedQueryOutput = {}));
34
+ export var ProtectedQueryDistributeOutputConfigurationLocation;
35
+ (function (ProtectedQueryDistributeOutputConfigurationLocation) {
36
+ ProtectedQueryDistributeOutputConfigurationLocation.visit = (value, visitor) => {
37
+ if (value.s3 !== undefined)
38
+ return visitor.s3(value.s3);
39
+ if (value.member !== undefined)
40
+ return visitor.member(value.member);
41
+ return visitor._(value.$unknown[0], value.$unknown[1]);
42
+ };
43
+ })(ProtectedQueryDistributeOutputConfigurationLocation || (ProtectedQueryDistributeOutputConfigurationLocation = {}));
32
44
  export var ProtectedQueryOutputConfiguration;
33
45
  (function (ProtectedQueryOutputConfiguration) {
34
46
  ProtectedQueryOutputConfiguration.visit = (value, visitor) => {
@@ -36,6 +48,8 @@ export var ProtectedQueryOutputConfiguration;
36
48
  return visitor.s3(value.s3);
37
49
  if (value.member !== undefined)
38
50
  return visitor.member(value.member);
51
+ if (value.distribute !== undefined)
52
+ return visitor.distribute(value.distribute);
39
53
  return visitor._(value.$unknown[0], value.$unknown[1]);
40
54
  };
41
55
  })(ProtectedQueryOutputConfiguration || (ProtectedQueryOutputConfiguration = {}));
@@ -594,15 +594,7 @@ export interface CleanRooms {
594
594
  updateProtectedQuery(args: UpdateProtectedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProtectedQueryCommandOutput) => void): void;
595
595
  }
596
596
  /**
597
- * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
598
- * <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
599
- * their data together in a secure collaboration workspace. In the collaboration, members who
600
- * can run queries and jobs and receive results can get insights into the collective datasets without either
601
- * party getting access to the other party's raw data.</p>
602
- * <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
603
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
604
- * <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
605
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
597
+ * <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 run queries and jobs 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>
606
598
  * @public
607
599
  */
608
600
  export declare class CleanRooms extends CleanRoomsClient implements CleanRooms {
@@ -253,15 +253,7 @@ export type CleanRoomsClientResolvedConfigType = __SmithyResolvedConfiguration<_
253
253
  export interface CleanRoomsClientResolvedConfig extends CleanRoomsClientResolvedConfigType {
254
254
  }
255
255
  /**
256
- * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
257
- * <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
258
- * their data together in a secure collaboration workspace. In the collaboration, members who
259
- * can run queries and jobs and receive results can get insights into the collective datasets without either
260
- * party getting access to the other party's raw data.</p>
261
- * <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
262
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
263
- * <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
264
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
256
+ * <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 run queries and jobs 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>
265
257
  * @public
266
258
  */
267
259
  export declare class CleanRoomsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CleanRoomsClientResolvedConfig> {
@@ -27,8 +27,7 @@ declare const BatchGetCollaborationAnalysisTemplateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource
31
- * Names (ARNs).</p>
30
+ * <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const CreateConfiguredTableAnalysisRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new analysis rule for a configured table. Currently, only one analysis rule
31
- * can be created for a given configured table.</p>
30
+ * <p>Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const CreateConfiguredTableAssociationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a configured table association. A configured table association links a
31
- * configured table with a collaboration.</p>
30
+ * <p>Creates a configured table association. A configured table association links a configured table with a collaboration.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const CreateMembershipCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a membership for a specific collaboration identifier and joins the
31
- * collaboration.</p>
30
+ * <p>Creates a membership for a specific collaboration identifier and joins the collaboration.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const DeleteMemberCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes the specified member from a collaboration. The removed member is placed in the
31
- * Removed status and can't interact with the collaboration. The removed member's data is
32
- * inaccessible to active members of the collaboration.</p>
30
+ * <p>Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -65,6 +65,21 @@ declare const GetProtectedQueryCommand_base: {
65
65
  * // member: { // ProtectedQueryMemberOutputConfiguration
66
66
  * // accountId: "STRING_VALUE", // required
67
67
  * // },
68
+ * // distribute: { // ProtectedQueryDistributeOutputConfiguration
69
+ * // locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
70
+ * // { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
71
+ * // s3: {
72
+ * // resultFormat: "STRING_VALUE", // required
73
+ * // bucket: "STRING_VALUE", // required
74
+ * // keyPrefix: "STRING_VALUE",
75
+ * // singleFileOutput: true || false,
76
+ * // },
77
+ * // member: {
78
+ * // accountId: "STRING_VALUE", // required
79
+ * // },
80
+ * // },
81
+ * // ],
82
+ * // },
68
83
  * // },
69
84
  * // },
70
85
  * // statistics: { // ProtectedQueryStatistics
@@ -83,6 +98,16 @@ declare const GetProtectedQueryCommand_base: {
83
98
  * // accountId: "STRING_VALUE", // required
84
99
  * // },
85
100
  * // ],
101
+ * // distribute: { // ProtectedQueryDistributeOutput
102
+ * // s3: {
103
+ * // location: "STRING_VALUE", // required
104
+ * // },
105
+ * // memberList: [
106
+ * // {
107
+ * // accountId: "STRING_VALUE", // required
108
+ * // },
109
+ * // ],
110
+ * // },
86
111
  * // },
87
112
  * // },
88
113
  * // error: { // ProtectedQueryError
@@ -55,6 +55,21 @@ declare const StartProtectedQueryCommand_base: {
55
55
  * member: { // ProtectedQueryMemberOutputConfiguration
56
56
  * accountId: "STRING_VALUE", // required
57
57
  * },
58
+ * distribute: { // ProtectedQueryDistributeOutputConfiguration
59
+ * locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
60
+ * { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
61
+ * s3: {
62
+ * resultFormat: "STRING_VALUE", // required
63
+ * bucket: "STRING_VALUE", // required
64
+ * keyPrefix: "STRING_VALUE",
65
+ * singleFileOutput: true || false,
66
+ * },
67
+ * member: {
68
+ * accountId: "STRING_VALUE", // required
69
+ * },
70
+ * },
71
+ * ],
72
+ * },
58
73
  * },
59
74
  * },
60
75
  * computeConfiguration: { // ComputeConfiguration Union: only one key present
@@ -91,6 +106,21 @@ declare const StartProtectedQueryCommand_base: {
91
106
  * // member: { // ProtectedQueryMemberOutputConfiguration
92
107
  * // accountId: "STRING_VALUE", // required
93
108
  * // },
109
+ * // distribute: { // ProtectedQueryDistributeOutputConfiguration
110
+ * // locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
111
+ * // { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
112
+ * // s3: {
113
+ * // resultFormat: "STRING_VALUE", // required
114
+ * // bucket: "STRING_VALUE", // required
115
+ * // keyPrefix: "STRING_VALUE",
116
+ * // singleFileOutput: true || false,
117
+ * // },
118
+ * // member: {
119
+ * // accountId: "STRING_VALUE", // required
120
+ * // },
121
+ * // },
122
+ * // ],
123
+ * // },
94
124
  * // },
95
125
  * // },
96
126
  * // statistics: { // ProtectedQueryStatistics
@@ -109,6 +139,16 @@ declare const StartProtectedQueryCommand_base: {
109
139
  * // accountId: "STRING_VALUE", // required
110
140
  * // },
111
141
  * // ],
142
+ * // distribute: { // ProtectedQueryDistributeOutput
143
+ * // s3: {
144
+ * // location: "STRING_VALUE", // required
145
+ * // },
146
+ * // memberList: [
147
+ * // {
148
+ * // accountId: "STRING_VALUE", // required
149
+ * // },
150
+ * // ],
151
+ * // },
112
152
  * // },
113
153
  * // },
114
154
  * // error: { // ProtectedQueryError
@@ -66,6 +66,21 @@ declare const UpdateProtectedQueryCommand_base: {
66
66
  * // member: { // ProtectedQueryMemberOutputConfiguration
67
67
  * // accountId: "STRING_VALUE", // required
68
68
  * // },
69
+ * // distribute: { // ProtectedQueryDistributeOutputConfiguration
70
+ * // locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
71
+ * // { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
72
+ * // s3: {
73
+ * // resultFormat: "STRING_VALUE", // required
74
+ * // bucket: "STRING_VALUE", // required
75
+ * // keyPrefix: "STRING_VALUE",
76
+ * // singleFileOutput: true || false,
77
+ * // },
78
+ * // member: {
79
+ * // accountId: "STRING_VALUE", // required
80
+ * // },
81
+ * // },
82
+ * // ],
83
+ * // },
69
84
  * // },
70
85
  * // },
71
86
  * // statistics: { // ProtectedQueryStatistics
@@ -84,6 +99,16 @@ declare const UpdateProtectedQueryCommand_base: {
84
99
  * // accountId: "STRING_VALUE", // required
85
100
  * // },
86
101
  * // ],
102
+ * // distribute: { // ProtectedQueryDistributeOutput
103
+ * // s3: {
104
+ * // location: "STRING_VALUE", // required
105
+ * // },
106
+ * // memberList: [
107
+ * // {
108
+ * // accountId: "STRING_VALUE", // required
109
+ * // },
110
+ * // ],
111
+ * // },
87
112
  * // },
88
113
  * // },
89
114
  * // error: { // ProtectedQueryError
@@ -1,13 +1,5 @@
1
1
  /**
2
- * <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
3
- * <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
4
- * their data together in a secure collaboration workspace. In the collaboration, members who
5
- * can run queries and jobs and receive results can get insights into the collective datasets without either
6
- * party getting access to the other party's raw data.</p>
7
- * <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
8
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
9
- * <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
10
- * <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
2
+ * <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 run queries and jobs 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>
11
3
  *
12
4
  * @packageDocumentation
13
5
  */