@aws-sdk/client-cleanrooms 3.934.0 → 3.935.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 (31) hide show
  1. package/dist-cjs/index.js +278 -391
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +277 -0
  4. package/dist-es/models/errors.js +105 -0
  5. package/dist-es/models/models_0.js +5 -349
  6. package/dist-es/models/models_1.js +0 -38
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
  9. package/dist-types/commands/DeleteMembershipCommand.d.ts +1 -1
  10. package/dist-types/commands/GetMembershipCommand.d.ts +1 -1
  11. package/dist-types/commands/GetProtectedJobCommand.d.ts +1 -1
  12. package/dist-types/commands/GetProtectedQueryCommand.d.ts +2 -1
  13. package/dist-types/index.d.ts +4 -1
  14. package/dist-types/models/enums.d.ts +613 -0
  15. package/dist-types/models/errors.d.ts +137 -0
  16. package/dist-types/models/models_0.d.ts +856 -652
  17. package/dist-types/models/models_1.d.ts +2 -953
  18. package/dist-types/ts3.4/commands/CreateMembershipCommand.d.ts +1 -1
  19. package/dist-types/ts3.4/commands/DeleteMembershipCommand.d.ts +1 -1
  20. package/dist-types/ts3.4/commands/GetMembershipCommand.d.ts +1 -1
  21. package/dist-types/ts3.4/commands/GetProtectedJobCommand.d.ts +1 -1
  22. package/dist-types/ts3.4/commands/GetProtectedQueryCommand.d.ts +2 -4
  23. package/dist-types/ts3.4/index.d.ts +4 -1
  24. package/dist-types/ts3.4/models/enums.d.ts +354 -0
  25. package/dist-types/ts3.4/models/errors.d.ts +66 -0
  26. package/dist-types/ts3.4/models/models_0.d.ts +328 -364
  27. package/dist-types/ts3.4/models/models_1.d.ts +23 -341
  28. package/package.json +12 -12
  29. package/dist-es/models/index.js +0 -2
  30. package/dist-types/models/index.d.ts +0 -2
  31. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,923 +1,5 @@
1
- import { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipProtectedJobResultConfiguration, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, ResultFormat } from "./models_0";
2
- /**
3
- * <p>Contains the configuration to write the query results to S3.</p>
4
- * @public
5
- */
6
- export interface ProtectedQueryS3OutputConfiguration {
7
- /**
8
- * <p>Intended file format of the result.</p>
9
- * @public
10
- */
11
- resultFormat: ResultFormat | undefined;
12
- /**
13
- * <p>The S3 bucket to unload the protected query results.</p>
14
- * @public
15
- */
16
- bucket: string | undefined;
17
- /**
18
- * <p>The S3 prefix to unload the protected query results.</p>
19
- * @public
20
- */
21
- keyPrefix?: string | undefined;
22
- /**
23
- * <p>Indicates whether files should be output as a single file (<code>TRUE</code>) or output as multiple files (<code>FALSE</code>). This parameter is only supported for analyses with the Spark analytics engine.</p>
24
- * @public
25
- */
26
- singleFileOutput?: boolean | undefined;
27
- }
28
- /**
29
- * <p>Contains configurations for protected query results.</p>
30
- * @public
31
- */
32
- export type MembershipProtectedQueryOutputConfiguration = MembershipProtectedQueryOutputConfiguration.S3Member | MembershipProtectedQueryOutputConfiguration.$UnknownMember;
33
- /**
34
- * @public
35
- */
36
- export declare namespace MembershipProtectedQueryOutputConfiguration {
37
- /**
38
- * <p>Contains the configuration to write the query results to S3.</p>
39
- * @public
40
- */
41
- interface S3Member {
42
- s3: ProtectedQueryS3OutputConfiguration;
43
- $unknown?: never;
44
- }
45
- /**
46
- * @public
47
- */
48
- interface $UnknownMember {
49
- s3?: never;
50
- $unknown: [string, any];
51
- }
52
- /**
53
- * @deprecated unused in schema-serde mode.
54
- *
55
- */
56
- interface Visitor<T> {
57
- s3: (value: ProtectedQueryS3OutputConfiguration) => T;
58
- _: (name: string, value: any) => T;
59
- }
60
- }
61
- /**
62
- * <p>Contains configurations for protected query results.</p>
63
- * @public
64
- */
65
- export interface MembershipProtectedQueryResultConfiguration {
66
- /**
67
- * <p>Configuration for protected query results.</p>
68
- * @public
69
- */
70
- outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
71
- /**
72
- * <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.</p>
73
- * @public
74
- */
75
- roleArn?: string | undefined;
76
- }
77
- /**
78
- * @public
79
- * @enum
80
- */
81
- export declare const MembershipJobLogStatus: {
82
- readonly DISABLED: "DISABLED";
83
- readonly ENABLED: "ENABLED";
84
- };
85
- /**
86
- * @public
87
- */
88
- export type MembershipJobLogStatus = (typeof MembershipJobLogStatus)[keyof typeof MembershipJobLogStatus];
89
- /**
90
- * <p>An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.</p>
91
- * @public
92
- */
93
- export interface MembershipJobComputePaymentConfig {
94
- /**
95
- * <p>Indicates whether the collaboration member has accepted to pay for job compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs (<code>FALSE</code>).</p> <p>There is only one member who pays for queries and jobs. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query and job compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query and job compute costs. </p> </li> </ul>
96
- * @public
97
- */
98
- isResponsible: boolean | undefined;
99
- }
100
- /**
101
- * <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
102
- * @public
103
- */
104
- export interface MembershipModelInferencePaymentConfig {
105
- /**
106
- * <p>Indicates whether the collaboration member has accepted to pay for model inference costs (<code>TRUE</code>) or has not accepted to pay for model inference costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model inference costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model inference costs. </p> </li> </ul>
107
- * @public
108
- */
109
- isResponsible: boolean | undefined;
110
- }
111
- /**
112
- * <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
113
- * @public
114
- */
115
- export interface MembershipModelTrainingPaymentConfig {
116
- /**
117
- * <p>Indicates whether the collaboration member has accepted to pay for model training costs (<code>TRUE</code>) or has not accepted to pay for model training costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model training costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model training costs. </p> </li> </ul>
118
- * @public
119
- */
120
- isResponsible: boolean | undefined;
121
- }
122
- /**
123
- * <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
124
- * @public
125
- */
126
- export interface MembershipMLPaymentConfig {
127
- /**
128
- * <p>The payment responsibilities accepted by the member for model training.</p>
129
- * @public
130
- */
131
- modelTraining?: MembershipModelTrainingPaymentConfig | undefined;
132
- /**
133
- * <p>The payment responsibilities accepted by the member for model inference.</p>
134
- * @public
135
- */
136
- modelInference?: MembershipModelInferencePaymentConfig | undefined;
137
- }
138
- /**
139
- * <p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>
140
- * @public
141
- */
142
- export interface MembershipQueryComputePaymentConfig {
143
- /**
144
- * <p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>
145
- * @public
146
- */
147
- isResponsible: boolean | undefined;
148
- }
149
- /**
150
- * <p>An object representing the payment responsibilities accepted by the collaboration member.</p>
151
- * @public
152
- */
153
- export interface MembershipPaymentConfiguration {
154
- /**
155
- * <p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>
156
- * @public
157
- */
158
- queryCompute: MembershipQueryComputePaymentConfig | undefined;
159
- /**
160
- * <p>The payment responsibilities accepted by the collaboration member for machine learning costs.</p>
161
- * @public
162
- */
163
- machineLearning?: MembershipMLPaymentConfig | undefined;
164
- /**
165
- * <p>The payment responsibilities accepted by the collaboration member for job compute costs.</p>
166
- * @public
167
- */
168
- jobCompute?: MembershipJobComputePaymentConfig | undefined;
169
- }
170
- /**
171
- * @public
172
- * @enum
173
- */
174
- export declare const MembershipQueryLogStatus: {
175
- readonly DISABLED: "DISABLED";
176
- readonly ENABLED: "ENABLED";
177
- };
178
- /**
179
- * @public
180
- */
181
- export type MembershipQueryLogStatus = (typeof MembershipQueryLogStatus)[keyof typeof MembershipQueryLogStatus];
182
- /**
183
- * @public
184
- */
185
- export interface CreateMembershipInput {
186
- /**
187
- * <p>The unique ID for the associated collaboration.</p>
188
- * @public
189
- */
190
- collaborationIdentifier: string | undefined;
191
- /**
192
- * <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
193
- * @public
194
- */
195
- queryLogStatus: MembershipQueryLogStatus | undefined;
196
- /**
197
- * <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
198
- * @public
199
- */
200
- jobLogStatus?: MembershipJobLogStatus | undefined;
201
- /**
202
- * <p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>
203
- * @public
204
- */
205
- tags?: Record<string, string> | undefined;
206
- /**
207
- * <p>The default protected query result configuration as specified by the member who can receive results.</p>
208
- * @public
209
- */
210
- defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
211
- /**
212
- * <p>The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.</p>
213
- * @public
214
- */
215
- defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
216
- /**
217
- * <p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries. </p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. </p>
218
- * @public
219
- */
220
- paymentConfiguration?: MembershipPaymentConfiguration | undefined;
221
- }
222
- /**
223
- * @public
224
- * @enum
225
- */
226
- export declare const MembershipStatus: {
227
- readonly ACTIVE: "ACTIVE";
228
- readonly COLLABORATION_DELETED: "COLLABORATION_DELETED";
229
- readonly REMOVED: "REMOVED";
230
- };
231
- /**
232
- * @public
233
- */
234
- export type MembershipStatus = (typeof MembershipStatus)[keyof typeof MembershipStatus];
235
- /**
236
- * <p>The membership object.</p>
237
- * @public
238
- */
239
- export interface Membership {
240
- /**
241
- * <p>The unique ID of the membership.</p>
242
- * @public
243
- */
244
- id: string | undefined;
245
- /**
246
- * <p>The unique ARN for the membership.</p>
247
- * @public
248
- */
249
- arn: string | undefined;
250
- /**
251
- * <p>The unique ARN for the membership's associated collaboration.</p>
252
- * @public
253
- */
254
- collaborationArn: string | undefined;
255
- /**
256
- * <p>The unique ID for the membership's collaboration.</p>
257
- * @public
258
- */
259
- collaborationId: string | undefined;
260
- /**
261
- * <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
262
- * @public
263
- */
264
- collaborationCreatorAccountId: string | undefined;
265
- /**
266
- * <p>The display name of the collaboration creator.</p>
267
- * @public
268
- */
269
- collaborationCreatorDisplayName: string | undefined;
270
- /**
271
- * <p>The name of the membership's collaboration.</p>
272
- * @public
273
- */
274
- collaborationName: string | undefined;
275
- /**
276
- * <p>The time when the membership was created.</p>
277
- * @public
278
- */
279
- createTime: Date | undefined;
280
- /**
281
- * <p>The time the membership metadata was last updated.</p>
282
- * @public
283
- */
284
- updateTime: Date | undefined;
285
- /**
286
- * <p>The status of the membership.</p>
287
- * @public
288
- */
289
- status: MembershipStatus | undefined;
290
- /**
291
- * <p>The abilities granted to the collaboration member.</p>
292
- * @public
293
- */
294
- memberAbilities: MemberAbility[] | undefined;
295
- /**
296
- * <p>Specifies the ML member abilities that are granted to a collaboration member.</p>
297
- * @public
298
- */
299
- mlMemberAbilities?: MLMemberAbilities | undefined;
300
- /**
301
- * <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
302
- * @public
303
- */
304
- queryLogStatus: MembershipQueryLogStatus | undefined;
305
- /**
306
- * <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
307
- * @public
308
- */
309
- jobLogStatus?: MembershipJobLogStatus | undefined;
310
- /**
311
- * <p>The default protected query result configuration as specified by the member who can receive results.</p>
312
- * @public
313
- */
314
- defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration | undefined;
315
- /**
316
- * <p> The default job result configuration for the membership.</p>
317
- * @public
318
- */
319
- defaultJobResultConfiguration?: MembershipProtectedJobResultConfiguration | undefined;
320
- /**
321
- * <p>The payment responsibilities accepted by the collaboration member.</p>
322
- * @public
323
- */
324
- paymentConfiguration: MembershipPaymentConfiguration | undefined;
325
- }
326
- /**
327
- * @public
328
- */
329
- export interface CreateMembershipOutput {
330
- /**
331
- * <p>The membership that was created.</p>
332
- * @public
333
- */
334
- membership: Membership | undefined;
335
- }
336
- /**
337
- * @public
338
- */
339
- export interface DeleteMembershipInput {
340
- /**
341
- * <p>The identifier for a membership resource.</p>
342
- * @public
343
- */
344
- membershipIdentifier: string | undefined;
345
- }
346
- /**
347
- * @public
348
- */
349
- export interface DeleteMembershipOutput {
350
- }
351
- /**
352
- * @public
353
- */
354
- export interface GetMembershipInput {
355
- /**
356
- * <p>The identifier for a membership resource.</p>
357
- * @public
358
- */
359
- membershipIdentifier: string | undefined;
360
- }
361
- /**
362
- * @public
363
- */
364
- export interface GetMembershipOutput {
365
- /**
366
- * <p>The membership retrieved for the provided identifier.</p>
367
- * @public
368
- */
369
- membership: Membership | undefined;
370
- }
371
- /**
372
- * @public
373
- */
374
- export interface GetProtectedJobInput {
375
- /**
376
- * <p> The identifier for a membership in a protected job instance.</p>
377
- * @public
378
- */
379
- membershipIdentifier: string | undefined;
380
- /**
381
- * <p> The identifier for the protected job instance.</p>
382
- * @public
383
- */
384
- protectedJobIdentifier: string | undefined;
385
- }
386
- /**
387
- * @public
388
- * @enum
389
- */
390
- export declare const ProtectedJobWorkerComputeType: {
391
- readonly CR1X: "CR.1X";
392
- readonly CR4X: "CR.4X";
393
- };
394
- /**
395
- * @public
396
- */
397
- export type ProtectedJobWorkerComputeType = (typeof ProtectedJobWorkerComputeType)[keyof typeof ProtectedJobWorkerComputeType];
398
- /**
399
- * <p>The configuration of the compute resources for a PySpark job.</p>
400
- * @public
401
- */
402
- export interface ProtectedJobWorkerComputeConfiguration {
403
- /**
404
- * <p>The worker compute configuration type.</p>
405
- * @public
406
- */
407
- type: ProtectedJobWorkerComputeType | undefined;
408
- /**
409
- * <p>The number of workers for a PySpark job.</p>
410
- * @public
411
- */
412
- number: number | undefined;
413
- }
414
- /**
415
- * <p>The configuration of the compute resources for a PySpark job.</p>
416
- * @public
417
- */
418
- export type ProtectedJobComputeConfiguration = ProtectedJobComputeConfiguration.WorkerMember | ProtectedJobComputeConfiguration.$UnknownMember;
419
- /**
420
- * @public
421
- */
422
- export declare namespace ProtectedJobComputeConfiguration {
423
- /**
424
- * <p>The worker configuration for the compute environment.</p>
425
- * @public
426
- */
427
- interface WorkerMember {
428
- worker: ProtectedJobWorkerComputeConfiguration;
429
- $unknown?: never;
430
- }
431
- /**
432
- * @public
433
- */
434
- interface $UnknownMember {
435
- worker?: never;
436
- $unknown: [string, any];
437
- }
438
- /**
439
- * @deprecated unused in schema-serde mode.
440
- *
441
- */
442
- interface Visitor<T> {
443
- worker: (value: ProtectedJobWorkerComputeConfiguration) => T;
444
- _: (name: string, value: any) => T;
445
- }
446
- }
447
- /**
448
- * <p>The protected job error.</p>
449
- * @public
450
- */
451
- export interface ProtectedJobError {
452
- /**
453
- * <p> The message for the protected job error.</p>
454
- * @public
455
- */
456
- message: string | undefined;
457
- /**
458
- * <p> The error code for the protected job.</p>
459
- * @public
460
- */
461
- code: string | undefined;
462
- }
463
- /**
464
- * <p>The parameters for the protected job.</p>
465
- * @public
466
- */
467
- export interface ProtectedJobParameters {
468
- /**
469
- * <p> The ARN of the analysis template.</p>
470
- * @public
471
- */
472
- analysisTemplateArn?: string | undefined;
473
- }
474
- /**
475
- * <p>Details about the member who received the job result.</p>
476
- * @public
477
- */
478
- export interface ProtectedJobSingleMemberOutput {
479
- /**
480
- * <p>The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.</p>
481
- * @public
482
- */
483
- accountId: string | undefined;
484
- }
485
- /**
486
- * <p>Contains output information for protected jobs with an S3 output type.</p>
487
- * @public
488
- */
489
- export interface ProtectedJobS3Output {
490
- /**
491
- * <p> The S3 location for the protected job output.</p>
492
- * @public
493
- */
494
- location: string | undefined;
495
- }
496
- /**
497
- * <p>Contains details about the protected job output.</p>
498
- * @public
499
- */
500
- export type ProtectedJobOutput = ProtectedJobOutput.MemberListMember | ProtectedJobOutput.S3Member | ProtectedJobOutput.$UnknownMember;
501
- /**
502
- * @public
503
- */
504
- export declare namespace ProtectedJobOutput {
505
- /**
506
- * <p>If present, the output for a protected job with an `S3` output type.</p>
507
- * @public
508
- */
509
- interface S3Member {
510
- s3: ProtectedJobS3Output;
511
- memberList?: never;
512
- $unknown?: never;
513
- }
514
- /**
515
- * <p>The list of member Amazon Web Services account(s) that received the results of the job. </p>
516
- * @public
517
- */
518
- interface MemberListMember {
519
- s3?: never;
520
- memberList: ProtectedJobSingleMemberOutput[];
521
- $unknown?: never;
522
- }
523
- /**
524
- * @public
525
- */
526
- interface $UnknownMember {
527
- s3?: never;
528
- memberList?: never;
529
- $unknown: [string, any];
530
- }
531
- /**
532
- * @deprecated unused in schema-serde mode.
533
- *
534
- */
535
- interface Visitor<T> {
536
- s3: (value: ProtectedJobS3Output) => T;
537
- memberList: (value: ProtectedJobSingleMemberOutput[]) => T;
538
- _: (name: string, value: any) => T;
539
- }
540
- }
541
- /**
542
- * <p>Details about the job results.</p>
543
- * @public
544
- */
545
- export interface ProtectedJobResult {
546
- /**
547
- * <p> The output of the protected job.</p>
548
- * @public
549
- */
550
- output: ProtectedJobOutput | undefined;
551
- }
552
- /**
553
- * <p> The protected job member output configuration output.</p>
554
- * @public
555
- */
556
- export interface ProtectedJobMemberOutputConfigurationOutput {
557
- /**
558
- * <p> The account ID.</p>
559
- * @public
560
- */
561
- accountId: string | undefined;
562
- }
563
- /**
564
- * <p> The output configuration for a protected job's S3 output.</p>
565
- * @public
566
- */
567
- export interface ProtectedJobS3OutputConfigurationOutput {
568
- /**
569
- * <p> The S3 bucket for job output.</p>
570
- * @public
571
- */
572
- bucket: string | undefined;
573
- /**
574
- * <p>The S3 prefix to unload the protected job results.</p>
575
- * @public
576
- */
577
- keyPrefix?: string | undefined;
578
- }
579
- /**
580
- * <p> The protected job output configuration output.</p>
581
- * @public
582
- */
583
- export type ProtectedJobOutputConfigurationOutput = ProtectedJobOutputConfigurationOutput.MemberMember | ProtectedJobOutputConfigurationOutput.S3Member | ProtectedJobOutputConfigurationOutput.$UnknownMember;
584
- /**
585
- * @public
586
- */
587
- export declare namespace ProtectedJobOutputConfigurationOutput {
588
- /**
589
- * <p>If present, the output for a protected job with an `S3` output type.</p>
590
- * @public
591
- */
592
- interface S3Member {
593
- s3: ProtectedJobS3OutputConfigurationOutput;
594
- member?: never;
595
- $unknown?: never;
596
- }
597
- /**
598
- * <p> The member output configuration for a protected job.</p>
599
- * @public
600
- */
601
- interface MemberMember {
602
- s3?: never;
603
- member: ProtectedJobMemberOutputConfigurationOutput;
604
- $unknown?: never;
605
- }
606
- /**
607
- * @public
608
- */
609
- interface $UnknownMember {
610
- s3?: never;
611
- member?: never;
612
- $unknown: [string, any];
613
- }
614
- /**
615
- * @deprecated unused in schema-serde mode.
616
- *
617
- */
618
- interface Visitor<T> {
619
- s3: (value: ProtectedJobS3OutputConfigurationOutput) => T;
620
- member: (value: ProtectedJobMemberOutputConfigurationOutput) => T;
621
- _: (name: string, value: any) => T;
622
- }
623
- }
624
- /**
625
- * <p>The output configuration for a protected job result.</p>
626
- * @public
627
- */
628
- export interface ProtectedJobResultConfigurationOutput {
629
- /**
630
- * <p>The output configuration.</p>
631
- * @public
632
- */
633
- outputConfiguration: ProtectedJobOutputConfigurationOutput | undefined;
634
- }
635
- /**
636
- * <p> Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected job.</p>
637
- * @public
638
- */
639
- export interface BilledJobResourceUtilization {
640
- /**
641
- * <p> The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.</p>
642
- * @public
643
- */
644
- units: number | undefined;
645
- }
646
- /**
647
- * <p>Contains statistics about the execution of the protected job.</p>
648
- * @public
649
- */
650
- export interface ProtectedJobStatistics {
651
- /**
652
- * <p>The duration of the protected job, from creation until job completion, in milliseconds.</p>
653
- * @public
654
- */
655
- totalDurationInMillis?: number | undefined;
656
- /**
657
- * <p> The billed resource utilization for the protected job.</p>
658
- * @public
659
- */
660
- billedResourceUtilization?: BilledJobResourceUtilization | undefined;
661
- }
662
- /**
663
- * @public
664
- * @enum
665
- */
666
- export declare const ProtectedJobStatus: {
667
- readonly CANCELLED: "CANCELLED";
668
- readonly CANCELLING: "CANCELLING";
669
- readonly FAILED: "FAILED";
670
- readonly STARTED: "STARTED";
671
- readonly SUBMITTED: "SUBMITTED";
672
- readonly SUCCESS: "SUCCESS";
673
- };
674
- /**
675
- * @public
676
- */
677
- export type ProtectedJobStatus = (typeof ProtectedJobStatus)[keyof typeof ProtectedJobStatus];
678
- /**
679
- * <p>The parameters for an Clean Rooms protected job.</p>
680
- * @public
681
- */
682
- export interface ProtectedJob {
683
- /**
684
- * <p>The identifier for a protected job instance.</p>
685
- * @public
686
- */
687
- id: string | undefined;
688
- /**
689
- * <p>he identifier for the membership.</p>
690
- * @public
691
- */
692
- membershipId: string | undefined;
693
- /**
694
- * <p>The ARN of the membership.</p>
695
- * @public
696
- */
697
- membershipArn: string | undefined;
698
- /**
699
- * <p> The creation time of the protected job.</p>
700
- * @public
701
- */
702
- createTime: Date | undefined;
703
- /**
704
- * <p> The job parameters for the protected job.</p>
705
- * @public
706
- */
707
- jobParameters?: ProtectedJobParameters | undefined;
708
- /**
709
- * <p> The status of the protected job.</p>
710
- * @public
711
- */
712
- status: ProtectedJobStatus | undefined;
713
- /**
714
- * <p>Contains any details needed to write the job results.</p>
715
- * @public
716
- */
717
- resultConfiguration?: ProtectedJobResultConfigurationOutput | undefined;
718
- /**
719
- * <p> The statistics of the protected job.</p>
720
- * @public
721
- */
722
- statistics?: ProtectedJobStatistics | undefined;
723
- /**
724
- * <p> The result of the protected job.</p>
725
- * @public
726
- */
727
- result?: ProtectedJobResult | undefined;
728
- /**
729
- * <p> The error from the protected job.</p>
730
- * @public
731
- */
732
- error?: ProtectedJobError | undefined;
733
- /**
734
- * <p>The compute configuration for the protected job.</p>
735
- * @public
736
- */
737
- computeConfiguration?: ProtectedJobComputeConfiguration | undefined;
738
- }
739
- /**
740
- * @public
741
- */
742
- export interface GetProtectedJobOutput {
743
- /**
744
- * <p> The protected job metadata.</p>
745
- * @public
746
- */
747
- protectedJob: ProtectedJob | undefined;
748
- }
749
- /**
750
- * @public
751
- */
752
- export interface GetProtectedQueryInput {
753
- /**
754
- * <p>The identifier for a membership in a protected query instance.</p>
755
- * @public
756
- */
757
- membershipIdentifier: string | undefined;
758
- /**
759
- * <p>The identifier for a protected query instance.</p>
760
- * @public
761
- */
762
- protectedQueryIdentifier: string | undefined;
763
- }
764
- /**
765
- * <p>The configuration properties that define the compute environment settings for workers in Clean Rooms. These properties enable customization of the underlying compute environment to optimize performance for your specific workloads.</p>
766
- * @public
767
- */
768
- export type WorkerComputeConfigurationProperties = WorkerComputeConfigurationProperties.SparkMember | WorkerComputeConfigurationProperties.$UnknownMember;
769
- /**
770
- * @public
771
- */
772
- export declare namespace WorkerComputeConfigurationProperties {
773
- /**
774
- * <p>The Spark configuration properties for SQL workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.</p>
775
- * @public
776
- */
777
- interface SparkMember {
778
- spark: Record<string, string>;
779
- $unknown?: never;
780
- }
781
- /**
782
- * @public
783
- */
784
- interface $UnknownMember {
785
- spark?: never;
786
- $unknown: [string, any];
787
- }
788
- /**
789
- * @deprecated unused in schema-serde mode.
790
- *
791
- */
792
- interface Visitor<T> {
793
- spark: (value: Record<string, string>) => T;
794
- _: (name: string, value: any) => T;
795
- }
796
- }
797
- /**
798
- * @public
799
- * @enum
800
- */
801
- export declare const WorkerComputeType: {
802
- readonly CR1X: "CR.1X";
803
- readonly CR4X: "CR.4X";
804
- };
805
- /**
806
- * @public
807
- */
808
- export type WorkerComputeType = (typeof WorkerComputeType)[keyof typeof WorkerComputeType];
809
- /**
810
- * <p> The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.</p>
811
- * @public
812
- */
813
- export interface WorkerComputeConfiguration {
814
- /**
815
- * <p> The worker compute configuration type.</p>
816
- * @public
817
- */
818
- type?: WorkerComputeType | undefined;
819
- /**
820
- * <p> The number of workers.</p> <p>SQL queries support a minimum value of 2 and a maximum value of 400. </p> <p>PySpark jobs support a minimum value of 4 and a maximum value of 128.</p>
821
- * @public
822
- */
823
- number?: number | undefined;
824
- /**
825
- * <p>The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your Clean Rooms workloads.</p>
826
- * @public
827
- */
828
- properties?: WorkerComputeConfigurationProperties | undefined;
829
- }
830
- /**
831
- * <p> The configuration of the compute resources for an analysis with the Spark analytics engine.</p>
832
- * @public
833
- */
834
- export type ComputeConfiguration = ComputeConfiguration.WorkerMember | ComputeConfiguration.$UnknownMember;
835
- /**
836
- * @public
837
- */
838
- export declare namespace ComputeConfiguration {
839
- /**
840
- * <p> The worker configuration for the compute environment.</p>
841
- * @public
842
- */
843
- interface WorkerMember {
844
- worker: WorkerComputeConfiguration;
845
- $unknown?: never;
846
- }
847
- /**
848
- * @public
849
- */
850
- interface $UnknownMember {
851
- worker?: never;
852
- $unknown: [string, any];
853
- }
854
- /**
855
- * @deprecated unused in schema-serde mode.
856
- *
857
- */
858
- interface Visitor<T> {
859
- worker: (value: WorkerComputeConfiguration) => T;
860
- _: (name: string, value: any) => T;
861
- }
862
- }
863
- /**
864
- * <p>Provides the sensitivity parameters.</p>
865
- * @public
866
- */
867
- export interface DifferentialPrivacySensitivityParameters {
868
- /**
869
- * <p>The type of aggregation function that was run.</p>
870
- * @public
871
- */
872
- aggregationType: DifferentialPrivacyAggregationType | undefined;
873
- /**
874
- * <p>The aggregation expression that was run.</p>
875
- * @public
876
- */
877
- aggregationExpression: string | undefined;
878
- /**
879
- * <p>The maximum number of rows contributed by a user in a SQL query.</p>
880
- * @public
881
- */
882
- userContributionLimit: number | undefined;
883
- /**
884
- * <p>The lower bound of the aggregation expression.</p>
885
- * @public
886
- */
887
- minColumnValue?: number | undefined;
888
- /**
889
- * <p>The upper bound of the aggregation expression.</p>
890
- * @public
891
- */
892
- maxColumnValue?: number | undefined;
893
- }
894
- /**
895
- * <p>An array that contains the sensitivity parameters.</p>
896
- * @public
897
- */
898
- export interface DifferentialPrivacyParameters {
899
- /**
900
- * <p>Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.</p>
901
- * @public
902
- */
903
- sensitivityParameters: DifferentialPrivacySensitivityParameters[] | undefined;
904
- }
905
- /**
906
- * <p>Details of errors thrown by the protected query.</p>
907
- * @public
908
- */
909
- export interface ProtectedQueryError {
910
- /**
911
- * <p>A description of why the query failed.</p>
912
- * @public
913
- */
914
- message: string | undefined;
915
- /**
916
- * <p>An error code for the error.</p>
917
- * @public
918
- */
919
- code: string | undefined;
920
- }
1
+ import { AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobAnalysisType, ProtectedJobStatus, ProtectedJobType, TargetProtectedJobStatus } from "./enums";
2
+ import { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, ComputeConfiguration, DifferentialPrivacyParameters, Membership, MembershipPaymentConfiguration, MembershipProtectedJobResultConfiguration, MembershipProtectedQueryResultConfiguration, MembershipStatus, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateParametersOutput, ProtectedJob, ProtectedJobComputeConfiguration, ProtectedJobParameters, ProtectedQueryError, ProtectedQueryS3OutputConfiguration } from "./models_0";
921
3
  /**
922
4
  * <p>Details about the member who received the query result.</p>
923
5
  * @public
@@ -1541,17 +623,6 @@ export interface ListProtectedJobsInput {
1541
623
  */
1542
624
  maxResults?: number | undefined;
1543
625
  }
1544
- /**
1545
- * @public
1546
- * @enum
1547
- */
1548
- export declare const ProtectedJobAnalysisType: {
1549
- readonly DIRECT_ANALYSIS: "DIRECT_ANALYSIS";
1550
- };
1551
- /**
1552
- * @public
1553
- */
1554
- export type ProtectedJobAnalysisType = (typeof ProtectedJobAnalysisType)[keyof typeof ProtectedJobAnalysisType];
1555
626
  /**
1556
627
  * <p>The protected job direct analysis configuration details.</p>
1557
628
  * @public
@@ -1988,17 +1059,6 @@ export interface ProtectedJobResultConfigurationInput {
1988
1059
  */
1989
1060
  outputConfiguration: ProtectedJobOutputConfigurationInput | undefined;
1990
1061
  }
1991
- /**
1992
- * @public
1993
- * @enum
1994
- */
1995
- export declare const ProtectedJobType: {
1996
- readonly PYSPARK: "PYSPARK";
1997
- };
1998
- /**
1999
- * @public
2000
- */
2001
- export type ProtectedJobType = (typeof ProtectedJobType)[keyof typeof ProtectedJobType];
2002
1062
  /**
2003
1063
  * @public
2004
1064
  */
@@ -2130,17 +1190,6 @@ export interface UpdateMembershipOutput {
2130
1190
  */
2131
1191
  membership: Membership | undefined;
2132
1192
  }
2133
- /**
2134
- * @public
2135
- * @enum
2136
- */
2137
- export declare const TargetProtectedJobStatus: {
2138
- readonly CANCELLED: "CANCELLED";
2139
- };
2140
- /**
2141
- * @public
2142
- */
2143
- export type TargetProtectedJobStatus = (typeof TargetProtectedJobStatus)[keyof typeof TargetProtectedJobStatus];
2144
1193
  /**
2145
1194
  * @public
2146
1195
  */