Skip to content

Commit f6a809d

Browse files
author
awstools
committed
feat(client-cleanrooms): This release adds support for ProtectedQuery results to be delivered to more than one collaboration member via the new distribute output configuration in StartProtectedQuery.
1 parent e89084d commit f6a809d

16 files changed

+717
-863
lines changed

‎clients/client-cleanrooms/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,7 @@
66

77
AWS SDK for JavaScript CleanRooms Client for Node.js, Browser and React Native.
88

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>
1810

1911
## Installing
2012

‎clients/client-cleanrooms/src/CleanRooms.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1878,15 +1878,7 @@ export interface CleanRooms {
18781878
}
18791879

18801880
/**
1881-
* <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
1882-
* <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
1883-
* their data together in a secure collaboration workspace. In the collaboration, members who
1884-
* can run queries and jobs and receive results can get insights into the collective datasets without either
1885-
* party getting access to the other party's raw data.</p>
1886-
* <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
1887-
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
1888-
* <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
1889-
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
1881+
* <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>
18901882
* @public
18911883
*/
18921884
export class CleanRooms extends CleanRoomsClient implements CleanRooms {}

‎clients/client-cleanrooms/src/CleanRoomsClient.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -703,15 +703,7 @@ export type CleanRoomsClientResolvedConfigType = __SmithyResolvedConfiguration<_
703703
export interface CleanRoomsClientResolvedConfig extends CleanRoomsClientResolvedConfigType {}
704704

705705
/**
706-
* <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
707-
* <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
708-
* their data together in a secure collaboration workspace. In the collaboration, members who
709-
* can run queries and jobs and receive results can get insights into the collective datasets without either
710-
* party getting access to the other party's raw data.</p>
711-
* <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
712-
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
713-
* <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the
714-
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.</p>
706+
* <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>
715707
* @public
716708
*/
717709
export class CleanRoomsClient extends __Client<

‎clients/client-cleanrooms/src/commands/BatchGetCollaborationAnalysisTemplateCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource
41-
* Names (ARNs).</p>
40+
* <p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).</p>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
4443
* ```javascript

‎clients/client-cleanrooms/src/commands/CreateConfiguredTableAnalysisRuleCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CreateConfiguredTableAnalysisRuleCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Creates a new analysis rule for a configured table. Currently, only one analysis rule
37-
* can be created for a given configured table.</p>
36+
* <p>Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.</p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript

‎clients/client-cleanrooms/src/commands/CreateConfiguredTableAssociationCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CreateConfiguredTableAssociationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Creates a configured table association. A configured table association links a
37-
* configured table with a collaboration.</p>
36+
* <p>Creates a configured table association. A configured table association links a configured table with a collaboration.</p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript

‎clients/client-cleanrooms/src/commands/CreateMembershipCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface CreateMembershipCommandInput extends CreateMembershipInput {}
2828
export interface CreateMembershipCommandOutput extends CreateMembershipOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a membership for a specific collaboration identifier and joins the
32-
* collaboration.</p>
31+
* <p>Creates a membership for a specific collaboration identifier and joins the collaboration.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

‎clients/client-cleanrooms/src/commands/DeleteMemberCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface DeleteMemberCommandInput extends DeleteMemberInput {}
2828
export interface DeleteMemberCommandOutput extends DeleteMemberOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes the specified member from a collaboration. The removed member is placed in the
32-
* Removed status and can't interact with the collaboration. The removed member's data is
33-
* inaccessible to active members of the collaboration.</p>
31+
* <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>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

‎clients/client-cleanrooms/src/commands/GetProtectedQueryCommand.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,21 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
7070
* // member: { // ProtectedQueryMemberOutputConfiguration
7171
* // accountId: "STRING_VALUE", // required
7272
* // },
73+
* // distribute: { // ProtectedQueryDistributeOutputConfiguration
74+
* // locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
75+
* // { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
76+
* // s3: {
77+
* // resultFormat: "STRING_VALUE", // required
78+
* // bucket: "STRING_VALUE", // required
79+
* // keyPrefix: "STRING_VALUE",
80+
* // singleFileOutput: true || false,
81+
* // },
82+
* // member: {
83+
* // accountId: "STRING_VALUE", // required
84+
* // },
85+
* // },
86+
* // ],
87+
* // },
7388
* // },
7489
* // },
7590
* // statistics: { // ProtectedQueryStatistics
@@ -88,6 +103,16 @@ export interface GetProtectedQueryCommandOutput extends GetProtectedQueryOutput,
88103
* // accountId: "STRING_VALUE", // required
89104
* // },
90105
* // ],
106+
* // distribute: { // ProtectedQueryDistributeOutput
107+
* // s3: {
108+
* // location: "STRING_VALUE", // required
109+
* // },
110+
* // memberList: [
111+
* // {
112+
* // accountId: "STRING_VALUE", // required
113+
* // },
114+
* // ],
115+
* // },
91116
* // },
92117
* // },
93118
* // error: { // ProtectedQueryError

‎clients/client-cleanrooms/src/commands/StartProtectedQueryCommand.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,21 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
6161
* member: { // ProtectedQueryMemberOutputConfiguration
6262
* accountId: "STRING_VALUE", // required
6363
* },
64+
* distribute: { // ProtectedQueryDistributeOutputConfiguration
65+
* locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
66+
* { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
67+
* s3: {
68+
* resultFormat: "STRING_VALUE", // required
69+
* bucket: "STRING_VALUE", // required
70+
* keyPrefix: "STRING_VALUE",
71+
* singleFileOutput: true || false,
72+
* },
73+
* member: {
74+
* accountId: "STRING_VALUE", // required
75+
* },
76+
* },
77+
* ],
78+
* },
6479
* },
6580
* },
6681
* computeConfiguration: { // ComputeConfiguration Union: only one key present
@@ -97,6 +112,21 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
97112
* // member: { // ProtectedQueryMemberOutputConfiguration
98113
* // accountId: "STRING_VALUE", // required
99114
* // },
115+
* // distribute: { // ProtectedQueryDistributeOutputConfiguration
116+
* // locations: [ // ProtectedQueryDistributeOutputConfigurationLocations // required
117+
* // { // ProtectedQueryDistributeOutputConfigurationLocation Union: only one key present
118+
* // s3: {
119+
* // resultFormat: "STRING_VALUE", // required
120+
* // bucket: "STRING_VALUE", // required
121+
* // keyPrefix: "STRING_VALUE",
122+
* // singleFileOutput: true || false,
123+
* // },
124+
* // member: {
125+
* // accountId: "STRING_VALUE", // required
126+
* // },
127+
* // },
128+
* // ],
129+
* // },
100130
* // },
101131
* // },
102132
* // statistics: { // ProtectedQueryStatistics
@@ -115,6 +145,16 @@ export interface StartProtectedQueryCommandOutput extends StartProtectedQueryOut
115145
* // accountId: "STRING_VALUE", // required
116146
* // },
117147
* // ],
148+
* // distribute: { // ProtectedQueryDistributeOutput
149+
* // s3: {
150+
* // location: "STRING_VALUE", // required
151+
* // },
152+
* // memberList: [
153+
* // {
154+
* // accountId: "STRING_VALUE", // required
155+
* // },
156+
* // ],
157+
* // },
118158
* // },
119159
* // },
120160
* // error: { // ProtectedQueryError

0 commit comments

Comments
 (0)