@aws-sdk/client-cleanrooms 3.750.0 → 3.770.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.
Files changed (71) hide show
  1. package/README.md +33 -1
  2. package/dist-cjs/index.js +742 -392
  3. package/dist-es/CleanRooms.js +8 -0
  4. package/dist-es/commands/GetProtectedJobCommand.js +22 -0
  5. package/dist-es/commands/GetProtectedQueryCommand.js +1 -1
  6. package/dist-es/commands/ListProtectedJobsCommand.js +22 -0
  7. package/dist-es/commands/StartProtectedJobCommand.js +22 -0
  8. package/dist-es/commands/UpdateProtectedJobCommand.js +22 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/models_0.js +90 -75
  11. package/dist-es/models/models_1.js +96 -1
  12. package/dist-es/pagination/ListProtectedJobsPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/protocols/Aws_restJson1.js +176 -0
  15. package/dist-types/CleanRooms.d.ts +29 -1
  16. package/dist-types/CleanRoomsClient.d.ts +7 -3
  17. package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +30 -1
  18. package/dist-types/commands/BatchGetSchemaAnalysisRuleCommand.d.ts +98 -0
  19. package/dist-types/commands/BatchGetSchemaCommand.d.ts +4 -1
  20. package/dist-types/commands/CreateAnalysisTemplateCommand.d.ts +53 -2
  21. package/dist-types/commands/CreateCollaborationCommand.d.ts +10 -2
  22. package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +3 -0
  23. package/dist-types/commands/CreateConfiguredTableCommand.d.ts +8 -2
  24. package/dist-types/commands/CreateMembershipCommand.d.ts +29 -3
  25. package/dist-types/commands/GetAnalysisTemplateCommand.d.ts +30 -1
  26. package/dist-types/commands/GetCollaborationAnalysisTemplateCommand.d.ts +30 -1
  27. package/dist-types/commands/GetCollaborationCommand.d.ts +1 -0
  28. package/dist-types/commands/GetConfiguredTableCommand.d.ts +4 -1
  29. package/dist-types/commands/GetMembershipCommand.d.ts +15 -2
  30. package/dist-types/commands/GetProtectedJobCommand.d.ts +130 -0
  31. package/dist-types/commands/GetProtectedQueryCommand.d.ts +1 -1
  32. package/dist-types/commands/GetSchemaAnalysisRuleCommand.d.ts +98 -0
  33. package/dist-types/commands/GetSchemaCommand.d.ts +4 -1
  34. package/dist-types/commands/ListConfiguredTableAssociationsCommand.d.ts +3 -0
  35. package/dist-types/commands/ListConfiguredTablesCommand.d.ts +4 -1
  36. package/dist-types/commands/ListMembersCommand.d.ts +4 -1
  37. package/dist-types/commands/ListMembershipsCommand.d.ts +5 -2
  38. package/dist-types/commands/ListPrivacyBudgetsCommand.d.ts +1 -1
  39. package/dist-types/commands/ListProtectedJobsCommand.d.ts +110 -0
  40. package/dist-types/commands/ListProtectedQueriesCommand.d.ts +1 -2
  41. package/dist-types/commands/ListSchemasCommand.d.ts +4 -1
  42. package/dist-types/commands/StartProtectedJobCommand.d.ts +142 -0
  43. package/dist-types/commands/UpdateAnalysisTemplateCommand.d.ts +30 -1
  44. package/dist-types/commands/UpdateCollaborationCommand.d.ts +1 -0
  45. package/dist-types/commands/UpdateConfiguredTableCommand.d.ts +8 -1
  46. package/dist-types/commands/UpdateMembershipCommand.d.ts +26 -3
  47. package/dist-types/commands/UpdateProtectedJobCommand.d.ts +133 -0
  48. package/dist-types/commands/index.d.ts +4 -0
  49. package/dist-types/index.d.ts +1 -1
  50. package/dist-types/models/models_0.d.ts +3468 -3339
  51. package/dist-types/models/models_1.d.ts +1129 -1
  52. package/dist-types/pagination/ListProtectedJobsPaginator.d.ts +7 -0
  53. package/dist-types/pagination/index.d.ts +1 -0
  54. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  55. package/dist-types/ts3.4/CleanRooms.d.ts +68 -0
  56. package/dist-types/ts3.4/CleanRoomsClient.d.ts +24 -0
  57. package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +48 -0
  58. package/dist-types/ts3.4/commands/GetProtectedQueryCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/ListMembershipsCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/ListPrivacyBudgetsCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/ListProtectedJobsCommand.d.ts +50 -0
  62. package/dist-types/ts3.4/commands/ListProtectedQueriesCommand.d.ts +4 -2
  63. package/dist-types/ts3.4/commands/StartProtectedJobCommand.d.ts +50 -0
  64. package/dist-types/ts3.4/commands/UpdateProtectedJobCommand.d.ts +51 -0
  65. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  66. package/dist-types/ts3.4/models/models_0.d.ts +328 -272
  67. package/dist-types/ts3.4/models/models_1.d.ts +401 -6
  68. package/dist-types/ts3.4/pagination/ListProtectedJobsPaginator.d.ts +11 -0
  69. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  70. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  71. package/package.json +12 -12
@@ -1,4 +1,962 @@
1
- import { AnalysisType, ComputeConfiguration, ConfigurationDetails, DifferentialPrivacyAggregationType, Membership, MembershipProtectedQueryResultConfiguration, MembershipQueryLogStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, ProtectedQuery, ProtectedQueryResultConfiguration, ProtectedQuerySQLParameters, ProtectedQueryStatus } from "./models_0";
1
+ import { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, Membership, MembershipJobLogStatus, MembershipPaymentConfiguration, MembershipProtectedJobResultConfiguration, MembershipProtectedQueryResultConfiguration, MembershipQueryLogStatus, MembershipStatus, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, ProtectedJobError, ProtectedJobOutputConfigurationOutput, ProtectedJobParameters, ProtectedJobResult, ProtectedQueryS3OutputConfiguration } from "./models_0";
2
+ /**
3
+ * <p>The output configuration for a protected job result.</p>
4
+ * @public
5
+ */
6
+ export interface ProtectedJobResultConfigurationOutput {
7
+ /**
8
+ * <p>The output configuration.</p>
9
+ * @public
10
+ */
11
+ outputConfiguration: ProtectedJobOutputConfigurationOutput | undefined;
12
+ }
13
+ /**
14
+ * <p> Information related to the utilization of resources that have been billed
15
+ * or charged for in a given context, such as a protected job.</p>
16
+ * @public
17
+ */
18
+ export interface BilledJobResourceUtilization {
19
+ /**
20
+ * <p> The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.</p>
21
+ * @public
22
+ */
23
+ units: number | undefined;
24
+ }
25
+ /**
26
+ * <p>Contains statistics about the execution of the protected job.</p>
27
+ * @public
28
+ */
29
+ export interface ProtectedJobStatistics {
30
+ /**
31
+ * <p>The duration of the protected job, from creation until job completion, in milliseconds.</p>
32
+ * @public
33
+ */
34
+ totalDurationInMillis?: number | undefined;
35
+ /**
36
+ * <p> The billed resource utilization for the protected job.</p>
37
+ * @public
38
+ */
39
+ billedResourceUtilization?: BilledJobResourceUtilization | undefined;
40
+ }
41
+ /**
42
+ * @public
43
+ * @enum
44
+ */
45
+ export declare const ProtectedJobStatus: {
46
+ readonly CANCELLED: "CANCELLED";
47
+ readonly CANCELLING: "CANCELLING";
48
+ readonly FAILED: "FAILED";
49
+ readonly STARTED: "STARTED";
50
+ readonly SUBMITTED: "SUBMITTED";
51
+ readonly SUCCESS: "SUCCESS";
52
+ };
53
+ /**
54
+ * @public
55
+ */
56
+ export type ProtectedJobStatus = (typeof ProtectedJobStatus)[keyof typeof ProtectedJobStatus];
57
+ /**
58
+ * <p>The parameters for an Clean Rooms protected job.</p>
59
+ * @public
60
+ */
61
+ export interface ProtectedJob {
62
+ /**
63
+ * <p>The identifier for a protected job instance.</p>
64
+ * @public
65
+ */
66
+ id: string | undefined;
67
+ /**
68
+ * <p>he identifier for the membership.</p>
69
+ * @public
70
+ */
71
+ membershipId: string | undefined;
72
+ /**
73
+ * <p>The ARN of the membership.</p>
74
+ * @public
75
+ */
76
+ membershipArn: string | undefined;
77
+ /**
78
+ * <p> The creation time of the protected job.</p>
79
+ * @public
80
+ */
81
+ createTime: Date | undefined;
82
+ /**
83
+ * <p> The job parameters for the protected job.</p>
84
+ * @public
85
+ */
86
+ jobParameters?: ProtectedJobParameters | undefined;
87
+ /**
88
+ * <p> The status of the protected job.</p>
89
+ * @public
90
+ */
91
+ status: ProtectedJobStatus | undefined;
92
+ /**
93
+ * <p>Contains any details needed to write the job results.</p>
94
+ * @public
95
+ */
96
+ resultConfiguration?: ProtectedJobResultConfigurationOutput | undefined;
97
+ /**
98
+ * <p> The statistics of the protected job.</p>
99
+ * @public
100
+ */
101
+ statistics?: ProtectedJobStatistics | undefined;
102
+ /**
103
+ * <p> The result of the protected job.</p>
104
+ * @public
105
+ */
106
+ result?: ProtectedJobResult | undefined;
107
+ /**
108
+ * <p> The error from the protected job.</p>
109
+ * @public
110
+ */
111
+ error?: ProtectedJobError | undefined;
112
+ }
113
+ /**
114
+ * @public
115
+ */
116
+ export interface GetProtectedJobOutput {
117
+ /**
118
+ * <p> The protected job metadata.</p>
119
+ * @public
120
+ */
121
+ protectedJob: ProtectedJob | undefined;
122
+ }
123
+ /**
124
+ * @public
125
+ */
126
+ export interface GetProtectedQueryInput {
127
+ /**
128
+ * <p>The identifier for a membership in a protected query instance.</p>
129
+ * @public
130
+ */
131
+ membershipIdentifier: string | undefined;
132
+ /**
133
+ * <p>The identifier for a protected query instance.</p>
134
+ * @public
135
+ */
136
+ protectedQueryIdentifier: string | undefined;
137
+ }
138
+ /**
139
+ * @public
140
+ * @enum
141
+ */
142
+ export declare const WorkerComputeType: {
143
+ readonly CR1X: "CR.1X";
144
+ readonly CR4X: "CR.4X";
145
+ };
146
+ /**
147
+ * @public
148
+ */
149
+ export type WorkerComputeType = (typeof WorkerComputeType)[keyof typeof WorkerComputeType];
150
+ /**
151
+ * <p> The configuration of the compute resources for workers running an analysis with the
152
+ * Clean Rooms SQL analytics engine.</p>
153
+ * @public
154
+ */
155
+ export interface WorkerComputeConfiguration {
156
+ /**
157
+ * <p> The worker compute configuration type.</p>
158
+ * @public
159
+ */
160
+ type?: WorkerComputeType | undefined;
161
+ /**
162
+ * <p> The number of workers.</p>
163
+ * @public
164
+ */
165
+ number?: number | undefined;
166
+ }
167
+ /**
168
+ * <p> The configuration of the compute resources for an analysis with the Spark analytics engine.</p>
169
+ * @public
170
+ */
171
+ export type ComputeConfiguration = ComputeConfiguration.WorkerMember | ComputeConfiguration.$UnknownMember;
172
+ /**
173
+ * @public
174
+ */
175
+ export declare namespace ComputeConfiguration {
176
+ /**
177
+ * <p> The worker configuration for the compute environment.</p>
178
+ * @public
179
+ */
180
+ interface WorkerMember {
181
+ worker: WorkerComputeConfiguration;
182
+ $unknown?: never;
183
+ }
184
+ /**
185
+ * @public
186
+ */
187
+ interface $UnknownMember {
188
+ worker?: never;
189
+ $unknown: [string, any];
190
+ }
191
+ interface Visitor<T> {
192
+ worker: (value: WorkerComputeConfiguration) => T;
193
+ _: (name: string, value: any) => T;
194
+ }
195
+ const visit: <T>(value: ComputeConfiguration, visitor: Visitor<T>) => T;
196
+ }
197
+ /**
198
+ * <p>Provides the sensitivity parameters.</p>
199
+ * @public
200
+ */
201
+ export interface DifferentialPrivacySensitivityParameters {
202
+ /**
203
+ * <p>The type of aggregation function that was run.</p>
204
+ * @public
205
+ */
206
+ aggregationType: DifferentialPrivacyAggregationType | undefined;
207
+ /**
208
+ * <p>The aggregation expression that was run.</p>
209
+ * @public
210
+ */
211
+ aggregationExpression: string | undefined;
212
+ /**
213
+ * <p>The maximum number of rows contributed by a user in a SQL query.</p>
214
+ * @public
215
+ */
216
+ userContributionLimit: number | undefined;
217
+ /**
218
+ * <p>The lower bound of the aggregation expression.</p>
219
+ * @public
220
+ */
221
+ minColumnValue?: number | undefined;
222
+ /**
223
+ * <p>The upper bound of the aggregation expression.</p>
224
+ * @public
225
+ */
226
+ maxColumnValue?: number | undefined;
227
+ }
228
+ /**
229
+ * <p>An array that contains the sensitivity parameters.</p>
230
+ * @public
231
+ */
232
+ export interface DifferentialPrivacyParameters {
233
+ /**
234
+ * <p>Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.</p>
235
+ * @public
236
+ */
237
+ sensitivityParameters: DifferentialPrivacySensitivityParameters[] | undefined;
238
+ }
239
+ /**
240
+ * <p>Details of errors thrown by the protected query.</p>
241
+ * @public
242
+ */
243
+ export interface ProtectedQueryError {
244
+ /**
245
+ * <p>A description of why the query failed.</p>
246
+ * @public
247
+ */
248
+ message: string | undefined;
249
+ /**
250
+ * <p>An error code for the error.</p>
251
+ * @public
252
+ */
253
+ code: string | undefined;
254
+ }
255
+ /**
256
+ * <p>Details about the member who received the query result.</p>
257
+ * @public
258
+ */
259
+ export interface ProtectedQuerySingleMemberOutput {
260
+ /**
261
+ * <p>The Amazon Web Services account ID of the member in the collaboration who can receive results for the
262
+ * query.</p>
263
+ * @public
264
+ */
265
+ accountId: string | undefined;
266
+ }
267
+ /**
268
+ * <p>Contains output information for protected queries with an S3 output type.</p>
269
+ * @public
270
+ */
271
+ export interface ProtectedQueryS3Output {
272
+ /**
273
+ * <p>The S3 location of the result.</p>
274
+ * @public
275
+ */
276
+ location: string | undefined;
277
+ }
278
+ /**
279
+ * <p>Contains details about the protected query output.</p>
280
+ * @public
281
+ */
282
+ export type ProtectedQueryOutput = ProtectedQueryOutput.MemberListMember | ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember;
283
+ /**
284
+ * @public
285
+ */
286
+ export declare namespace ProtectedQueryOutput {
287
+ /**
288
+ * <p>If present, the output for a protected query with an `S3` output type.</p>
289
+ * @public
290
+ */
291
+ interface S3Member {
292
+ s3: ProtectedQueryS3Output;
293
+ memberList?: never;
294
+ $unknown?: never;
295
+ }
296
+ /**
297
+ * <p>The list of member Amazon Web Services account(s) that received the results of the query. </p>
298
+ * @public
299
+ */
300
+ interface MemberListMember {
301
+ s3?: never;
302
+ memberList: ProtectedQuerySingleMemberOutput[];
303
+ $unknown?: never;
304
+ }
305
+ /**
306
+ * @public
307
+ */
308
+ interface $UnknownMember {
309
+ s3?: never;
310
+ memberList?: never;
311
+ $unknown: [string, any];
312
+ }
313
+ interface Visitor<T> {
314
+ s3: (value: ProtectedQueryS3Output) => T;
315
+ memberList: (value: ProtectedQuerySingleMemberOutput[]) => T;
316
+ _: (name: string, value: any) => T;
317
+ }
318
+ const visit: <T>(value: ProtectedQueryOutput, visitor: Visitor<T>) => T;
319
+ }
320
+ /**
321
+ * <p>Details about the query results.</p>
322
+ * @public
323
+ */
324
+ export interface ProtectedQueryResult {
325
+ /**
326
+ * <p>The output of the protected query.</p>
327
+ * @public
328
+ */
329
+ output: ProtectedQueryOutput | undefined;
330
+ }
331
+ /**
332
+ * <p> Contains configuration details for the protected query member output.</p>
333
+ * @public
334
+ */
335
+ export interface ProtectedQueryMemberOutputConfiguration {
336
+ /**
337
+ * <p>The unique identifier for the account.</p>
338
+ * @public
339
+ */
340
+ accountId: string | undefined;
341
+ }
342
+ /**
343
+ * <p>Contains configuration details for protected query output.</p>
344
+ * @public
345
+ */
346
+ export type ProtectedQueryOutputConfiguration = ProtectedQueryOutputConfiguration.MemberMember | ProtectedQueryOutputConfiguration.S3Member | ProtectedQueryOutputConfiguration.$UnknownMember;
347
+ /**
348
+ * @public
349
+ */
350
+ export declare namespace ProtectedQueryOutputConfiguration {
351
+ /**
352
+ * <p>Required configuration for a protected query with an <code>s3</code> output type.</p>
353
+ * @public
354
+ */
355
+ interface S3Member {
356
+ s3: ProtectedQueryS3OutputConfiguration;
357
+ member?: never;
358
+ $unknown?: never;
359
+ }
360
+ /**
361
+ * <p> Required configuration for a protected query with a <code>member</code> output type.</p>
362
+ * @public
363
+ */
364
+ interface MemberMember {
365
+ s3?: never;
366
+ member: ProtectedQueryMemberOutputConfiguration;
367
+ $unknown?: never;
368
+ }
369
+ /**
370
+ * @public
371
+ */
372
+ interface $UnknownMember {
373
+ s3?: never;
374
+ member?: never;
375
+ $unknown: [string, any];
376
+ }
377
+ interface Visitor<T> {
378
+ s3: (value: ProtectedQueryS3OutputConfiguration) => T;
379
+ member: (value: ProtectedQueryMemberOutputConfiguration) => T;
380
+ _: (name: string, value: any) => T;
381
+ }
382
+ const visit: <T>(value: ProtectedQueryOutputConfiguration, visitor: Visitor<T>) => T;
383
+ }
384
+ /**
385
+ * <p>Contains configurations for protected query results.</p>
386
+ * @public
387
+ */
388
+ export interface ProtectedQueryResultConfiguration {
389
+ /**
390
+ * <p>Configuration for protected query results.</p>
391
+ * @public
392
+ */
393
+ outputConfiguration: ProtectedQueryOutputConfiguration | undefined;
394
+ }
395
+ /**
396
+ * <p>The parameters for the SQL type Protected Query.</p>
397
+ * @public
398
+ */
399
+ export interface ProtectedQuerySQLParameters {
400
+ /**
401
+ * <p>The query string to be submitted.</p>
402
+ * @public
403
+ */
404
+ queryString?: string | undefined;
405
+ /**
406
+ * <p>The Amazon Resource Name (ARN) associated with the analysis template within a
407
+ * collaboration.</p>
408
+ * @public
409
+ */
410
+ analysisTemplateArn?: string | undefined;
411
+ /**
412
+ * <p>The protected query SQL parameters.</p>
413
+ * @public
414
+ */
415
+ parameters?: Record<string, string> | undefined;
416
+ }
417
+ /**
418
+ * <p> Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.</p>
419
+ * @public
420
+ */
421
+ export interface BilledResourceUtilization {
422
+ /**
423
+ * <p> The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.</p>
424
+ * @public
425
+ */
426
+ units: number | undefined;
427
+ }
428
+ /**
429
+ * <p>Contains statistics about the execution of the protected query.</p>
430
+ * @public
431
+ */
432
+ export interface ProtectedQueryStatistics {
433
+ /**
434
+ * <p>The duration of the protected query, from creation until query completion, in milliseconds.</p>
435
+ * @public
436
+ */
437
+ totalDurationInMillis?: number | undefined;
438
+ /**
439
+ * <p> The billed resource utilization.</p>
440
+ * @public
441
+ */
442
+ billedResourceUtilization?: BilledResourceUtilization | undefined;
443
+ }
444
+ /**
445
+ * @public
446
+ * @enum
447
+ */
448
+ export declare const ProtectedQueryStatus: {
449
+ readonly CANCELLED: "CANCELLED";
450
+ readonly CANCELLING: "CANCELLING";
451
+ readonly FAILED: "FAILED";
452
+ readonly STARTED: "STARTED";
453
+ readonly SUBMITTED: "SUBMITTED";
454
+ readonly SUCCESS: "SUCCESS";
455
+ readonly TIMED_OUT: "TIMED_OUT";
456
+ };
457
+ /**
458
+ * @public
459
+ */
460
+ export type ProtectedQueryStatus = (typeof ProtectedQueryStatus)[keyof typeof ProtectedQueryStatus];
461
+ /**
462
+ * <p>The parameters for an Clean Rooms protected query.</p>
463
+ * @public
464
+ */
465
+ export interface ProtectedQuery {
466
+ /**
467
+ * <p>The identifier for a protected query instance.</p>
468
+ * @public
469
+ */
470
+ id: string | undefined;
471
+ /**
472
+ * <p>The identifier for the membership.</p>
473
+ * @public
474
+ */
475
+ membershipId: string | undefined;
476
+ /**
477
+ * <p>The ARN of the membership.</p>
478
+ * @public
479
+ */
480
+ membershipArn: string | undefined;
481
+ /**
482
+ * <p>The time at which the protected query was created.</p>
483
+ * @public
484
+ */
485
+ createTime: Date | undefined;
486
+ /**
487
+ * <p>The protected query SQL parameters.</p>
488
+ * @public
489
+ */
490
+ sqlParameters?: ProtectedQuerySQLParameters | undefined;
491
+ /**
492
+ * <p>The status of the query.</p>
493
+ * @public
494
+ */
495
+ status: ProtectedQueryStatus | undefined;
496
+ /**
497
+ * <p>Contains any details needed to write the query results.</p>
498
+ * @public
499
+ */
500
+ resultConfiguration?: ProtectedQueryResultConfiguration | undefined;
501
+ /**
502
+ * <p>Statistics about protected query execution.</p>
503
+ * @public
504
+ */
505
+ statistics?: ProtectedQueryStatistics | undefined;
506
+ /**
507
+ * <p>The result of the protected query.</p>
508
+ * @public
509
+ */
510
+ result?: ProtectedQueryResult | undefined;
511
+ /**
512
+ * <p>An error thrown by the protected query.</p>
513
+ * @public
514
+ */
515
+ error?: ProtectedQueryError | undefined;
516
+ /**
517
+ * <p>The sensitivity parameters of the differential privacy results of the protected query.</p>
518
+ * @public
519
+ */
520
+ differentialPrivacy?: DifferentialPrivacyParameters | undefined;
521
+ /**
522
+ * <p> The compute configuration for the protected query.</p>
523
+ * @public
524
+ */
525
+ computeConfiguration?: ComputeConfiguration | undefined;
526
+ }
527
+ /**
528
+ * @public
529
+ */
530
+ export interface GetProtectedQueryOutput {
531
+ /**
532
+ * <p>The query processing metadata.</p>
533
+ * @public
534
+ */
535
+ protectedQuery: ProtectedQuery | undefined;
536
+ }
537
+ /**
538
+ * @public
539
+ */
540
+ export interface ListMembershipsInput {
541
+ /**
542
+ * <p>The pagination token that's used to fetch the next set of results.</p>
543
+ * @public
544
+ */
545
+ nextToken?: string | undefined;
546
+ /**
547
+ * <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
548
+ * `maxResults` value has not been met.</p>
549
+ * @public
550
+ */
551
+ maxResults?: number | undefined;
552
+ /**
553
+ * <p>A filter which will return only memberships in the specified status.</p>
554
+ * @public
555
+ */
556
+ status?: MembershipStatus | undefined;
557
+ }
558
+ /**
559
+ * <p>The membership object listed by the request.</p>
560
+ * @public
561
+ */
562
+ export interface MembershipSummary {
563
+ /**
564
+ * <p>The unique ID for the membership's collaboration.</p>
565
+ * @public
566
+ */
567
+ id: string | undefined;
568
+ /**
569
+ * <p>The unique ARN for the membership.</p>
570
+ * @public
571
+ */
572
+ arn: string | undefined;
573
+ /**
574
+ * <p>The unique ARN for the membership's associated collaboration.</p>
575
+ * @public
576
+ */
577
+ collaborationArn: string | undefined;
578
+ /**
579
+ * <p>The unique ID for the membership's collaboration.</p>
580
+ * @public
581
+ */
582
+ collaborationId: string | undefined;
583
+ /**
584
+ * <p>The identifier of the Amazon Web Services principal that created the collaboration. Currently only
585
+ * supports Amazon Web Services account ID.</p>
586
+ * @public
587
+ */
588
+ collaborationCreatorAccountId: string | undefined;
589
+ /**
590
+ * <p>The display name of the collaboration creator.</p>
591
+ * @public
592
+ */
593
+ collaborationCreatorDisplayName: string | undefined;
594
+ /**
595
+ * <p>The name for the membership's collaboration.</p>
596
+ * @public
597
+ */
598
+ collaborationName: string | undefined;
599
+ /**
600
+ * <p>The time when the membership was created.</p>
601
+ * @public
602
+ */
603
+ createTime: Date | undefined;
604
+ /**
605
+ * <p>The time the membership metadata was last updated.</p>
606
+ * @public
607
+ */
608
+ updateTime: Date | undefined;
609
+ /**
610
+ * <p>The status of the membership.</p>
611
+ * @public
612
+ */
613
+ status: MembershipStatus | undefined;
614
+ /**
615
+ * <p>The abilities granted to the collaboration member.</p>
616
+ * @public
617
+ */
618
+ memberAbilities: MemberAbility[] | undefined;
619
+ /**
620
+ * <p>Provides a summary of the ML abilities for the collaboration member.</p>
621
+ * @public
622
+ */
623
+ mlMemberAbilities?: MLMemberAbilities | undefined;
624
+ /**
625
+ * <p>The payment responsibilities accepted by the collaboration member.</p>
626
+ * @public
627
+ */
628
+ paymentConfiguration: MembershipPaymentConfiguration | undefined;
629
+ }
630
+ /**
631
+ * @public
632
+ */
633
+ export interface ListMembershipsOutput {
634
+ /**
635
+ * <p>The pagination token that's used to fetch the next set of results.</p>
636
+ * @public
637
+ */
638
+ nextToken?: string | undefined;
639
+ /**
640
+ * <p>The list of memberships returned from the ListMemberships operation.</p>
641
+ * @public
642
+ */
643
+ membershipSummaries: MembershipSummary[] | undefined;
644
+ }
645
+ /**
646
+ * @public
647
+ */
648
+ export interface ListPrivacyBudgetsInput {
649
+ /**
650
+ * <p>A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.</p>
651
+ * @public
652
+ */
653
+ membershipIdentifier: string | undefined;
654
+ /**
655
+ * <p>The privacy budget type.</p>
656
+ * @public
657
+ */
658
+ privacyBudgetType: PrivacyBudgetType | undefined;
659
+ /**
660
+ * <p>The pagination token that's used to fetch the next set of results.</p>
661
+ * @public
662
+ */
663
+ nextToken?: string | undefined;
664
+ /**
665
+ * <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
666
+ * `maxResults` value has not been met.</p>
667
+ * @public
668
+ */
669
+ maxResults?: number | undefined;
670
+ }
671
+ /**
672
+ * <p>An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.</p>
673
+ * @public
674
+ */
675
+ export interface PrivacyBudgetSummary {
676
+ /**
677
+ * <p>The unique identifier of the privacy budget.</p>
678
+ * @public
679
+ */
680
+ id: string | undefined;
681
+ /**
682
+ * <p>The unique identifier of the privacy budget template.</p>
683
+ * @public
684
+ */
685
+ privacyBudgetTemplateId: string | undefined;
686
+ /**
687
+ * <p>The ARN of the privacy budget template.</p>
688
+ * @public
689
+ */
690
+ privacyBudgetTemplateArn: string | undefined;
691
+ /**
692
+ * <p>The identifier for a membership resource.</p>
693
+ * @public
694
+ */
695
+ membershipId: string | undefined;
696
+ /**
697
+ * <p>The Amazon Resource Name (ARN) of the member who created the privacy budget summary.</p>
698
+ * @public
699
+ */
700
+ membershipArn: string | undefined;
701
+ /**
702
+ * <p>The unique identifier of the collaboration that contains this privacy budget.</p>
703
+ * @public
704
+ */
705
+ collaborationId: string | undefined;
706
+ /**
707
+ * <p>The ARN of the collaboration that contains this privacy budget.</p>
708
+ * @public
709
+ */
710
+ collaborationArn: string | undefined;
711
+ /**
712
+ * <p>Specifies the type of the privacy budget.</p>
713
+ * @public
714
+ */
715
+ type: PrivacyBudgetType | undefined;
716
+ /**
717
+ * <p>The time at which the privacy budget was created.</p>
718
+ * @public
719
+ */
720
+ createTime: Date | undefined;
721
+ /**
722
+ * <p>The most recent time at which the privacy budget was updated.</p>
723
+ * @public
724
+ */
725
+ updateTime: Date | undefined;
726
+ /**
727
+ * <p>The provided privacy budget.</p>
728
+ * @public
729
+ */
730
+ budget: PrivacyBudget | undefined;
731
+ }
732
+ /**
733
+ * @public
734
+ */
735
+ export interface ListPrivacyBudgetsOutput {
736
+ /**
737
+ * <p>An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.</p>
738
+ * @public
739
+ */
740
+ privacyBudgetSummaries: PrivacyBudgetSummary[] | undefined;
741
+ /**
742
+ * <p>The pagination token that's used to fetch the next set of results.</p>
743
+ * @public
744
+ */
745
+ nextToken?: string | undefined;
746
+ }
747
+ /**
748
+ * @public
749
+ */
750
+ export interface ListProtectedJobsInput {
751
+ /**
752
+ * <p>The identifier for the membership in the collaboration.</p>
753
+ * @public
754
+ */
755
+ membershipIdentifier: string | undefined;
756
+ /**
757
+ * <p>A filter on the status of the protected job.</p>
758
+ * @public
759
+ */
760
+ status?: ProtectedJobStatus | undefined;
761
+ /**
762
+ * <p>The pagination token that's used to fetch the next set of results.</p>
763
+ * @public
764
+ */
765
+ nextToken?: string | undefined;
766
+ /**
767
+ * <p>The maximum number of results that are returned for an API request call.
768
+ * The service chooses a default number if you don't set one. The service might
769
+ * return a `nextToken` even if the `maxResults` value has not been met. </p>
770
+ * @public
771
+ */
772
+ maxResults?: number | undefined;
773
+ }
774
+ /**
775
+ * @public
776
+ * @enum
777
+ */
778
+ export declare const ProtectedJobAnalysisType: {
779
+ readonly DIRECT_ANALYSIS: "DIRECT_ANALYSIS";
780
+ };
781
+ /**
782
+ * @public
783
+ */
784
+ export type ProtectedJobAnalysisType = (typeof ProtectedJobAnalysisType)[keyof typeof ProtectedJobAnalysisType];
785
+ /**
786
+ * <p>The protected job direct analysis configuration details.</p>
787
+ * @public
788
+ */
789
+ export interface ProtectedJobDirectAnalysisConfigurationDetails {
790
+ /**
791
+ * <p> The receiver account IDs.</p>
792
+ * @public
793
+ */
794
+ receiverAccountIds?: string[] | undefined;
795
+ }
796
+ /**
797
+ * <p>The protected job configuration details.</p>
798
+ * @public
799
+ */
800
+ export type ProtectedJobConfigurationDetails = ProtectedJobConfigurationDetails.DirectAnalysisConfigurationDetailsMember | ProtectedJobConfigurationDetails.$UnknownMember;
801
+ /**
802
+ * @public
803
+ */
804
+ export declare namespace ProtectedJobConfigurationDetails {
805
+ /**
806
+ * <p>The details needed to configure the direct analysis.</p>
807
+ * @public
808
+ */
809
+ interface DirectAnalysisConfigurationDetailsMember {
810
+ directAnalysisConfigurationDetails: ProtectedJobDirectAnalysisConfigurationDetails;
811
+ $unknown?: never;
812
+ }
813
+ /**
814
+ * @public
815
+ */
816
+ interface $UnknownMember {
817
+ directAnalysisConfigurationDetails?: never;
818
+ $unknown: [string, any];
819
+ }
820
+ interface Visitor<T> {
821
+ directAnalysisConfigurationDetails: (value: ProtectedJobDirectAnalysisConfigurationDetails) => T;
822
+ _: (name: string, value: any) => T;
823
+ }
824
+ const visit: <T>(value: ProtectedJobConfigurationDetails, visitor: Visitor<T>) => T;
825
+ }
826
+ /**
827
+ * <p>The protected job receiver configuration.</p>
828
+ * @public
829
+ */
830
+ export interface ProtectedJobReceiverConfiguration {
831
+ /**
832
+ * <p> The analysis type for the protected job receiver configuration.</p>
833
+ * @public
834
+ */
835
+ analysisType: ProtectedJobAnalysisType | undefined;
836
+ /**
837
+ * <p> The configuration details for the protected job receiver.</p>
838
+ * @public
839
+ */
840
+ configurationDetails?: ProtectedJobConfigurationDetails | undefined;
841
+ }
842
+ /**
843
+ * <p>The protected job summary for the objects listed by the request.</p>
844
+ * @public
845
+ */
846
+ export interface ProtectedJobSummary {
847
+ /**
848
+ * <p> The ID of the protected job.</p>
849
+ * @public
850
+ */
851
+ id: string | undefined;
852
+ /**
853
+ * <p>The unique ID for the membership that initiated the protected job.</p>
854
+ * @public
855
+ */
856
+ membershipId: string | undefined;
857
+ /**
858
+ * <p>The unique ARN for the membership that initiated the protected job.</p>
859
+ * @public
860
+ */
861
+ membershipArn: string | undefined;
862
+ /**
863
+ * <p>The time the protected job was created.</p>
864
+ * @public
865
+ */
866
+ createTime: Date | undefined;
867
+ /**
868
+ * <p>The status of the protected job.</p>
869
+ * @public
870
+ */
871
+ status: ProtectedJobStatus | undefined;
872
+ /**
873
+ * <p> The receiver configurations for the protected job.</p>
874
+ * @public
875
+ */
876
+ receiverConfigurations: ProtectedJobReceiverConfiguration[] | undefined;
877
+ }
878
+ /**
879
+ * @public
880
+ */
881
+ export interface ListProtectedJobsOutput {
882
+ /**
883
+ * <p>The pagination token that's used to fetch the next set of results.</p>
884
+ * @public
885
+ */
886
+ nextToken?: string | undefined;
887
+ /**
888
+ * <p>A list of protected job summaries.</p>
889
+ * @public
890
+ */
891
+ protectedJobs: ProtectedJobSummary[] | undefined;
892
+ }
893
+ /**
894
+ * @public
895
+ */
896
+ export interface ListProtectedQueriesInput {
897
+ /**
898
+ * <p>The identifier for the membership in the collaboration.</p>
899
+ * @public
900
+ */
901
+ membershipIdentifier: string | undefined;
902
+ /**
903
+ * <p>A filter on the status of the protected query.</p>
904
+ * @public
905
+ */
906
+ status?: ProtectedQueryStatus | undefined;
907
+ /**
908
+ * <p>The pagination token that's used to fetch the next set of results.</p>
909
+ * @public
910
+ */
911
+ nextToken?: string | undefined;
912
+ /**
913
+ * <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the
914
+ * `maxResults` value has not been met. </p>
915
+ * @public
916
+ */
917
+ maxResults?: number | undefined;
918
+ }
919
+ /**
920
+ * <p> The direct analysis configuration details.</p>
921
+ * @public
922
+ */
923
+ export interface DirectAnalysisConfigurationDetails {
924
+ /**
925
+ * <p> The account IDs for the member who received the results of a protected query.</p>
926
+ * @public
927
+ */
928
+ receiverAccountIds?: string[] | undefined;
929
+ }
930
+ /**
931
+ * <p> The configuration details.</p>
932
+ * @public
933
+ */
934
+ export type ConfigurationDetails = ConfigurationDetails.DirectAnalysisConfigurationDetailsMember | ConfigurationDetails.$UnknownMember;
935
+ /**
936
+ * @public
937
+ */
938
+ export declare namespace ConfigurationDetails {
939
+ /**
940
+ * <p> The direct analysis configuration details.</p>
941
+ * @public
942
+ */
943
+ interface DirectAnalysisConfigurationDetailsMember {
944
+ directAnalysisConfigurationDetails: DirectAnalysisConfigurationDetails;
945
+ $unknown?: never;
946
+ }
947
+ /**
948
+ * @public
949
+ */
950
+ interface $UnknownMember {
951
+ directAnalysisConfigurationDetails?: never;
952
+ $unknown: [string, any];
953
+ }
954
+ interface Visitor<T> {
955
+ directAnalysisConfigurationDetails: (value: DirectAnalysisConfigurationDetails) => T;
956
+ _: (name: string, value: any) => T;
957
+ }
958
+ const visit: <T>(value: ConfigurationDetails, visitor: Visitor<T>) => T;
959
+ }
2
960
  /**
3
961
  * <p> The receiver configuration for a protected query.</p>
4
962
  * @public
@@ -194,6 +1152,105 @@ export interface PreviewPrivacyImpactOutput {
194
1152
  */
195
1153
  privacyImpact: PrivacyImpact | undefined;
196
1154
  }
1155
+ /**
1156
+ * <p> The protected job member output configuration input.</p>
1157
+ * @public
1158
+ */
1159
+ export interface ProtectedJobMemberOutputConfigurationInput {
1160
+ /**
1161
+ * <p> The account ID.</p>
1162
+ * @public
1163
+ */
1164
+ accountId: string | undefined;
1165
+ }
1166
+ /**
1167
+ * <p> The protected job output configuration input.</p>
1168
+ * @public
1169
+ */
1170
+ export type ProtectedJobOutputConfigurationInput = ProtectedJobOutputConfigurationInput.MemberMember | ProtectedJobOutputConfigurationInput.$UnknownMember;
1171
+ /**
1172
+ * @public
1173
+ */
1174
+ export declare namespace ProtectedJobOutputConfigurationInput {
1175
+ /**
1176
+ * <p> The member of the protected job output configuration input.</p>
1177
+ * @public
1178
+ */
1179
+ interface MemberMember {
1180
+ member: ProtectedJobMemberOutputConfigurationInput;
1181
+ $unknown?: never;
1182
+ }
1183
+ /**
1184
+ * @public
1185
+ */
1186
+ interface $UnknownMember {
1187
+ member?: never;
1188
+ $unknown: [string, any];
1189
+ }
1190
+ interface Visitor<T> {
1191
+ member: (value: ProtectedJobMemberOutputConfigurationInput) => T;
1192
+ _: (name: string, value: any) => T;
1193
+ }
1194
+ const visit: <T>(value: ProtectedJobOutputConfigurationInput, visitor: Visitor<T>) => T;
1195
+ }
1196
+ /**
1197
+ * <p>The protected job result configuration input.</p>
1198
+ * @public
1199
+ */
1200
+ export interface ProtectedJobResultConfigurationInput {
1201
+ /**
1202
+ * <p> The output configuration for a protected job result.</p>
1203
+ * @public
1204
+ */
1205
+ outputConfiguration: ProtectedJobOutputConfigurationInput | undefined;
1206
+ }
1207
+ /**
1208
+ * @public
1209
+ * @enum
1210
+ */
1211
+ export declare const ProtectedJobType: {
1212
+ readonly PYSPARK: "PYSPARK";
1213
+ };
1214
+ /**
1215
+ * @public
1216
+ */
1217
+ export type ProtectedJobType = (typeof ProtectedJobType)[keyof typeof ProtectedJobType];
1218
+ /**
1219
+ * @public
1220
+ */
1221
+ export interface StartProtectedJobInput {
1222
+ /**
1223
+ * <p> The type of protected job to start.</p>
1224
+ * @public
1225
+ */
1226
+ type: ProtectedJobType | undefined;
1227
+ /**
1228
+ * <p>A unique identifier for the membership to run this job against.
1229
+ * Currently accepts a membership ID.</p>
1230
+ * @public
1231
+ */
1232
+ membershipIdentifier: string | undefined;
1233
+ /**
1234
+ * <p> The job parameters.</p>
1235
+ * @public
1236
+ */
1237
+ jobParameters: ProtectedJobParameters | undefined;
1238
+ /**
1239
+ * <p>The details needed to write the job results.</p>
1240
+ * @public
1241
+ */
1242
+ resultConfiguration?: ProtectedJobResultConfigurationInput | undefined;
1243
+ }
1244
+ /**
1245
+ * @public
1246
+ */
1247
+ export interface StartProtectedJobOutput {
1248
+ /**
1249
+ * <p> The protected job.</p>
1250
+ * @public
1251
+ */
1252
+ protectedJob: ProtectedJob | undefined;
1253
+ }
197
1254
  /**
198
1255
  * @public
199
1256
  * @enum
@@ -258,15 +1315,32 @@ export interface UpdateMembershipInput {
258
1315
  /**
259
1316
  * <p>An indicator as to whether query logging has been enabled or disabled for the
260
1317
  * membership.</p>
1318
+ * <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this
1319
+ * collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
1320
+ * <code>DISABLED</code>.</p>
261
1321
  * @public
262
1322
  */
263
1323
  queryLogStatus?: MembershipQueryLogStatus | undefined;
1324
+ /**
1325
+ * <p>An indicator as to whether job logging has been enabled or disabled
1326
+ * for the collaboration. </p>
1327
+ * <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this
1328
+ * collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is
1329
+ * <code>DISABLED</code>.</p>
1330
+ * @public
1331
+ */
1332
+ jobLogStatus?: MembershipJobLogStatus | undefined;
264
1333
  /**
265
1334
  * <p>The default protected query result configuration as specified by the member who can
266
1335
  * receive results.</p>
267
1336
  * @public
268
1337
  */
269
1338
  defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
1339
+ /**
1340
+ * <p> The default job result configuration.</p>
1341
+ * @public
1342
+ */
1343
+ defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
270
1344
  }
271
1345
  /**
272
1346
  * @public
@@ -278,6 +1352,48 @@ export interface UpdateMembershipOutput {
278
1352
  */
279
1353
  membership: Membership | undefined;
280
1354
  }
1355
+ /**
1356
+ * @public
1357
+ * @enum
1358
+ */
1359
+ export declare const TargetProtectedJobStatus: {
1360
+ readonly CANCELLED: "CANCELLED";
1361
+ };
1362
+ /**
1363
+ * @public
1364
+ */
1365
+ export type TargetProtectedJobStatus = (typeof TargetProtectedJobStatus)[keyof typeof TargetProtectedJobStatus];
1366
+ /**
1367
+ * @public
1368
+ */
1369
+ export interface UpdateProtectedJobInput {
1370
+ /**
1371
+ * <p>The identifier for a member of a protected job instance.</p>
1372
+ * @public
1373
+ */
1374
+ membershipIdentifier: string | undefined;
1375
+ /**
1376
+ * <p> The identifier of the protected job to update.</p>
1377
+ * @public
1378
+ */
1379
+ protectedJobIdentifier: string | undefined;
1380
+ /**
1381
+ * <p>The target status of a protected job. Used to update the execution status
1382
+ * of a currently running job.</p>
1383
+ * @public
1384
+ */
1385
+ targetStatus: TargetProtectedJobStatus | undefined;
1386
+ }
1387
+ /**
1388
+ * @public
1389
+ */
1390
+ export interface UpdateProtectedJobOutput {
1391
+ /**
1392
+ * <p>The protected job output.</p>
1393
+ * @public
1394
+ */
1395
+ protectedJob: ProtectedJob | undefined;
1396
+ }
281
1397
  /**
282
1398
  * @public
283
1399
  * @enum
@@ -730,6 +1846,18 @@ export interface UntagResourceInput {
730
1846
  */
731
1847
  export interface UntagResourceOutput {
732
1848
  }
1849
+ /**
1850
+ * @internal
1851
+ */
1852
+ export declare const ProtectedQuerySQLParametersFilterSensitiveLog: (obj: ProtectedQuerySQLParameters) => any;
1853
+ /**
1854
+ * @internal
1855
+ */
1856
+ export declare const ProtectedQueryFilterSensitiveLog: (obj: ProtectedQuery) => any;
1857
+ /**
1858
+ * @internal
1859
+ */
1860
+ export declare const GetProtectedQueryOutputFilterSensitiveLog: (obj: GetProtectedQueryOutput) => any;
733
1861
  /**
734
1862
  * @internal
735
1863
  */