Skip to content

Commit 06fd603

Browse files
author
awstools
committed
feat(client-cleanrooms): This release adds support for PySpark jobs. Customers can now analyze data by running jobs using approved PySpark analysis templates.
1 parent ab2c6bb commit 06fd603

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+6126
-1445
lines changed

‎clients/client-cleanrooms/README.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AWS SDK for JavaScript CleanRooms Client for Node.js, Browser and React Native.
99
<p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
1010
<p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
1111
their data together in a secure collaboration workspace. In the collaboration, members who
12-
can query and receive results can get insights into the collective datasets without either
12+
can run queries and jobs and receive results can get insights into the collective datasets without either
1313
party getting access to the other party's raw data.</p>
1414
<p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
1515
<a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>
@@ -538,6 +538,14 @@ GetPrivacyBudgetTemplate
538538

539539
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/GetPrivacyBudgetTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/GetPrivacyBudgetTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/GetPrivacyBudgetTemplateCommandOutput/)
540540

541+
</details>
542+
<details>
543+
<summary>
544+
GetProtectedJob
545+
</summary>
546+
547+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/GetProtectedJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/GetProtectedJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/GetProtectedJobCommandOutput/)
548+
541549
</details>
542550
<details>
543551
<summary>
@@ -690,6 +698,14 @@ ListPrivacyBudgetTemplates
690698

691699
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/ListPrivacyBudgetTemplatesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/ListPrivacyBudgetTemplatesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/ListPrivacyBudgetTemplatesCommandOutput/)
692700

701+
</details>
702+
<details>
703+
<summary>
704+
ListProtectedJobs
705+
</summary>
706+
707+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/ListProtectedJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/ListProtectedJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/ListProtectedJobsCommandOutput/)
708+
693709
</details>
694710
<details>
695711
<summary>
@@ -730,6 +746,14 @@ PreviewPrivacyImpact
730746

731747
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/PreviewPrivacyImpactCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/PreviewPrivacyImpactCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/PreviewPrivacyImpactCommandOutput/)
732748

749+
</details>
750+
<details>
751+
<summary>
752+
StartProtectedJob
753+
</summary>
754+
755+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/StartProtectedJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/StartProtectedJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/StartProtectedJobCommandOutput/)
756+
733757
</details>
734758
<details>
735759
<summary>
@@ -842,6 +866,14 @@ UpdatePrivacyBudgetTemplate
842866

843867
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/UpdatePrivacyBudgetTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/UpdatePrivacyBudgetTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/UpdatePrivacyBudgetTemplateCommandOutput/)
844868

869+
</details>
870+
<details>
871+
<summary>
872+
UpdateProtectedJob
873+
</summary>
874+
875+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cleanrooms/command/UpdateProtectedJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/UpdateProtectedJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cleanrooms/Interface/UpdateProtectedJobCommandOutput/)
876+
845877
</details>
846878
<details>
847879
<summary>

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

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,11 @@ import {
208208
GetPrivacyBudgetTemplateCommandInput,
209209
GetPrivacyBudgetTemplateCommandOutput,
210210
} from "./commands/GetPrivacyBudgetTemplateCommand";
211+
import {
212+
GetProtectedJobCommand,
213+
GetProtectedJobCommandInput,
214+
GetProtectedJobCommandOutput,
215+
} from "./commands/GetProtectedJobCommand";
211216
import {
212217
GetProtectedQueryCommand,
213218
GetProtectedQueryCommandInput,
@@ -295,6 +300,11 @@ import {
295300
ListPrivacyBudgetTemplatesCommandInput,
296301
ListPrivacyBudgetTemplatesCommandOutput,
297302
} from "./commands/ListPrivacyBudgetTemplatesCommand";
303+
import {
304+
ListProtectedJobsCommand,
305+
ListProtectedJobsCommandInput,
306+
ListProtectedJobsCommandOutput,
307+
} from "./commands/ListProtectedJobsCommand";
298308
import {
299309
ListProtectedQueriesCommand,
300310
ListProtectedQueriesCommandInput,
@@ -316,6 +326,11 @@ import {
316326
PreviewPrivacyImpactCommandInput,
317327
PreviewPrivacyImpactCommandOutput,
318328
} from "./commands/PreviewPrivacyImpactCommand";
329+
import {
330+
StartProtectedJobCommand,
331+
StartProtectedJobCommandInput,
332+
StartProtectedJobCommandOutput,
333+
} from "./commands/StartProtectedJobCommand";
319334
import {
320335
StartProtectedQueryCommand,
321336
StartProtectedQueryCommandInput,
@@ -382,6 +397,11 @@ import {
382397
UpdatePrivacyBudgetTemplateCommandInput,
383398
UpdatePrivacyBudgetTemplateCommandOutput,
384399
} from "./commands/UpdatePrivacyBudgetTemplateCommand";
400+
import {
401+
UpdateProtectedJobCommand,
402+
UpdateProtectedJobCommandInput,
403+
UpdateProtectedJobCommandOutput,
404+
} from "./commands/UpdateProtectedJobCommand";
385405
import {
386406
UpdateProtectedQueryCommand,
387407
UpdateProtectedQueryCommandInput,
@@ -430,6 +450,7 @@ const commands = {
430450
GetIdNamespaceAssociationCommand,
431451
GetMembershipCommand,
432452
GetPrivacyBudgetTemplateCommand,
453+
GetProtectedJobCommand,
433454
GetProtectedQueryCommand,
434455
GetSchemaCommand,
435456
GetSchemaAnalysisRuleCommand,
@@ -449,11 +470,13 @@ const commands = {
449470
ListMembershipsCommand,
450471
ListPrivacyBudgetsCommand,
451472
ListPrivacyBudgetTemplatesCommand,
473+
ListProtectedJobsCommand,
452474
ListProtectedQueriesCommand,
453475
ListSchemasCommand,
454476
ListTagsForResourceCommand,
455477
PopulateIdMappingTableCommand,
456478
PreviewPrivacyImpactCommand,
479+
StartProtectedJobCommand,
457480
StartProtectedQueryCommand,
458481
TagResourceCommand,
459482
UntagResourceCommand,
@@ -468,6 +491,7 @@ const commands = {
468491
UpdateIdNamespaceAssociationCommand,
469492
UpdateMembershipCommand,
470493
UpdatePrivacyBudgetTemplateCommand,
494+
UpdateProtectedJobCommand,
471495
UpdateProtectedQueryCommand,
472496
};
473497

@@ -1154,6 +1178,20 @@ export interface CleanRooms {
11541178
cb: (err: any, data?: GetPrivacyBudgetTemplateCommandOutput) => void
11551179
): void;
11561180

1181+
/**
1182+
* @see {@link GetProtectedJobCommand}
1183+
*/
1184+
getProtectedJob(
1185+
args: GetProtectedJobCommandInput,
1186+
options?: __HttpHandlerOptions
1187+
): Promise<GetProtectedJobCommandOutput>;
1188+
getProtectedJob(args: GetProtectedJobCommandInput, cb: (err: any, data?: GetProtectedJobCommandOutput) => void): void;
1189+
getProtectedJob(
1190+
args: GetProtectedJobCommandInput,
1191+
options: __HttpHandlerOptions,
1192+
cb: (err: any, data?: GetProtectedJobCommandOutput) => void
1193+
): void;
1194+
11571195
/**
11581196
* @see {@link GetProtectedQueryCommand}
11591197
*/
@@ -1465,6 +1503,23 @@ export interface CleanRooms {
14651503
cb: (err: any, data?: ListPrivacyBudgetTemplatesCommandOutput) => void
14661504
): void;
14671505

1506+
/**
1507+
* @see {@link ListProtectedJobsCommand}
1508+
*/
1509+
listProtectedJobs(
1510+
args: ListProtectedJobsCommandInput,
1511+
options?: __HttpHandlerOptions
1512+
): Promise<ListProtectedJobsCommandOutput>;
1513+
listProtectedJobs(
1514+
args: ListProtectedJobsCommandInput,
1515+
cb: (err: any, data?: ListProtectedJobsCommandOutput) => void
1516+
): void;
1517+
listProtectedJobs(
1518+
args: ListProtectedJobsCommandInput,
1519+
options: __HttpHandlerOptions,
1520+
cb: (err: any, data?: ListProtectedJobsCommandOutput) => void
1521+
): void;
1522+
14681523
/**
14691524
* @see {@link ListProtectedQueriesCommand}
14701525
*/
@@ -1544,6 +1599,23 @@ export interface CleanRooms {
15441599
cb: (err: any, data?: PreviewPrivacyImpactCommandOutput) => void
15451600
): void;
15461601

1602+
/**
1603+
* @see {@link StartProtectedJobCommand}
1604+
*/
1605+
startProtectedJob(
1606+
args: StartProtectedJobCommandInput,
1607+
options?: __HttpHandlerOptions
1608+
): Promise<StartProtectedJobCommandOutput>;
1609+
startProtectedJob(
1610+
args: StartProtectedJobCommandInput,
1611+
cb: (err: any, data?: StartProtectedJobCommandOutput) => void
1612+
): void;
1613+
startProtectedJob(
1614+
args: StartProtectedJobCommandInput,
1615+
options: __HttpHandlerOptions,
1616+
cb: (err: any, data?: StartProtectedJobCommandOutput) => void
1617+
): void;
1618+
15471619
/**
15481620
* @see {@link StartProtectedQueryCommand}
15491621
*/
@@ -1770,6 +1842,23 @@ export interface CleanRooms {
17701842
cb: (err: any, data?: UpdatePrivacyBudgetTemplateCommandOutput) => void
17711843
): void;
17721844

1845+
/**
1846+
* @see {@link UpdateProtectedJobCommand}
1847+
*/
1848+
updateProtectedJob(
1849+
args: UpdateProtectedJobCommandInput,
1850+
options?: __HttpHandlerOptions
1851+
): Promise<UpdateProtectedJobCommandOutput>;
1852+
updateProtectedJob(
1853+
args: UpdateProtectedJobCommandInput,
1854+
cb: (err: any, data?: UpdateProtectedJobCommandOutput) => void
1855+
): void;
1856+
updateProtectedJob(
1857+
args: UpdateProtectedJobCommandInput,
1858+
options: __HttpHandlerOptions,
1859+
cb: (err: any, data?: UpdateProtectedJobCommandOutput) => void
1860+
): void;
1861+
17731862
/**
17741863
* @see {@link UpdateProtectedQueryCommand}
17751864
*/
@@ -1792,7 +1881,7 @@ export interface CleanRooms {
17921881
* <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
17931882
* <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
17941883
* their data together in a secure collaboration workspace. In the collaboration, members who
1795-
* can query and receive results can get insights into the collective datasets without either
1884+
* can run queries and jobs and receive results can get insights into the collective datasets without either
17961885
* party getting access to the other party's raw data.</p>
17971886
* <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
17981887
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ import {
193193
GetPrivacyBudgetTemplateCommandInput,
194194
GetPrivacyBudgetTemplateCommandOutput,
195195
} from "./commands/GetPrivacyBudgetTemplateCommand";
196+
import { GetProtectedJobCommandInput, GetProtectedJobCommandOutput } from "./commands/GetProtectedJobCommand";
196197
import { GetProtectedQueryCommandInput, GetProtectedQueryCommandOutput } from "./commands/GetProtectedQueryCommand";
197198
import {
198199
GetSchemaAnalysisRuleCommandInput,
@@ -251,6 +252,7 @@ import {
251252
ListPrivacyBudgetTemplatesCommandInput,
252253
ListPrivacyBudgetTemplatesCommandOutput,
253254
} from "./commands/ListPrivacyBudgetTemplatesCommand";
255+
import { ListProtectedJobsCommandInput, ListProtectedJobsCommandOutput } from "./commands/ListProtectedJobsCommand";
254256
import {
255257
ListProtectedQueriesCommandInput,
256258
ListProtectedQueriesCommandOutput,
@@ -268,6 +270,7 @@ import {
268270
PreviewPrivacyImpactCommandInput,
269271
PreviewPrivacyImpactCommandOutput,
270272
} from "./commands/PreviewPrivacyImpactCommand";
273+
import { StartProtectedJobCommandInput, StartProtectedJobCommandOutput } from "./commands/StartProtectedJobCommand";
271274
import {
272275
StartProtectedQueryCommandInput,
273276
StartProtectedQueryCommandOutput,
@@ -315,6 +318,7 @@ import {
315318
UpdatePrivacyBudgetTemplateCommandInput,
316319
UpdatePrivacyBudgetTemplateCommandOutput,
317320
} from "./commands/UpdatePrivacyBudgetTemplateCommand";
321+
import { UpdateProtectedJobCommandInput, UpdateProtectedJobCommandOutput } from "./commands/UpdateProtectedJobCommand";
318322
import {
319323
UpdateProtectedQueryCommandInput,
320324
UpdateProtectedQueryCommandOutput,
@@ -375,6 +379,7 @@ export type ServiceInputTypes =
375379
| GetIdNamespaceAssociationCommandInput
376380
| GetMembershipCommandInput
377381
| GetPrivacyBudgetTemplateCommandInput
382+
| GetProtectedJobCommandInput
378383
| GetProtectedQueryCommandInput
379384
| GetSchemaAnalysisRuleCommandInput
380385
| GetSchemaCommandInput
@@ -394,11 +399,13 @@ export type ServiceInputTypes =
394399
| ListMembershipsCommandInput
395400
| ListPrivacyBudgetTemplatesCommandInput
396401
| ListPrivacyBudgetsCommandInput
402+
| ListProtectedJobsCommandInput
397403
| ListProtectedQueriesCommandInput
398404
| ListSchemasCommandInput
399405
| ListTagsForResourceCommandInput
400406
| PopulateIdMappingTableCommandInput
401407
| PreviewPrivacyImpactCommandInput
408+
| StartProtectedJobCommandInput
402409
| StartProtectedQueryCommandInput
403410
| TagResourceCommandInput
404411
| UntagResourceCommandInput
@@ -413,6 +420,7 @@ export type ServiceInputTypes =
413420
| UpdateIdNamespaceAssociationCommandInput
414421
| UpdateMembershipCommandInput
415422
| UpdatePrivacyBudgetTemplateCommandInput
423+
| UpdateProtectedJobCommandInput
416424
| UpdateProtectedQueryCommandInput;
417425

418426
/**
@@ -460,6 +468,7 @@ export type ServiceOutputTypes =
460468
| GetIdNamespaceAssociationCommandOutput
461469
| GetMembershipCommandOutput
462470
| GetPrivacyBudgetTemplateCommandOutput
471+
| GetProtectedJobCommandOutput
463472
| GetProtectedQueryCommandOutput
464473
| GetSchemaAnalysisRuleCommandOutput
465474
| GetSchemaCommandOutput
@@ -479,11 +488,13 @@ export type ServiceOutputTypes =
479488
| ListMembershipsCommandOutput
480489
| ListPrivacyBudgetTemplatesCommandOutput
481490
| ListPrivacyBudgetsCommandOutput
491+
| ListProtectedJobsCommandOutput
482492
| ListProtectedQueriesCommandOutput
483493
| ListSchemasCommandOutput
484494
| ListTagsForResourceCommandOutput
485495
| PopulateIdMappingTableCommandOutput
486496
| PreviewPrivacyImpactCommandOutput
497+
| StartProtectedJobCommandOutput
487498
| StartProtectedQueryCommandOutput
488499
| TagResourceCommandOutput
489500
| UntagResourceCommandOutput
@@ -498,6 +509,7 @@ export type ServiceOutputTypes =
498509
| UpdateIdNamespaceAssociationCommandOutput
499510
| UpdateMembershipCommandOutput
500511
| UpdatePrivacyBudgetTemplateCommandOutput
512+
| UpdateProtectedJobCommandOutput
501513
| UpdateProtectedQueryCommandOutput;
502514

503515
/**
@@ -694,7 +706,7 @@ export interface CleanRoomsClientResolvedConfig extends CleanRoomsClientResolved
694706
* <p>Welcome to the <i>Clean Rooms API Reference</i>.</p>
695707
* <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join
696708
* their data together in a secure collaboration workspace. In the collaboration, members who
697-
* can query and receive results can get insights into the collective datasets without either
709+
* can run queries and jobs and receive results can get insights into the collective datasets without either
698710
* party getting access to the other party's raw data.</p>
699711
* <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the
700712
* <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>.</p>

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

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,38 @@ export interface BatchGetCollaborationAnalysisTemplateCommandOutput
7070
* // "STRING_VALUE",
7171
* // ],
7272
* // },
73-
* // format: "SQL", // required
73+
* // format: "SQL" || "PYSPARK_1_0", // required
7474
* // source: { // AnalysisSource Union: only one key present
7575
* // text: "STRING_VALUE",
76+
* // artifacts: { // AnalysisTemplateArtifacts
77+
* // entryPoint: { // AnalysisTemplateArtifact
78+
* // location: { // S3Location
79+
* // bucket: "STRING_VALUE", // required
80+
* // key: "STRING_VALUE", // required
81+
* // },
82+
* // },
83+
* // additionalArtifacts: [ // AnalysisTemplateArtifactList
84+
* // {
85+
* // location: {
86+
* // bucket: "STRING_VALUE", // required
87+
* // key: "STRING_VALUE", // required
88+
* // },
89+
* // },
90+
* // ],
91+
* // roleArn: "STRING_VALUE", // required
92+
* // },
93+
* // },
94+
* // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present
95+
* // artifacts: { // AnalysisTemplateArtifactMetadata
96+
* // entryPointHash: { // Hash
97+
* // sha256: "STRING_VALUE",
98+
* // },
99+
* // additionalArtifactHashes: [ // HashList
100+
* // {
101+
* // sha256: "STRING_VALUE",
102+
* // },
103+
* // ],
104+
* // },
76105
* // },
77106
* // analysisParameters: [ // AnalysisParameterList
78107
* // { // AnalysisParameter

0 commit comments

Comments
 (0)