@aws-sdk/client-cleanrooms 3.381.0 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +453 -0
- package/package.json +5 -5
|
@@ -19,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
readonly name: "AccessDeniedException";
|
|
20
20
|
readonly $fault: "client";
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>A reason code for the exception.</p>
|
|
23
24
|
*/
|
|
24
25
|
reason?: AccessDeniedExceptionReason | string;
|
|
@@ -48,10 +49,12 @@ export type AggregateFunctionName = (typeof AggregateFunctionName)[keyof typeof
|
|
|
48
49
|
*/
|
|
49
50
|
export interface AggregateColumn {
|
|
50
51
|
/**
|
|
52
|
+
* @public
|
|
51
53
|
* <p>Column names in configured table of aggregate columns.</p>
|
|
52
54
|
*/
|
|
53
55
|
columnNames: string[] | undefined;
|
|
54
56
|
/**
|
|
57
|
+
* @public
|
|
55
58
|
* <p>Aggregation function that can be applied to aggregate column in query.</p>
|
|
56
59
|
*/
|
|
57
60
|
function: AggregateFunctionName | string | undefined;
|
|
@@ -73,16 +76,19 @@ export type AggregationType = (typeof AggregationType)[keyof typeof AggregationT
|
|
|
73
76
|
*/
|
|
74
77
|
export interface AggregationConstraint {
|
|
75
78
|
/**
|
|
79
|
+
* @public
|
|
76
80
|
* <p>Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.</p>
|
|
77
81
|
*/
|
|
78
82
|
columnName: string | undefined;
|
|
79
83
|
/**
|
|
84
|
+
* @public
|
|
80
85
|
* <p>The minimum number of distinct values that an output row must be an aggregation of.
|
|
81
86
|
* Minimum threshold of distinct values for a specified column that must exist in an output
|
|
82
87
|
* row for it to be in the query output.</p>
|
|
83
88
|
*/
|
|
84
89
|
minimum: number | undefined;
|
|
85
90
|
/**
|
|
91
|
+
* @public
|
|
86
92
|
* <p>The type of aggregation the constraint allows. The only valid value is currently
|
|
87
93
|
* `COUNT_DISTINCT`.</p>
|
|
88
94
|
*/
|
|
@@ -142,15 +148,18 @@ export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
|
|
|
142
148
|
*/
|
|
143
149
|
export interface AnalysisParameter {
|
|
144
150
|
/**
|
|
151
|
+
* @public
|
|
145
152
|
* <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)
|
|
146
153
|
* characters but cannot start or end with a hyphen.</p>
|
|
147
154
|
*/
|
|
148
155
|
name: string | undefined;
|
|
149
156
|
/**
|
|
157
|
+
* @public
|
|
150
158
|
* <p>The type of parameter.</p>
|
|
151
159
|
*/
|
|
152
160
|
type: ParameterType | string | undefined;
|
|
153
161
|
/**
|
|
162
|
+
* @public
|
|
154
163
|
* <p>Optional. The default value that is applied in the analysis template. The member who can
|
|
155
164
|
* query can override this value in the query editor.</p>
|
|
156
165
|
*/
|
|
@@ -208,33 +217,40 @@ export type ScalarFunctions = (typeof ScalarFunctions)[keyof typeof ScalarFuncti
|
|
|
208
217
|
*/
|
|
209
218
|
export interface AnalysisRuleAggregation {
|
|
210
219
|
/**
|
|
220
|
+
* @public
|
|
211
221
|
* <p>The columns that query runners are allowed to use in aggregation queries.</p>
|
|
212
222
|
*/
|
|
213
223
|
aggregateColumns: AggregateColumn[] | undefined;
|
|
214
224
|
/**
|
|
225
|
+
* @public
|
|
215
226
|
* <p>Columns in configured table that can be used in join statements and/or as aggregate
|
|
216
227
|
* columns. They can never be outputted directly.</p>
|
|
217
228
|
*/
|
|
218
229
|
joinColumns: string[] | undefined;
|
|
219
230
|
/**
|
|
231
|
+
* @public
|
|
220
232
|
* <p>Control that requires member who runs query to do a join with their configured table
|
|
221
233
|
* and/or other configured table in query.</p>
|
|
222
234
|
*/
|
|
223
235
|
joinRequired?: JoinRequiredOption | string;
|
|
224
236
|
/**
|
|
237
|
+
* @public
|
|
225
238
|
* <p>Which logical operators (if any) are to be used in an INNER JOIN match condition.
|
|
226
239
|
* Default is <code>AND</code>.</p>
|
|
227
240
|
*/
|
|
228
241
|
allowedJoinOperators?: (JoinOperator | string)[];
|
|
229
242
|
/**
|
|
243
|
+
* @public
|
|
230
244
|
* <p>The columns that query runners are allowed to select, group by, or filter by.</p>
|
|
231
245
|
*/
|
|
232
246
|
dimensionColumns: string[] | undefined;
|
|
233
247
|
/**
|
|
248
|
+
* @public
|
|
234
249
|
* <p>Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.</p>
|
|
235
250
|
*/
|
|
236
251
|
scalarFunctions: (ScalarFunctions | string)[] | undefined;
|
|
237
252
|
/**
|
|
253
|
+
* @public
|
|
238
254
|
* <p>Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.</p>
|
|
239
255
|
*/
|
|
240
256
|
outputConstraints: AggregationConstraint[] | undefined;
|
|
@@ -245,10 +261,12 @@ export interface AnalysisRuleAggregation {
|
|
|
245
261
|
*/
|
|
246
262
|
export interface AnalysisRuleCustom {
|
|
247
263
|
/**
|
|
264
|
+
* @public
|
|
248
265
|
* <p>The analysis templates that are allowed by the custom analysis rule.</p>
|
|
249
266
|
*/
|
|
250
267
|
allowedAnalyses: string[] | undefined;
|
|
251
268
|
/**
|
|
269
|
+
* @public
|
|
252
270
|
* <p>The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when
|
|
253
271
|
* <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>
|
|
254
272
|
*/
|
|
@@ -260,15 +278,18 @@ export interface AnalysisRuleCustom {
|
|
|
260
278
|
*/
|
|
261
279
|
export interface AnalysisRuleList {
|
|
262
280
|
/**
|
|
281
|
+
* @public
|
|
263
282
|
* <p>Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.</p>
|
|
264
283
|
*/
|
|
265
284
|
joinColumns: string[] | undefined;
|
|
266
285
|
/**
|
|
286
|
+
* @public
|
|
267
287
|
* <p>The logical operators (if any) that are to be used in an INNER JOIN match condition.
|
|
268
288
|
* Default is <code>AND</code>.</p>
|
|
269
289
|
*/
|
|
270
290
|
allowedJoinOperators?: (JoinOperator | string)[];
|
|
271
291
|
/**
|
|
292
|
+
* @public
|
|
272
293
|
* <p>Columns that can be listed in the output.</p>
|
|
273
294
|
*/
|
|
274
295
|
listColumns: string[] | undefined;
|
|
@@ -283,6 +304,7 @@ export type AnalysisRulePolicyV1 = AnalysisRulePolicyV1.AggregationMember | Anal
|
|
|
283
304
|
*/
|
|
284
305
|
export declare namespace AnalysisRulePolicyV1 {
|
|
285
306
|
/**
|
|
307
|
+
* @public
|
|
286
308
|
* <p>Analysis rule type that enables only list queries on a configured table.</p>
|
|
287
309
|
*/
|
|
288
310
|
interface ListMember {
|
|
@@ -292,6 +314,7 @@ export declare namespace AnalysisRulePolicyV1 {
|
|
|
292
314
|
$unknown?: never;
|
|
293
315
|
}
|
|
294
316
|
/**
|
|
317
|
+
* @public
|
|
295
318
|
* <p>Analysis rule type that enables only aggregation queries on a configured table.</p>
|
|
296
319
|
*/
|
|
297
320
|
interface AggregationMember {
|
|
@@ -301,6 +324,7 @@ export declare namespace AnalysisRulePolicyV1 {
|
|
|
301
324
|
$unknown?: never;
|
|
302
325
|
}
|
|
303
326
|
/**
|
|
327
|
+
* @public
|
|
304
328
|
* <p>Analysis rule type that enables custom SQL queries on a configured table.</p>
|
|
305
329
|
*/
|
|
306
330
|
interface CustomMember {
|
|
@@ -309,6 +333,9 @@ export declare namespace AnalysisRulePolicyV1 {
|
|
|
309
333
|
custom: AnalysisRuleCustom;
|
|
310
334
|
$unknown?: never;
|
|
311
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
312
339
|
interface $UnknownMember {
|
|
313
340
|
list?: never;
|
|
314
341
|
aggregation?: never;
|
|
@@ -333,12 +360,16 @@ export type AnalysisRulePolicy = AnalysisRulePolicy.V1Member | AnalysisRulePolic
|
|
|
333
360
|
*/
|
|
334
361
|
export declare namespace AnalysisRulePolicy {
|
|
335
362
|
/**
|
|
363
|
+
* @public
|
|
336
364
|
* <p>Controls on the query specifications that can be run on configured table.</p>
|
|
337
365
|
*/
|
|
338
366
|
interface V1Member {
|
|
339
367
|
v1: AnalysisRulePolicyV1;
|
|
340
368
|
$unknown?: never;
|
|
341
369
|
}
|
|
370
|
+
/**
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
342
373
|
interface $UnknownMember {
|
|
343
374
|
v1?: never;
|
|
344
375
|
$unknown: [string, any];
|
|
@@ -368,26 +399,32 @@ export type AnalysisRuleType = (typeof AnalysisRuleType)[keyof typeof AnalysisRu
|
|
|
368
399
|
*/
|
|
369
400
|
export interface AnalysisRule {
|
|
370
401
|
/**
|
|
402
|
+
* @public
|
|
371
403
|
* <p>The unique ID for the associated collaboration.</p>
|
|
372
404
|
*/
|
|
373
405
|
collaborationId: string | undefined;
|
|
374
406
|
/**
|
|
407
|
+
* @public
|
|
375
408
|
* <p>The type of analysis rule.</p>
|
|
376
409
|
*/
|
|
377
410
|
type: AnalysisRuleType | string | undefined;
|
|
378
411
|
/**
|
|
412
|
+
* @public
|
|
379
413
|
* <p>The name for the analysis rule.</p>
|
|
380
414
|
*/
|
|
381
415
|
name: string | undefined;
|
|
382
416
|
/**
|
|
417
|
+
* @public
|
|
383
418
|
* <p>The time the analysis rule was created.</p>
|
|
384
419
|
*/
|
|
385
420
|
createTime: Date | undefined;
|
|
386
421
|
/**
|
|
422
|
+
* @public
|
|
387
423
|
* <p>The time the analysis rule was last updated.</p>
|
|
388
424
|
*/
|
|
389
425
|
updateTime: Date | undefined;
|
|
390
426
|
/**
|
|
427
|
+
* @public
|
|
391
428
|
* <p>A policy that describes the associated data usage limitations.</p>
|
|
392
429
|
*/
|
|
393
430
|
policy: AnalysisRulePolicy | undefined;
|
|
@@ -398,6 +435,7 @@ export interface AnalysisRule {
|
|
|
398
435
|
*/
|
|
399
436
|
export interface AnalysisSchema {
|
|
400
437
|
/**
|
|
438
|
+
* @public
|
|
401
439
|
* <p>The tables referenced in the analysis schema.</p>
|
|
402
440
|
*/
|
|
403
441
|
referencedTables?: string[];
|
|
@@ -412,12 +450,16 @@ export type AnalysisSource = AnalysisSource.TextMember | AnalysisSource.$Unknown
|
|
|
412
450
|
*/
|
|
413
451
|
export declare namespace AnalysisSource {
|
|
414
452
|
/**
|
|
453
|
+
* @public
|
|
415
454
|
* <p>The query text.</p>
|
|
416
455
|
*/
|
|
417
456
|
interface TextMember {
|
|
418
457
|
text: string;
|
|
419
458
|
$unknown?: never;
|
|
420
459
|
}
|
|
460
|
+
/**
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
421
463
|
interface $UnknownMember {
|
|
422
464
|
text?: never;
|
|
423
465
|
$unknown: [string, any];
|
|
@@ -434,58 +476,72 @@ export declare namespace AnalysisSource {
|
|
|
434
476
|
*/
|
|
435
477
|
export interface AnalysisTemplate {
|
|
436
478
|
/**
|
|
479
|
+
* @public
|
|
437
480
|
* <p>The identifier for the analysis template.</p>
|
|
438
481
|
*/
|
|
439
482
|
id: string | undefined;
|
|
440
483
|
/**
|
|
484
|
+
* @public
|
|
441
485
|
* <p>The Amazon Resource Name (ARN) of the analysis template.</p>
|
|
442
486
|
*/
|
|
443
487
|
arn: string | undefined;
|
|
444
488
|
/**
|
|
489
|
+
* @public
|
|
445
490
|
* <p>The unique ID for the associated collaboration of the analysis template.</p>
|
|
446
491
|
*/
|
|
447
492
|
collaborationId: string | undefined;
|
|
448
493
|
/**
|
|
494
|
+
* @public
|
|
449
495
|
* <p>The unique ARN for the analysis template’s associated collaboration.</p>
|
|
450
496
|
*/
|
|
451
497
|
collaborationArn: string | undefined;
|
|
452
498
|
/**
|
|
499
|
+
* @public
|
|
453
500
|
* <p>The identifier of a member who created the analysis template.</p>
|
|
454
501
|
*/
|
|
455
502
|
membershipId: string | undefined;
|
|
456
503
|
/**
|
|
504
|
+
* @public
|
|
457
505
|
* <p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>
|
|
458
506
|
*/
|
|
459
507
|
membershipArn: string | undefined;
|
|
460
508
|
/**
|
|
509
|
+
* @public
|
|
461
510
|
* <p>The description of the analysis template.</p>
|
|
462
511
|
*/
|
|
463
512
|
description?: string;
|
|
464
513
|
/**
|
|
514
|
+
* @public
|
|
465
515
|
* <p>The name of the analysis template.</p>
|
|
466
516
|
*/
|
|
467
517
|
name: string | undefined;
|
|
468
518
|
/**
|
|
519
|
+
* @public
|
|
469
520
|
* <p>The time that the analysis template was created.</p>
|
|
470
521
|
*/
|
|
471
522
|
createTime: Date | undefined;
|
|
472
523
|
/**
|
|
524
|
+
* @public
|
|
473
525
|
* <p>The time that the analysis template was last updated.</p>
|
|
474
526
|
*/
|
|
475
527
|
updateTime: Date | undefined;
|
|
476
528
|
/**
|
|
529
|
+
* @public
|
|
477
530
|
* <p>The entire schema object.</p>
|
|
478
531
|
*/
|
|
479
532
|
schema: AnalysisSchema | undefined;
|
|
480
533
|
/**
|
|
534
|
+
* @public
|
|
481
535
|
* <p>The format of the analysis template.</p>
|
|
482
536
|
*/
|
|
483
537
|
format: AnalysisFormat | string | undefined;
|
|
484
538
|
/**
|
|
539
|
+
* @public
|
|
485
540
|
* <p>The source of the analysis template.</p>
|
|
486
541
|
*/
|
|
487
542
|
source: AnalysisSource | undefined;
|
|
488
543
|
/**
|
|
544
|
+
* @public
|
|
489
545
|
* <p>The parameters of the analysis template.</p>
|
|
490
546
|
*/
|
|
491
547
|
analysisParameters?: AnalysisParameter[];
|
|
@@ -525,14 +581,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
525
581
|
readonly name: "ConflictException";
|
|
526
582
|
readonly $fault: "client";
|
|
527
583
|
/**
|
|
584
|
+
* @public
|
|
528
585
|
* <p>The ID of the conflicting resource.</p>
|
|
529
586
|
*/
|
|
530
587
|
resourceId?: string;
|
|
531
588
|
/**
|
|
589
|
+
* @public
|
|
532
590
|
* <p>The type of the conflicting resource.</p>
|
|
533
591
|
*/
|
|
534
592
|
resourceType?: ResourceType | string;
|
|
535
593
|
/**
|
|
594
|
+
* @public
|
|
536
595
|
* <p>A reason code for the exception.</p>
|
|
537
596
|
*/
|
|
538
597
|
reason?: ConflictExceptionReason | string;
|
|
@@ -546,31 +605,38 @@ export declare class ConflictException extends __BaseException {
|
|
|
546
605
|
*/
|
|
547
606
|
export interface CreateAnalysisTemplateInput {
|
|
548
607
|
/**
|
|
608
|
+
* @public
|
|
549
609
|
* <p>The description of the analysis template.</p>
|
|
550
610
|
*/
|
|
551
611
|
description?: string;
|
|
552
612
|
/**
|
|
613
|
+
* @public
|
|
553
614
|
* <p>The identifier for a membership resource.</p>
|
|
554
615
|
*/
|
|
555
616
|
membershipIdentifier: string | undefined;
|
|
556
617
|
/**
|
|
618
|
+
* @public
|
|
557
619
|
* <p>The name of the analysis template.</p>
|
|
558
620
|
*/
|
|
559
621
|
name: string | undefined;
|
|
560
622
|
/**
|
|
623
|
+
* @public
|
|
561
624
|
* <p>The format of the analysis template.</p>
|
|
562
625
|
*/
|
|
563
626
|
format: AnalysisFormat | string | undefined;
|
|
564
627
|
/**
|
|
628
|
+
* @public
|
|
565
629
|
* <p>The information in the analysis template. Currently supports <code>text</code>, the
|
|
566
630
|
* query text for the analysis template.</p>
|
|
567
631
|
*/
|
|
568
632
|
source: AnalysisSource | undefined;
|
|
569
633
|
/**
|
|
634
|
+
* @public
|
|
570
635
|
* <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>
|
|
571
636
|
*/
|
|
572
637
|
tags?: Record<string, string>;
|
|
573
638
|
/**
|
|
639
|
+
* @public
|
|
574
640
|
* <p>The parameters of the analysis template.</p>
|
|
575
641
|
*/
|
|
576
642
|
analysisParameters?: AnalysisParameter[];
|
|
@@ -580,6 +646,7 @@ export interface CreateAnalysisTemplateInput {
|
|
|
580
646
|
*/
|
|
581
647
|
export interface CreateAnalysisTemplateOutput {
|
|
582
648
|
/**
|
|
649
|
+
* @public
|
|
583
650
|
* <p>The analysis template.</p>
|
|
584
651
|
*/
|
|
585
652
|
analysisTemplate: AnalysisTemplate | undefined;
|
|
@@ -604,10 +671,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
604
671
|
readonly name: "ResourceNotFoundException";
|
|
605
672
|
readonly $fault: "client";
|
|
606
673
|
/**
|
|
674
|
+
* @public
|
|
607
675
|
* <p>The Id of the missing resource.</p>
|
|
608
676
|
*/
|
|
609
677
|
resourceId: string | undefined;
|
|
610
678
|
/**
|
|
679
|
+
* @public
|
|
611
680
|
* <p>The type of the missing resource.</p>
|
|
612
681
|
*/
|
|
613
682
|
resourceType: ResourceType | string | undefined;
|
|
@@ -624,10 +693,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
624
693
|
readonly name: "ServiceQuotaExceededException";
|
|
625
694
|
readonly $fault: "client";
|
|
626
695
|
/**
|
|
696
|
+
* @public
|
|
627
697
|
* <p>The name of the quota.</p>
|
|
628
698
|
*/
|
|
629
699
|
quotaName: string | undefined;
|
|
630
700
|
/**
|
|
701
|
+
* @public
|
|
631
702
|
* <p>The value of the quota.</p>
|
|
632
703
|
*/
|
|
633
704
|
quotaValue: number | undefined;
|
|
@@ -654,10 +725,12 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
654
725
|
*/
|
|
655
726
|
export interface ValidationExceptionField {
|
|
656
727
|
/**
|
|
728
|
+
* @public
|
|
657
729
|
* <p>The name of the input parameter.</p>
|
|
658
730
|
*/
|
|
659
731
|
name: string | undefined;
|
|
660
732
|
/**
|
|
733
|
+
* @public
|
|
661
734
|
* <p>A message for the input validation error.</p>
|
|
662
735
|
*/
|
|
663
736
|
message: string | undefined;
|
|
@@ -684,10 +757,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
684
757
|
readonly name: "ValidationException";
|
|
685
758
|
readonly $fault: "client";
|
|
686
759
|
/**
|
|
760
|
+
* @public
|
|
687
761
|
* <p>A reason code for the exception.</p>
|
|
688
762
|
*/
|
|
689
763
|
reason?: ValidationExceptionReason | string;
|
|
690
764
|
/**
|
|
765
|
+
* @public
|
|
691
766
|
* <p>Validation errors for specific input parameters.</p>
|
|
692
767
|
*/
|
|
693
768
|
fieldList?: ValidationExceptionField[];
|
|
@@ -701,10 +776,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
701
776
|
*/
|
|
702
777
|
export interface DeleteAnalysisTemplateInput {
|
|
703
778
|
/**
|
|
779
|
+
* @public
|
|
704
780
|
* <p>The identifier for a membership resource.</p>
|
|
705
781
|
*/
|
|
706
782
|
membershipIdentifier: string | undefined;
|
|
707
783
|
/**
|
|
784
|
+
* @public
|
|
708
785
|
* <p>The identifier for the analysis template resource.</p>
|
|
709
786
|
*/
|
|
710
787
|
analysisTemplateIdentifier: string | undefined;
|
|
@@ -719,10 +796,12 @@ export interface DeleteAnalysisTemplateOutput {
|
|
|
719
796
|
*/
|
|
720
797
|
export interface GetAnalysisTemplateInput {
|
|
721
798
|
/**
|
|
799
|
+
* @public
|
|
722
800
|
* <p>The identifier for a membership resource.</p>
|
|
723
801
|
*/
|
|
724
802
|
membershipIdentifier: string | undefined;
|
|
725
803
|
/**
|
|
804
|
+
* @public
|
|
726
805
|
* <p>The identifier for the analysis template resource.</p>
|
|
727
806
|
*/
|
|
728
807
|
analysisTemplateIdentifier: string | undefined;
|
|
@@ -732,6 +811,7 @@ export interface GetAnalysisTemplateInput {
|
|
|
732
811
|
*/
|
|
733
812
|
export interface GetAnalysisTemplateOutput {
|
|
734
813
|
/**
|
|
814
|
+
* @public
|
|
735
815
|
* <p>The analysis template.</p>
|
|
736
816
|
*/
|
|
737
817
|
analysisTemplate: AnalysisTemplate | undefined;
|
|
@@ -741,14 +821,17 @@ export interface GetAnalysisTemplateOutput {
|
|
|
741
821
|
*/
|
|
742
822
|
export interface ListAnalysisTemplatesInput {
|
|
743
823
|
/**
|
|
824
|
+
* @public
|
|
744
825
|
* <p>The identifier for a membership resource.</p>
|
|
745
826
|
*/
|
|
746
827
|
membershipIdentifier: string | undefined;
|
|
747
828
|
/**
|
|
829
|
+
* @public
|
|
748
830
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
749
831
|
*/
|
|
750
832
|
nextToken?: string;
|
|
751
833
|
/**
|
|
834
|
+
* @public
|
|
752
835
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
753
836
|
*/
|
|
754
837
|
maxResults?: number;
|
|
@@ -759,42 +842,52 @@ export interface ListAnalysisTemplatesInput {
|
|
|
759
842
|
*/
|
|
760
843
|
export interface AnalysisTemplateSummary {
|
|
761
844
|
/**
|
|
845
|
+
* @public
|
|
762
846
|
* <p>The Amazon Resource Name (ARN) of the analysis template.</p>
|
|
763
847
|
*/
|
|
764
848
|
arn: string | undefined;
|
|
765
849
|
/**
|
|
850
|
+
* @public
|
|
766
851
|
* <p>The time that the analysis template summary was created.</p>
|
|
767
852
|
*/
|
|
768
853
|
createTime: Date | undefined;
|
|
769
854
|
/**
|
|
855
|
+
* @public
|
|
770
856
|
* <p>The identifier of the analysis template.</p>
|
|
771
857
|
*/
|
|
772
858
|
id: string | undefined;
|
|
773
859
|
/**
|
|
860
|
+
* @public
|
|
774
861
|
* <p>The name of the analysis template. </p>
|
|
775
862
|
*/
|
|
776
863
|
name: string | undefined;
|
|
777
864
|
/**
|
|
865
|
+
* @public
|
|
778
866
|
* <p>The time that the analysis template summary was last updated.</p>
|
|
779
867
|
*/
|
|
780
868
|
updateTime: Date | undefined;
|
|
781
869
|
/**
|
|
870
|
+
* @public
|
|
782
871
|
* <p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>
|
|
783
872
|
*/
|
|
784
873
|
membershipArn: string | undefined;
|
|
785
874
|
/**
|
|
875
|
+
* @public
|
|
786
876
|
* <p>The identifier for a membership resource.</p>
|
|
787
877
|
*/
|
|
788
878
|
membershipId: string | undefined;
|
|
789
879
|
/**
|
|
880
|
+
* @public
|
|
790
881
|
* <p>The unique ARN for the analysis template summary’s associated collaboration.</p>
|
|
791
882
|
*/
|
|
792
883
|
collaborationArn: string | undefined;
|
|
793
884
|
/**
|
|
885
|
+
* @public
|
|
794
886
|
* <p>A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.</p>
|
|
795
887
|
*/
|
|
796
888
|
collaborationId: string | undefined;
|
|
797
889
|
/**
|
|
890
|
+
* @public
|
|
798
891
|
* <p>The description of the analysis template.</p>
|
|
799
892
|
*/
|
|
800
893
|
description?: string;
|
|
@@ -804,10 +897,12 @@ export interface AnalysisTemplateSummary {
|
|
|
804
897
|
*/
|
|
805
898
|
export interface ListAnalysisTemplatesOutput {
|
|
806
899
|
/**
|
|
900
|
+
* @public
|
|
807
901
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
808
902
|
*/
|
|
809
903
|
nextToken?: string;
|
|
810
904
|
/**
|
|
905
|
+
* @public
|
|
811
906
|
* <p>Lists analysis template metadata.</p>
|
|
812
907
|
*/
|
|
813
908
|
analysisTemplateSummaries: AnalysisTemplateSummary[] | undefined;
|
|
@@ -817,14 +912,17 @@ export interface ListAnalysisTemplatesOutput {
|
|
|
817
912
|
*/
|
|
818
913
|
export interface UpdateAnalysisTemplateInput {
|
|
819
914
|
/**
|
|
915
|
+
* @public
|
|
820
916
|
* <p>The identifier for a membership resource.</p>
|
|
821
917
|
*/
|
|
822
918
|
membershipIdentifier: string | undefined;
|
|
823
919
|
/**
|
|
920
|
+
* @public
|
|
824
921
|
* <p>The identifier for the analysis template resource.</p>
|
|
825
922
|
*/
|
|
826
923
|
analysisTemplateIdentifier: string | undefined;
|
|
827
924
|
/**
|
|
925
|
+
* @public
|
|
828
926
|
* <p>A new description for the analysis template.</p>
|
|
829
927
|
*/
|
|
830
928
|
description?: string;
|
|
@@ -834,6 +932,7 @@ export interface UpdateAnalysisTemplateInput {
|
|
|
834
932
|
*/
|
|
835
933
|
export interface UpdateAnalysisTemplateOutput {
|
|
836
934
|
/**
|
|
935
|
+
* @public
|
|
837
936
|
* <p>The analysis template.</p>
|
|
838
937
|
*/
|
|
839
938
|
analysisTemplate: AnalysisTemplate | undefined;
|
|
@@ -843,10 +942,12 @@ export interface UpdateAnalysisTemplateOutput {
|
|
|
843
942
|
*/
|
|
844
943
|
export interface BatchGetCollaborationAnalysisTemplateInput {
|
|
845
944
|
/**
|
|
945
|
+
* @public
|
|
846
946
|
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
847
947
|
*/
|
|
848
948
|
collaborationIdentifier: string | undefined;
|
|
849
949
|
/**
|
|
950
|
+
* @public
|
|
850
951
|
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
|
|
851
952
|
*/
|
|
852
953
|
analysisTemplateArns: string[] | undefined;
|
|
@@ -857,54 +958,67 @@ export interface BatchGetCollaborationAnalysisTemplateInput {
|
|
|
857
958
|
*/
|
|
858
959
|
export interface CollaborationAnalysisTemplate {
|
|
859
960
|
/**
|
|
961
|
+
* @public
|
|
860
962
|
* <p>The identifier of the analysis template.</p>
|
|
861
963
|
*/
|
|
862
964
|
id: string | undefined;
|
|
863
965
|
/**
|
|
966
|
+
* @public
|
|
864
967
|
* <p>The Amazon Resource Name (ARN) of the analysis template.</p>
|
|
865
968
|
*/
|
|
866
969
|
arn: string | undefined;
|
|
867
970
|
/**
|
|
971
|
+
* @public
|
|
868
972
|
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
869
973
|
*/
|
|
870
974
|
collaborationId: string | undefined;
|
|
871
975
|
/**
|
|
976
|
+
* @public
|
|
872
977
|
* <p>The unique ARN for the analysis template’s associated collaboration.</p>
|
|
873
978
|
*/
|
|
874
979
|
collaborationArn: string | undefined;
|
|
875
980
|
/**
|
|
981
|
+
* @public
|
|
876
982
|
* <p>The description of the analysis template.</p>
|
|
877
983
|
*/
|
|
878
984
|
description?: string;
|
|
879
985
|
/**
|
|
986
|
+
* @public
|
|
880
987
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
881
988
|
*/
|
|
882
989
|
creatorAccountId: string | undefined;
|
|
883
990
|
/**
|
|
991
|
+
* @public
|
|
884
992
|
* <p>The name of the analysis template.</p>
|
|
885
993
|
*/
|
|
886
994
|
name: string | undefined;
|
|
887
995
|
/**
|
|
996
|
+
* @public
|
|
888
997
|
* <p>The time that the analysis template within a collaboration was created.</p>
|
|
889
998
|
*/
|
|
890
999
|
createTime: Date | undefined;
|
|
891
1000
|
/**
|
|
1001
|
+
* @public
|
|
892
1002
|
* <p>The time that the analysis template in the collaboration was last updated.</p>
|
|
893
1003
|
*/
|
|
894
1004
|
updateTime: Date | undefined;
|
|
895
1005
|
/**
|
|
1006
|
+
* @public
|
|
896
1007
|
* <p>The entire schema object.</p>
|
|
897
1008
|
*/
|
|
898
1009
|
schema: AnalysisSchema | undefined;
|
|
899
1010
|
/**
|
|
1011
|
+
* @public
|
|
900
1012
|
* <p>The format of the analysis template in the collaboration.</p>
|
|
901
1013
|
*/
|
|
902
1014
|
format: AnalysisFormat | string | undefined;
|
|
903
1015
|
/**
|
|
1016
|
+
* @public
|
|
904
1017
|
* <p>The source of the analysis template within a collaboration.</p>
|
|
905
1018
|
*/
|
|
906
1019
|
source: AnalysisSource | undefined;
|
|
907
1020
|
/**
|
|
1021
|
+
* @public
|
|
908
1022
|
* <p>The analysis parameters that have been specified in the analysis template.</p>
|
|
909
1023
|
*/
|
|
910
1024
|
analysisParameters?: AnalysisParameter[];
|
|
@@ -915,14 +1029,17 @@ export interface CollaborationAnalysisTemplate {
|
|
|
915
1029
|
*/
|
|
916
1030
|
export interface BatchGetCollaborationAnalysisTemplateError {
|
|
917
1031
|
/**
|
|
1032
|
+
* @public
|
|
918
1033
|
* <p>The Amazon Resource Name (ARN) of the analysis template.</p>
|
|
919
1034
|
*/
|
|
920
1035
|
arn: string | undefined;
|
|
921
1036
|
/**
|
|
1037
|
+
* @public
|
|
922
1038
|
* <p>An error code for the error.</p>
|
|
923
1039
|
*/
|
|
924
1040
|
code: string | undefined;
|
|
925
1041
|
/**
|
|
1042
|
+
* @public
|
|
926
1043
|
* <p>A description of why the call failed.</p>
|
|
927
1044
|
*/
|
|
928
1045
|
message: string | undefined;
|
|
@@ -932,10 +1049,12 @@ export interface BatchGetCollaborationAnalysisTemplateError {
|
|
|
932
1049
|
*/
|
|
933
1050
|
export interface BatchGetCollaborationAnalysisTemplateOutput {
|
|
934
1051
|
/**
|
|
1052
|
+
* @public
|
|
935
1053
|
* <p>The retrieved list of analysis templates within a collaboration.</p>
|
|
936
1054
|
*/
|
|
937
1055
|
collaborationAnalysisTemplates: CollaborationAnalysisTemplate[] | undefined;
|
|
938
1056
|
/**
|
|
1057
|
+
* @public
|
|
939
1058
|
* <p>Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.</p>
|
|
940
1059
|
*/
|
|
941
1060
|
errors: BatchGetCollaborationAnalysisTemplateError[] | undefined;
|
|
@@ -945,11 +1064,13 @@ export interface BatchGetCollaborationAnalysisTemplateOutput {
|
|
|
945
1064
|
*/
|
|
946
1065
|
export interface BatchGetSchemaInput {
|
|
947
1066
|
/**
|
|
1067
|
+
* @public
|
|
948
1068
|
* <p>A unique identifier for the collaboration that the schemas belong to. Currently accepts
|
|
949
1069
|
* collaboration ID.</p>
|
|
950
1070
|
*/
|
|
951
1071
|
collaborationIdentifier: string | undefined;
|
|
952
1072
|
/**
|
|
1073
|
+
* @public
|
|
953
1074
|
* <p>The names for the schema objects to retrieve.></p>
|
|
954
1075
|
*/
|
|
955
1076
|
names: string[] | undefined;
|
|
@@ -960,14 +1081,17 @@ export interface BatchGetSchemaInput {
|
|
|
960
1081
|
*/
|
|
961
1082
|
export interface BatchGetSchemaError {
|
|
962
1083
|
/**
|
|
1084
|
+
* @public
|
|
963
1085
|
* <p>An error name for the error.</p>
|
|
964
1086
|
*/
|
|
965
1087
|
name: string | undefined;
|
|
966
1088
|
/**
|
|
1089
|
+
* @public
|
|
967
1090
|
* <p>An error code for the error. </p>
|
|
968
1091
|
*/
|
|
969
1092
|
code: string | undefined;
|
|
970
1093
|
/**
|
|
1094
|
+
* @public
|
|
971
1095
|
* <p>An error message for the error.</p>
|
|
972
1096
|
*/
|
|
973
1097
|
message: string | undefined;
|
|
@@ -978,10 +1102,12 @@ export interface BatchGetSchemaError {
|
|
|
978
1102
|
*/
|
|
979
1103
|
export interface Column {
|
|
980
1104
|
/**
|
|
1105
|
+
* @public
|
|
981
1106
|
* <p>The name of the column.</p>
|
|
982
1107
|
*/
|
|
983
1108
|
name: string | undefined;
|
|
984
1109
|
/**
|
|
1110
|
+
* @public
|
|
985
1111
|
* <p>The type of the column.</p>
|
|
986
1112
|
*/
|
|
987
1113
|
type: string | undefined;
|
|
@@ -1003,51 +1129,63 @@ export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
|
|
|
1003
1129
|
*/
|
|
1004
1130
|
export interface Schema {
|
|
1005
1131
|
/**
|
|
1132
|
+
* @public
|
|
1006
1133
|
* <p>The columns for the relation this schema represents.</p>
|
|
1007
1134
|
*/
|
|
1008
1135
|
columns: Column[] | undefined;
|
|
1009
1136
|
/**
|
|
1137
|
+
* @public
|
|
1010
1138
|
* <p>The partition keys for the dataset underlying this schema.</p>
|
|
1011
1139
|
*/
|
|
1012
1140
|
partitionKeys: Column[] | undefined;
|
|
1013
1141
|
/**
|
|
1142
|
+
* @public
|
|
1014
1143
|
* <p>The analysis rule types associated with the schema. Currently, only one entry is present.</p>
|
|
1015
1144
|
*/
|
|
1016
1145
|
analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
|
|
1017
1146
|
/**
|
|
1147
|
+
* @public
|
|
1018
1148
|
* <p>The analysis method for the schema. The only valid value is currently
|
|
1019
1149
|
* DIRECT_QUERY.</p>
|
|
1020
1150
|
*/
|
|
1021
1151
|
analysisMethod?: AnalysisMethod | string;
|
|
1022
1152
|
/**
|
|
1153
|
+
* @public
|
|
1023
1154
|
* <p>The unique account ID for the Amazon Web Services account that owns the schema.</p>
|
|
1024
1155
|
*/
|
|
1025
1156
|
creatorAccountId: string | undefined;
|
|
1026
1157
|
/**
|
|
1158
|
+
* @public
|
|
1027
1159
|
* <p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>
|
|
1028
1160
|
*/
|
|
1029
1161
|
name: string | undefined;
|
|
1030
1162
|
/**
|
|
1163
|
+
* @public
|
|
1031
1164
|
* <p>The unique ID for the collaboration that the schema belongs to.</p>
|
|
1032
1165
|
*/
|
|
1033
1166
|
collaborationId: string | undefined;
|
|
1034
1167
|
/**
|
|
1168
|
+
* @public
|
|
1035
1169
|
* <p>The unique ARN for the collaboration that the schema belongs to.</p>
|
|
1036
1170
|
*/
|
|
1037
1171
|
collaborationArn: string | undefined;
|
|
1038
1172
|
/**
|
|
1173
|
+
* @public
|
|
1039
1174
|
* <p>A description for the schema.</p>
|
|
1040
1175
|
*/
|
|
1041
1176
|
description: string | undefined;
|
|
1042
1177
|
/**
|
|
1178
|
+
* @public
|
|
1043
1179
|
* <p>The time the schema was created.</p>
|
|
1044
1180
|
*/
|
|
1045
1181
|
createTime: Date | undefined;
|
|
1046
1182
|
/**
|
|
1183
|
+
* @public
|
|
1047
1184
|
* <p>The time the schema was last updated.</p>
|
|
1048
1185
|
*/
|
|
1049
1186
|
updateTime: Date | undefined;
|
|
1050
1187
|
/**
|
|
1188
|
+
* @public
|
|
1051
1189
|
* <p>The type of schema. The only valid value is currently `TABLE`.</p>
|
|
1052
1190
|
*/
|
|
1053
1191
|
type: SchemaType | string | undefined;
|
|
@@ -1057,10 +1195,12 @@ export interface Schema {
|
|
|
1057
1195
|
*/
|
|
1058
1196
|
export interface BatchGetSchemaOutput {
|
|
1059
1197
|
/**
|
|
1198
|
+
* @public
|
|
1060
1199
|
* <p>The retrieved list of schemas.</p>
|
|
1061
1200
|
*/
|
|
1062
1201
|
schemas: Schema[] | undefined;
|
|
1063
1202
|
/**
|
|
1203
|
+
* @public
|
|
1064
1204
|
* <p>Error reasons for schemas that could not be retrieved. One error is returned for every
|
|
1065
1205
|
* schema that could not be retrieved.</p>
|
|
1066
1206
|
*/
|
|
@@ -1084,18 +1224,22 @@ export type MemberAbility = (typeof MemberAbility)[keyof typeof MemberAbility];
|
|
|
1084
1224
|
*/
|
|
1085
1225
|
export interface DataEncryptionMetadata {
|
|
1086
1226
|
/**
|
|
1227
|
+
* @public
|
|
1087
1228
|
* <p>Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).</p>
|
|
1088
1229
|
*/
|
|
1089
1230
|
allowCleartext: boolean | undefined;
|
|
1090
1231
|
/**
|
|
1232
|
+
* @public
|
|
1091
1233
|
* <p>Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).</p>
|
|
1092
1234
|
*/
|
|
1093
1235
|
allowDuplicates: boolean | undefined;
|
|
1094
1236
|
/**
|
|
1237
|
+
* @public
|
|
1095
1238
|
* <p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).</p>
|
|
1096
1239
|
*/
|
|
1097
1240
|
allowJoinsOnColumnsWithDifferentNames: boolean | undefined;
|
|
1098
1241
|
/**
|
|
1242
|
+
* @public
|
|
1099
1243
|
* <p>Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).</p>
|
|
1100
1244
|
*/
|
|
1101
1245
|
preserveNulls: boolean | undefined;
|
|
@@ -1106,14 +1250,17 @@ export interface DataEncryptionMetadata {
|
|
|
1106
1250
|
*/
|
|
1107
1251
|
export interface MemberSpecification {
|
|
1108
1252
|
/**
|
|
1253
|
+
* @public
|
|
1109
1254
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1110
1255
|
*/
|
|
1111
1256
|
accountId: string | undefined;
|
|
1112
1257
|
/**
|
|
1258
|
+
* @public
|
|
1113
1259
|
* <p>The abilities granted to the collaboration member.</p>
|
|
1114
1260
|
*/
|
|
1115
1261
|
memberAbilities: (MemberAbility | string)[] | undefined;
|
|
1116
1262
|
/**
|
|
1263
|
+
* @public
|
|
1117
1264
|
* <p>The member's display name.</p>
|
|
1118
1265
|
*/
|
|
1119
1266
|
displayName: string | undefined;
|
|
@@ -1135,35 +1282,43 @@ export type CollaborationQueryLogStatus = (typeof CollaborationQueryLogStatus)[k
|
|
|
1135
1282
|
*/
|
|
1136
1283
|
export interface CreateCollaborationInput {
|
|
1137
1284
|
/**
|
|
1285
|
+
* @public
|
|
1138
1286
|
* <p>A list of initial members, not including the creator. This list is immutable.</p>
|
|
1139
1287
|
*/
|
|
1140
1288
|
members: MemberSpecification[] | undefined;
|
|
1141
1289
|
/**
|
|
1290
|
+
* @public
|
|
1142
1291
|
* <p>The display name for a collaboration.</p>
|
|
1143
1292
|
*/
|
|
1144
1293
|
name: string | undefined;
|
|
1145
1294
|
/**
|
|
1295
|
+
* @public
|
|
1146
1296
|
* <p>A description of the collaboration provided by the collaboration owner.</p>
|
|
1147
1297
|
*/
|
|
1148
1298
|
description: string | undefined;
|
|
1149
1299
|
/**
|
|
1300
|
+
* @public
|
|
1150
1301
|
* <p>The abilities granted to the collaboration creator.</p>
|
|
1151
1302
|
*/
|
|
1152
1303
|
creatorMemberAbilities: (MemberAbility | string)[] | undefined;
|
|
1153
1304
|
/**
|
|
1305
|
+
* @public
|
|
1154
1306
|
* <p>The display name of the collaboration creator.</p>
|
|
1155
1307
|
*/
|
|
1156
1308
|
creatorDisplayName: string | undefined;
|
|
1157
1309
|
/**
|
|
1310
|
+
* @public
|
|
1158
1311
|
* <p>The settings for client-side encryption with Cryptographic Computing for Clean Rooms.</p>
|
|
1159
1312
|
*/
|
|
1160
1313
|
dataEncryptionMetadata?: DataEncryptionMetadata;
|
|
1161
1314
|
/**
|
|
1315
|
+
* @public
|
|
1162
1316
|
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
1163
1317
|
* collaboration.</p>
|
|
1164
1318
|
*/
|
|
1165
1319
|
queryLogStatus: CollaborationQueryLogStatus | string | undefined;
|
|
1166
1320
|
/**
|
|
1321
|
+
* @public
|
|
1167
1322
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
1168
1323
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
1169
1324
|
* you can also use tag-based access control in IAM policies to control access to this
|
|
@@ -1191,54 +1346,67 @@ export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
|
|
|
1191
1346
|
*/
|
|
1192
1347
|
export interface Collaboration {
|
|
1193
1348
|
/**
|
|
1349
|
+
* @public
|
|
1194
1350
|
* <p>The unique ID for the collaboration.</p>
|
|
1195
1351
|
*/
|
|
1196
1352
|
id: string | undefined;
|
|
1197
1353
|
/**
|
|
1354
|
+
* @public
|
|
1198
1355
|
* <p>The unique ARN for the collaboration.</p>
|
|
1199
1356
|
*/
|
|
1200
1357
|
arn: string | undefined;
|
|
1201
1358
|
/**
|
|
1359
|
+
* @public
|
|
1202
1360
|
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
1203
1361
|
*/
|
|
1204
1362
|
name: string | undefined;
|
|
1205
1363
|
/**
|
|
1364
|
+
* @public
|
|
1206
1365
|
* <p>A description of the collaboration provided by the collaboration owner.</p>
|
|
1207
1366
|
*/
|
|
1208
1367
|
description?: string;
|
|
1209
1368
|
/**
|
|
1369
|
+
* @public
|
|
1210
1370
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1211
1371
|
*/
|
|
1212
1372
|
creatorAccountId: string | undefined;
|
|
1213
1373
|
/**
|
|
1374
|
+
* @public
|
|
1214
1375
|
* <p>A display name of the collaboration creator.</p>
|
|
1215
1376
|
*/
|
|
1216
1377
|
creatorDisplayName: string | undefined;
|
|
1217
1378
|
/**
|
|
1379
|
+
* @public
|
|
1218
1380
|
* <p>The time when the collaboration was created.</p>
|
|
1219
1381
|
*/
|
|
1220
1382
|
createTime: Date | undefined;
|
|
1221
1383
|
/**
|
|
1384
|
+
* @public
|
|
1222
1385
|
* <p>The time the collaboration metadata was last updated.</p>
|
|
1223
1386
|
*/
|
|
1224
1387
|
updateTime: Date | undefined;
|
|
1225
1388
|
/**
|
|
1389
|
+
* @public
|
|
1226
1390
|
* <p>The status of a member in a collaboration.</p>
|
|
1227
1391
|
*/
|
|
1228
1392
|
memberStatus: MemberStatus | string | undefined;
|
|
1229
1393
|
/**
|
|
1394
|
+
* @public
|
|
1230
1395
|
* <p>The unique ID for your membership within the collaboration.</p>
|
|
1231
1396
|
*/
|
|
1232
1397
|
membershipId?: string;
|
|
1233
1398
|
/**
|
|
1399
|
+
* @public
|
|
1234
1400
|
* <p>The unique ARN for your membership within the collaboration.</p>
|
|
1235
1401
|
*/
|
|
1236
1402
|
membershipArn?: string;
|
|
1237
1403
|
/**
|
|
1404
|
+
* @public
|
|
1238
1405
|
* <p>The settings for client-side encryption for cryptographic computing.</p>
|
|
1239
1406
|
*/
|
|
1240
1407
|
dataEncryptionMetadata?: DataEncryptionMetadata;
|
|
1241
1408
|
/**
|
|
1409
|
+
* @public
|
|
1242
1410
|
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
1243
1411
|
* collaboration.</p>
|
|
1244
1412
|
*/
|
|
@@ -1249,6 +1417,7 @@ export interface Collaboration {
|
|
|
1249
1417
|
*/
|
|
1250
1418
|
export interface CreateCollaborationOutput {
|
|
1251
1419
|
/**
|
|
1420
|
+
* @public
|
|
1252
1421
|
* <p>The entire created collaboration object.</p>
|
|
1253
1422
|
*/
|
|
1254
1423
|
collaboration: Collaboration | undefined;
|
|
@@ -1258,6 +1427,7 @@ export interface CreateCollaborationOutput {
|
|
|
1258
1427
|
*/
|
|
1259
1428
|
export interface DeleteCollaborationInput {
|
|
1260
1429
|
/**
|
|
1430
|
+
* @public
|
|
1261
1431
|
* <p>The identifier for the collaboration.</p>
|
|
1262
1432
|
*/
|
|
1263
1433
|
collaborationIdentifier: string | undefined;
|
|
@@ -1272,10 +1442,12 @@ export interface DeleteCollaborationOutput {
|
|
|
1272
1442
|
*/
|
|
1273
1443
|
export interface DeleteMemberInput {
|
|
1274
1444
|
/**
|
|
1445
|
+
* @public
|
|
1275
1446
|
* <p>The unique identifier for the associated collaboration.</p>
|
|
1276
1447
|
*/
|
|
1277
1448
|
collaborationIdentifier: string | undefined;
|
|
1278
1449
|
/**
|
|
1450
|
+
* @public
|
|
1279
1451
|
* <p>The account ID of the member to remove.</p>
|
|
1280
1452
|
*/
|
|
1281
1453
|
accountId: string | undefined;
|
|
@@ -1290,6 +1462,7 @@ export interface DeleteMemberOutput {
|
|
|
1290
1462
|
*/
|
|
1291
1463
|
export interface GetCollaborationInput {
|
|
1292
1464
|
/**
|
|
1465
|
+
* @public
|
|
1293
1466
|
* <p>The identifier for the collaboration.</p>
|
|
1294
1467
|
*/
|
|
1295
1468
|
collaborationIdentifier: string | undefined;
|
|
@@ -1299,6 +1472,7 @@ export interface GetCollaborationInput {
|
|
|
1299
1472
|
*/
|
|
1300
1473
|
export interface GetCollaborationOutput {
|
|
1301
1474
|
/**
|
|
1475
|
+
* @public
|
|
1302
1476
|
* <p>The entire collaboration for this identifier.</p>
|
|
1303
1477
|
*/
|
|
1304
1478
|
collaboration: Collaboration | undefined;
|
|
@@ -1308,10 +1482,12 @@ export interface GetCollaborationOutput {
|
|
|
1308
1482
|
*/
|
|
1309
1483
|
export interface GetCollaborationAnalysisTemplateInput {
|
|
1310
1484
|
/**
|
|
1485
|
+
* @public
|
|
1311
1486
|
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
1312
1487
|
*/
|
|
1313
1488
|
collaborationIdentifier: string | undefined;
|
|
1314
1489
|
/**
|
|
1490
|
+
* @public
|
|
1315
1491
|
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
|
|
1316
1492
|
*/
|
|
1317
1493
|
analysisTemplateArn: string | undefined;
|
|
@@ -1321,6 +1497,7 @@ export interface GetCollaborationAnalysisTemplateInput {
|
|
|
1321
1497
|
*/
|
|
1322
1498
|
export interface GetCollaborationAnalysisTemplateOutput {
|
|
1323
1499
|
/**
|
|
1500
|
+
* @public
|
|
1324
1501
|
* <p>The analysis template within a collaboration.</p>
|
|
1325
1502
|
*/
|
|
1326
1503
|
collaborationAnalysisTemplate: CollaborationAnalysisTemplate | undefined;
|
|
@@ -1330,11 +1507,13 @@ export interface GetCollaborationAnalysisTemplateOutput {
|
|
|
1330
1507
|
*/
|
|
1331
1508
|
export interface GetSchemaInput {
|
|
1332
1509
|
/**
|
|
1510
|
+
* @public
|
|
1333
1511
|
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
1334
1512
|
* a collaboration ID.</p>
|
|
1335
1513
|
*/
|
|
1336
1514
|
collaborationIdentifier: string | undefined;
|
|
1337
1515
|
/**
|
|
1516
|
+
* @public
|
|
1338
1517
|
* <p>The name of the relation to retrieve the schema for.</p>
|
|
1339
1518
|
*/
|
|
1340
1519
|
name: string | undefined;
|
|
@@ -1344,6 +1523,7 @@ export interface GetSchemaInput {
|
|
|
1344
1523
|
*/
|
|
1345
1524
|
export interface GetSchemaOutput {
|
|
1346
1525
|
/**
|
|
1526
|
+
* @public
|
|
1347
1527
|
* <p>The entire schema object.</p>
|
|
1348
1528
|
*/
|
|
1349
1529
|
schema: Schema | undefined;
|
|
@@ -1353,15 +1533,18 @@ export interface GetSchemaOutput {
|
|
|
1353
1533
|
*/
|
|
1354
1534
|
export interface GetSchemaAnalysisRuleInput {
|
|
1355
1535
|
/**
|
|
1536
|
+
* @public
|
|
1356
1537
|
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
1357
1538
|
* a collaboration ID.</p>
|
|
1358
1539
|
*/
|
|
1359
1540
|
collaborationIdentifier: string | undefined;
|
|
1360
1541
|
/**
|
|
1542
|
+
* @public
|
|
1361
1543
|
* <p>The name of the schema to retrieve the analysis rule for.</p>
|
|
1362
1544
|
*/
|
|
1363
1545
|
name: string | undefined;
|
|
1364
1546
|
/**
|
|
1547
|
+
* @public
|
|
1365
1548
|
* <p>The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.</p>
|
|
1366
1549
|
*/
|
|
1367
1550
|
type: AnalysisRuleType | string | undefined;
|
|
@@ -1371,6 +1554,7 @@ export interface GetSchemaAnalysisRuleInput {
|
|
|
1371
1554
|
*/
|
|
1372
1555
|
export interface GetSchemaAnalysisRuleOutput {
|
|
1373
1556
|
/**
|
|
1557
|
+
* @public
|
|
1374
1558
|
* <p>A specification about how data from the configured table can be used.</p>
|
|
1375
1559
|
*/
|
|
1376
1560
|
analysisRule: AnalysisRule | undefined;
|
|
@@ -1380,14 +1564,17 @@ export interface GetSchemaAnalysisRuleOutput {
|
|
|
1380
1564
|
*/
|
|
1381
1565
|
export interface ListCollaborationAnalysisTemplatesInput {
|
|
1382
1566
|
/**
|
|
1567
|
+
* @public
|
|
1383
1568
|
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
1384
1569
|
*/
|
|
1385
1570
|
collaborationIdentifier: string | undefined;
|
|
1386
1571
|
/**
|
|
1572
|
+
* @public
|
|
1387
1573
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1388
1574
|
*/
|
|
1389
1575
|
nextToken?: string;
|
|
1390
1576
|
/**
|
|
1577
|
+
* @public
|
|
1391
1578
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
1392
1579
|
*/
|
|
1393
1580
|
maxResults?: number;
|
|
@@ -1398,38 +1585,47 @@ export interface ListCollaborationAnalysisTemplatesInput {
|
|
|
1398
1585
|
*/
|
|
1399
1586
|
export interface CollaborationAnalysisTemplateSummary {
|
|
1400
1587
|
/**
|
|
1588
|
+
* @public
|
|
1401
1589
|
* <p>The Amazon Resource Name (ARN) of the analysis template.</p>
|
|
1402
1590
|
*/
|
|
1403
1591
|
arn: string | undefined;
|
|
1404
1592
|
/**
|
|
1593
|
+
* @public
|
|
1405
1594
|
* <p>The time that the summary of the analysis template in a collaboration was created.</p>
|
|
1406
1595
|
*/
|
|
1407
1596
|
createTime: Date | undefined;
|
|
1408
1597
|
/**
|
|
1598
|
+
* @public
|
|
1409
1599
|
* <p>The identifier of the analysis template.</p>
|
|
1410
1600
|
*/
|
|
1411
1601
|
id: string | undefined;
|
|
1412
1602
|
/**
|
|
1603
|
+
* @public
|
|
1413
1604
|
* <p>The name of the analysis template.</p>
|
|
1414
1605
|
*/
|
|
1415
1606
|
name: string | undefined;
|
|
1416
1607
|
/**
|
|
1608
|
+
* @public
|
|
1417
1609
|
* <p>The time that the summary of the analysis template in the collaboration was last updated.</p>
|
|
1418
1610
|
*/
|
|
1419
1611
|
updateTime: Date | undefined;
|
|
1420
1612
|
/**
|
|
1613
|
+
* @public
|
|
1421
1614
|
* <p>The unique ARN for the analysis template’s associated collaboration.</p>
|
|
1422
1615
|
*/
|
|
1423
1616
|
collaborationArn: string | undefined;
|
|
1424
1617
|
/**
|
|
1618
|
+
* @public
|
|
1425
1619
|
* <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
|
|
1426
1620
|
*/
|
|
1427
1621
|
collaborationId: string | undefined;
|
|
1428
1622
|
/**
|
|
1623
|
+
* @public
|
|
1429
1624
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1430
1625
|
*/
|
|
1431
1626
|
creatorAccountId: string | undefined;
|
|
1432
1627
|
/**
|
|
1628
|
+
* @public
|
|
1433
1629
|
* <p>The description of the analysis template.</p>
|
|
1434
1630
|
*/
|
|
1435
1631
|
description?: string;
|
|
@@ -1439,10 +1635,12 @@ export interface CollaborationAnalysisTemplateSummary {
|
|
|
1439
1635
|
*/
|
|
1440
1636
|
export interface ListCollaborationAnalysisTemplatesOutput {
|
|
1441
1637
|
/**
|
|
1638
|
+
* @public
|
|
1442
1639
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1443
1640
|
*/
|
|
1444
1641
|
nextToken?: string;
|
|
1445
1642
|
/**
|
|
1643
|
+
* @public
|
|
1446
1644
|
* <p>The metadata of the analysis template within a collaboration.</p>
|
|
1447
1645
|
*/
|
|
1448
1646
|
collaborationAnalysisTemplateSummaries: CollaborationAnalysisTemplateSummary[] | undefined;
|
|
@@ -1464,16 +1662,19 @@ export type FilterableMemberStatus = (typeof FilterableMemberStatus)[keyof typeo
|
|
|
1464
1662
|
*/
|
|
1465
1663
|
export interface ListCollaborationsInput {
|
|
1466
1664
|
/**
|
|
1665
|
+
* @public
|
|
1467
1666
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1468
1667
|
*/
|
|
1469
1668
|
nextToken?: string;
|
|
1470
1669
|
/**
|
|
1670
|
+
* @public
|
|
1471
1671
|
* <p>The maximum size of the results that is returned per call. Service chooses a default if
|
|
1472
1672
|
* it has not been set. Service may return a nextToken even if the maximum results has not
|
|
1473
1673
|
* been met.</p>
|
|
1474
1674
|
*/
|
|
1475
1675
|
maxResults?: number;
|
|
1476
1676
|
/**
|
|
1677
|
+
* @public
|
|
1477
1678
|
* <p>The caller's status in a collaboration.</p>
|
|
1478
1679
|
*/
|
|
1479
1680
|
memberStatus?: FilterableMemberStatus | string;
|
|
@@ -1484,42 +1685,52 @@ export interface ListCollaborationsInput {
|
|
|
1484
1685
|
*/
|
|
1485
1686
|
export interface CollaborationSummary {
|
|
1486
1687
|
/**
|
|
1688
|
+
* @public
|
|
1487
1689
|
* <p>The identifier for the collaboration.</p>
|
|
1488
1690
|
*/
|
|
1489
1691
|
id: string | undefined;
|
|
1490
1692
|
/**
|
|
1693
|
+
* @public
|
|
1491
1694
|
* <p>The ARN of the collaboration.</p>
|
|
1492
1695
|
*/
|
|
1493
1696
|
arn: string | undefined;
|
|
1494
1697
|
/**
|
|
1698
|
+
* @public
|
|
1495
1699
|
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
1496
1700
|
*/
|
|
1497
1701
|
name: string | undefined;
|
|
1498
1702
|
/**
|
|
1703
|
+
* @public
|
|
1499
1704
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1500
1705
|
*/
|
|
1501
1706
|
creatorAccountId: string | undefined;
|
|
1502
1707
|
/**
|
|
1708
|
+
* @public
|
|
1503
1709
|
* <p>The display name of the collaboration creator.</p>
|
|
1504
1710
|
*/
|
|
1505
1711
|
creatorDisplayName: string | undefined;
|
|
1506
1712
|
/**
|
|
1713
|
+
* @public
|
|
1507
1714
|
* <p>The time when the collaboration was created.</p>
|
|
1508
1715
|
*/
|
|
1509
1716
|
createTime: Date | undefined;
|
|
1510
1717
|
/**
|
|
1718
|
+
* @public
|
|
1511
1719
|
* <p>The time the collaboration metadata was last updated.</p>
|
|
1512
1720
|
*/
|
|
1513
1721
|
updateTime: Date | undefined;
|
|
1514
1722
|
/**
|
|
1723
|
+
* @public
|
|
1515
1724
|
* <p>The status of a member in a collaboration.</p>
|
|
1516
1725
|
*/
|
|
1517
1726
|
memberStatus: MemberStatus | string | undefined;
|
|
1518
1727
|
/**
|
|
1728
|
+
* @public
|
|
1519
1729
|
* <p>The identifier of a member in a collaboration.</p>
|
|
1520
1730
|
*/
|
|
1521
1731
|
membershipId?: string;
|
|
1522
1732
|
/**
|
|
1733
|
+
* @public
|
|
1523
1734
|
* <p>The ARN of a member in a collaboration.</p>
|
|
1524
1735
|
*/
|
|
1525
1736
|
membershipArn?: string;
|
|
@@ -1529,10 +1740,12 @@ export interface CollaborationSummary {
|
|
|
1529
1740
|
*/
|
|
1530
1741
|
export interface ListCollaborationsOutput {
|
|
1531
1742
|
/**
|
|
1743
|
+
* @public
|
|
1532
1744
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1533
1745
|
*/
|
|
1534
1746
|
nextToken?: string;
|
|
1535
1747
|
/**
|
|
1748
|
+
* @public
|
|
1536
1749
|
* <p>The list of collaborations.</p>
|
|
1537
1750
|
*/
|
|
1538
1751
|
collaborationList: CollaborationSummary[] | undefined;
|
|
@@ -1542,14 +1755,17 @@ export interface ListCollaborationsOutput {
|
|
|
1542
1755
|
*/
|
|
1543
1756
|
export interface ListMembersInput {
|
|
1544
1757
|
/**
|
|
1758
|
+
* @public
|
|
1545
1759
|
* <p>The identifier of the collaboration in which the members are listed.</p>
|
|
1546
1760
|
*/
|
|
1547
1761
|
collaborationIdentifier: string | undefined;
|
|
1548
1762
|
/**
|
|
1763
|
+
* @public
|
|
1549
1764
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1550
1765
|
*/
|
|
1551
1766
|
nextToken?: string;
|
|
1552
1767
|
/**
|
|
1768
|
+
* @public
|
|
1553
1769
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
1554
1770
|
*/
|
|
1555
1771
|
maxResults?: number;
|
|
@@ -1560,34 +1776,42 @@ export interface ListMembersInput {
|
|
|
1560
1776
|
*/
|
|
1561
1777
|
export interface MemberSummary {
|
|
1562
1778
|
/**
|
|
1779
|
+
* @public
|
|
1563
1780
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
1564
1781
|
*/
|
|
1565
1782
|
accountId: string | undefined;
|
|
1566
1783
|
/**
|
|
1784
|
+
* @public
|
|
1567
1785
|
* <p>The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.</p>
|
|
1568
1786
|
*/
|
|
1569
1787
|
status: MemberStatus | string | undefined;
|
|
1570
1788
|
/**
|
|
1789
|
+
* @public
|
|
1571
1790
|
* <p>The member's display name.</p>
|
|
1572
1791
|
*/
|
|
1573
1792
|
displayName: string | undefined;
|
|
1574
1793
|
/**
|
|
1794
|
+
* @public
|
|
1575
1795
|
* <p>The abilities granted to the collaboration member.</p>
|
|
1576
1796
|
*/
|
|
1577
1797
|
abilities: (MemberAbility | string)[] | undefined;
|
|
1578
1798
|
/**
|
|
1799
|
+
* @public
|
|
1579
1800
|
* <p>The time when the member was created.</p>
|
|
1580
1801
|
*/
|
|
1581
1802
|
createTime: Date | undefined;
|
|
1582
1803
|
/**
|
|
1804
|
+
* @public
|
|
1583
1805
|
* <p>The time the member metadata was last updated.</p>
|
|
1584
1806
|
*/
|
|
1585
1807
|
updateTime: Date | undefined;
|
|
1586
1808
|
/**
|
|
1809
|
+
* @public
|
|
1587
1810
|
* <p>The unique ID for the member's associated membership, if present.</p>
|
|
1588
1811
|
*/
|
|
1589
1812
|
membershipId?: string;
|
|
1590
1813
|
/**
|
|
1814
|
+
* @public
|
|
1591
1815
|
* <p>The unique ARN for the member's associated membership, if present.</p>
|
|
1592
1816
|
*/
|
|
1593
1817
|
membershipArn?: string;
|
|
@@ -1597,10 +1821,12 @@ export interface MemberSummary {
|
|
|
1597
1821
|
*/
|
|
1598
1822
|
export interface ListMembersOutput {
|
|
1599
1823
|
/**
|
|
1824
|
+
* @public
|
|
1600
1825
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1601
1826
|
*/
|
|
1602
1827
|
nextToken?: string;
|
|
1603
1828
|
/**
|
|
1829
|
+
* @public
|
|
1604
1830
|
* <p>The list of members returned by the ListMembers operation.</p>
|
|
1605
1831
|
*/
|
|
1606
1832
|
memberSummaries: MemberSummary[] | undefined;
|
|
@@ -1610,19 +1836,23 @@ export interface ListMembersOutput {
|
|
|
1610
1836
|
*/
|
|
1611
1837
|
export interface ListSchemasInput {
|
|
1612
1838
|
/**
|
|
1839
|
+
* @public
|
|
1613
1840
|
* <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts
|
|
1614
1841
|
* a collaboration ID.</p>
|
|
1615
1842
|
*/
|
|
1616
1843
|
collaborationIdentifier: string | undefined;
|
|
1617
1844
|
/**
|
|
1845
|
+
* @public
|
|
1618
1846
|
* <p>If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.</p>
|
|
1619
1847
|
*/
|
|
1620
1848
|
schemaType?: SchemaType | string;
|
|
1621
1849
|
/**
|
|
1850
|
+
* @public
|
|
1622
1851
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1623
1852
|
*/
|
|
1624
1853
|
nextToken?: string;
|
|
1625
1854
|
/**
|
|
1855
|
+
* @public
|
|
1626
1856
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
1627
1857
|
*/
|
|
1628
1858
|
maxResults?: number;
|
|
@@ -1633,38 +1863,47 @@ export interface ListSchemasInput {
|
|
|
1633
1863
|
*/
|
|
1634
1864
|
export interface SchemaSummary {
|
|
1635
1865
|
/**
|
|
1866
|
+
* @public
|
|
1636
1867
|
* <p>The name for the schema object.</p>
|
|
1637
1868
|
*/
|
|
1638
1869
|
name: string | undefined;
|
|
1639
1870
|
/**
|
|
1871
|
+
* @public
|
|
1640
1872
|
* <p>The type of schema object. The only valid schema type is currently `TABLE`.</p>
|
|
1641
1873
|
*/
|
|
1642
1874
|
type: SchemaType | string | undefined;
|
|
1643
1875
|
/**
|
|
1876
|
+
* @public
|
|
1644
1877
|
* <p>The unique account ID for the Amazon Web Services account that owns the schema.</p>
|
|
1645
1878
|
*/
|
|
1646
1879
|
creatorAccountId: string | undefined;
|
|
1647
1880
|
/**
|
|
1881
|
+
* @public
|
|
1648
1882
|
* <p>The time the schema object was created.</p>
|
|
1649
1883
|
*/
|
|
1650
1884
|
createTime: Date | undefined;
|
|
1651
1885
|
/**
|
|
1886
|
+
* @public
|
|
1652
1887
|
* <p>The time the schema object was last updated.</p>
|
|
1653
1888
|
*/
|
|
1654
1889
|
updateTime: Date | undefined;
|
|
1655
1890
|
/**
|
|
1891
|
+
* @public
|
|
1656
1892
|
* <p>The unique ID for the collaboration that the schema belongs to.</p>
|
|
1657
1893
|
*/
|
|
1658
1894
|
collaborationId: string | undefined;
|
|
1659
1895
|
/**
|
|
1896
|
+
* @public
|
|
1660
1897
|
* <p>The unique ARN for the collaboration that the schema belongs to.</p>
|
|
1661
1898
|
*/
|
|
1662
1899
|
collaborationArn: string | undefined;
|
|
1663
1900
|
/**
|
|
1901
|
+
* @public
|
|
1664
1902
|
* <p>The types of analysis rules that are associated with this schema object.</p>
|
|
1665
1903
|
*/
|
|
1666
1904
|
analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
|
|
1667
1905
|
/**
|
|
1906
|
+
* @public
|
|
1668
1907
|
* <p>The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.</p>
|
|
1669
1908
|
*/
|
|
1670
1909
|
analysisMethod?: AnalysisMethod | string;
|
|
@@ -1674,10 +1913,12 @@ export interface SchemaSummary {
|
|
|
1674
1913
|
*/
|
|
1675
1914
|
export interface ListSchemasOutput {
|
|
1676
1915
|
/**
|
|
1916
|
+
* @public
|
|
1677
1917
|
* <p>The retrieved list of schemas.</p>
|
|
1678
1918
|
*/
|
|
1679
1919
|
schemaSummaries: SchemaSummary[] | undefined;
|
|
1680
1920
|
/**
|
|
1921
|
+
* @public
|
|
1681
1922
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1682
1923
|
*/
|
|
1683
1924
|
nextToken?: string;
|
|
@@ -1687,14 +1928,17 @@ export interface ListSchemasOutput {
|
|
|
1687
1928
|
*/
|
|
1688
1929
|
export interface UpdateCollaborationInput {
|
|
1689
1930
|
/**
|
|
1931
|
+
* @public
|
|
1690
1932
|
* <p>The identifier for the collaboration.</p>
|
|
1691
1933
|
*/
|
|
1692
1934
|
collaborationIdentifier: string | undefined;
|
|
1693
1935
|
/**
|
|
1936
|
+
* @public
|
|
1694
1937
|
* <p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>
|
|
1695
1938
|
*/
|
|
1696
1939
|
name?: string;
|
|
1697
1940
|
/**
|
|
1941
|
+
* @public
|
|
1698
1942
|
* <p>A description of the collaboration.</p>
|
|
1699
1943
|
*/
|
|
1700
1944
|
description?: string;
|
|
@@ -1704,6 +1948,7 @@ export interface UpdateCollaborationInput {
|
|
|
1704
1948
|
*/
|
|
1705
1949
|
export interface UpdateCollaborationOutput {
|
|
1706
1950
|
/**
|
|
1951
|
+
* @public
|
|
1707
1952
|
* <p>The entire collaboration that has been updated.</p>
|
|
1708
1953
|
*/
|
|
1709
1954
|
collaboration: Collaboration | undefined;
|
|
@@ -1713,30 +1958,36 @@ export interface UpdateCollaborationOutput {
|
|
|
1713
1958
|
*/
|
|
1714
1959
|
export interface CreateConfiguredTableAssociationInput {
|
|
1715
1960
|
/**
|
|
1961
|
+
* @public
|
|
1716
1962
|
* <p>The name of the configured table association. This name is used to query the underlying
|
|
1717
1963
|
* configured table.</p>
|
|
1718
1964
|
*/
|
|
1719
1965
|
name: string | undefined;
|
|
1720
1966
|
/**
|
|
1967
|
+
* @public
|
|
1721
1968
|
* <p>A description for the configured table association.</p>
|
|
1722
1969
|
*/
|
|
1723
1970
|
description?: string;
|
|
1724
1971
|
/**
|
|
1972
|
+
* @public
|
|
1725
1973
|
* <p>A unique identifier for one of your memberships for a collaboration. The configured
|
|
1726
1974
|
* table is associated to the collaboration that this membership belongs to. Currently accepts
|
|
1727
1975
|
* a membership ID.</p>
|
|
1728
1976
|
*/
|
|
1729
1977
|
membershipIdentifier: string | undefined;
|
|
1730
1978
|
/**
|
|
1979
|
+
* @public
|
|
1731
1980
|
* <p>A unique identifier for the configured table to be associated to. Currently accepts a
|
|
1732
1981
|
* configured table ID.</p>
|
|
1733
1982
|
*/
|
|
1734
1983
|
configuredTableIdentifier: string | undefined;
|
|
1735
1984
|
/**
|
|
1985
|
+
* @public
|
|
1736
1986
|
* <p>The service will assume this role to access catalog metadata and query the table.</p>
|
|
1737
1987
|
*/
|
|
1738
1988
|
roleArn: string | undefined;
|
|
1739
1989
|
/**
|
|
1990
|
+
* @public
|
|
1740
1991
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
1741
1992
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
1742
1993
|
* you can also use tag-based access control in IAM policies to control access to this
|
|
@@ -1750,46 +2001,57 @@ export interface CreateConfiguredTableAssociationInput {
|
|
|
1750
2001
|
*/
|
|
1751
2002
|
export interface ConfiguredTableAssociation {
|
|
1752
2003
|
/**
|
|
2004
|
+
* @public
|
|
1753
2005
|
* <p>The unique ARN for the configured table association.</p>
|
|
1754
2006
|
*/
|
|
1755
2007
|
arn: string | undefined;
|
|
1756
2008
|
/**
|
|
2009
|
+
* @public
|
|
1757
2010
|
* <p>The unique ID for the configured table association.</p>
|
|
1758
2011
|
*/
|
|
1759
2012
|
id: string | undefined;
|
|
1760
2013
|
/**
|
|
2014
|
+
* @public
|
|
1761
2015
|
* <p>The unique ID for the configured table that the association refers to.</p>
|
|
1762
2016
|
*/
|
|
1763
2017
|
configuredTableId: string | undefined;
|
|
1764
2018
|
/**
|
|
2019
|
+
* @public
|
|
1765
2020
|
* <p>The unique ARN for the configured table that the association refers to.</p>
|
|
1766
2021
|
*/
|
|
1767
2022
|
configuredTableArn: string | undefined;
|
|
1768
2023
|
/**
|
|
2024
|
+
* @public
|
|
1769
2025
|
* <p>The unique ID for the membership this configured table association belongs to.</p>
|
|
1770
2026
|
*/
|
|
1771
2027
|
membershipId: string | undefined;
|
|
1772
2028
|
/**
|
|
2029
|
+
* @public
|
|
1773
2030
|
* <p>The unique ARN for the membership this configured table association belongs to.</p>
|
|
1774
2031
|
*/
|
|
1775
2032
|
membershipArn: string | undefined;
|
|
1776
2033
|
/**
|
|
2034
|
+
* @public
|
|
1777
2035
|
* <p>The service will assume this role to access catalog metadata and query the table.</p>
|
|
1778
2036
|
*/
|
|
1779
2037
|
roleArn: string | undefined;
|
|
1780
2038
|
/**
|
|
2039
|
+
* @public
|
|
1781
2040
|
* <p>The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.</p>
|
|
1782
2041
|
*/
|
|
1783
2042
|
name: string | undefined;
|
|
1784
2043
|
/**
|
|
2044
|
+
* @public
|
|
1785
2045
|
* <p>A description of the configured table association.</p>
|
|
1786
2046
|
*/
|
|
1787
2047
|
description?: string;
|
|
1788
2048
|
/**
|
|
2049
|
+
* @public
|
|
1789
2050
|
* <p>The time the configured table association was created.</p>
|
|
1790
2051
|
*/
|
|
1791
2052
|
createTime: Date | undefined;
|
|
1792
2053
|
/**
|
|
2054
|
+
* @public
|
|
1793
2055
|
* <p>The time the configured table association was last updated.</p>
|
|
1794
2056
|
*/
|
|
1795
2057
|
updateTime: Date | undefined;
|
|
@@ -1799,6 +2061,7 @@ export interface ConfiguredTableAssociation {
|
|
|
1799
2061
|
*/
|
|
1800
2062
|
export interface CreateConfiguredTableAssociationOutput {
|
|
1801
2063
|
/**
|
|
2064
|
+
* @public
|
|
1802
2065
|
* <p>The entire configured table association object.</p>
|
|
1803
2066
|
*/
|
|
1804
2067
|
configuredTableAssociation: ConfiguredTableAssociation | undefined;
|
|
@@ -1808,10 +2071,12 @@ export interface CreateConfiguredTableAssociationOutput {
|
|
|
1808
2071
|
*/
|
|
1809
2072
|
export interface DeleteConfiguredTableAssociationInput {
|
|
1810
2073
|
/**
|
|
2074
|
+
* @public
|
|
1811
2075
|
* <p>The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.</p>
|
|
1812
2076
|
*/
|
|
1813
2077
|
configuredTableAssociationIdentifier: string | undefined;
|
|
1814
2078
|
/**
|
|
2079
|
+
* @public
|
|
1815
2080
|
* <p>A unique identifier for the membership that the configured table association belongs to.
|
|
1816
2081
|
* Currently accepts the membership ID.</p>
|
|
1817
2082
|
*/
|
|
@@ -1827,10 +2092,12 @@ export interface DeleteConfiguredTableAssociationOutput {
|
|
|
1827
2092
|
*/
|
|
1828
2093
|
export interface GetConfiguredTableAssociationInput {
|
|
1829
2094
|
/**
|
|
2095
|
+
* @public
|
|
1830
2096
|
* <p>The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.</p>
|
|
1831
2097
|
*/
|
|
1832
2098
|
configuredTableAssociationIdentifier: string | undefined;
|
|
1833
2099
|
/**
|
|
2100
|
+
* @public
|
|
1834
2101
|
* <p>A unique identifier for the membership that the configured table association belongs to.
|
|
1835
2102
|
* Currently accepts the membership ID.</p>
|
|
1836
2103
|
*/
|
|
@@ -1841,6 +2108,7 @@ export interface GetConfiguredTableAssociationInput {
|
|
|
1841
2108
|
*/
|
|
1842
2109
|
export interface GetConfiguredTableAssociationOutput {
|
|
1843
2110
|
/**
|
|
2111
|
+
* @public
|
|
1844
2112
|
* <p>The entire configured table association object.</p>
|
|
1845
2113
|
*/
|
|
1846
2114
|
configuredTableAssociation: ConfiguredTableAssociation | undefined;
|
|
@@ -1850,14 +2118,17 @@ export interface GetConfiguredTableAssociationOutput {
|
|
|
1850
2118
|
*/
|
|
1851
2119
|
export interface ListConfiguredTableAssociationsInput {
|
|
1852
2120
|
/**
|
|
2121
|
+
* @public
|
|
1853
2122
|
* <p>A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.</p>
|
|
1854
2123
|
*/
|
|
1855
2124
|
membershipIdentifier: string | undefined;
|
|
1856
2125
|
/**
|
|
2126
|
+
* @public
|
|
1857
2127
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1858
2128
|
*/
|
|
1859
2129
|
nextToken?: string;
|
|
1860
2130
|
/**
|
|
2131
|
+
* @public
|
|
1861
2132
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
1862
2133
|
*/
|
|
1863
2134
|
maxResults?: number;
|
|
@@ -1868,36 +2139,44 @@ export interface ListConfiguredTableAssociationsInput {
|
|
|
1868
2139
|
*/
|
|
1869
2140
|
export interface ConfiguredTableAssociationSummary {
|
|
1870
2141
|
/**
|
|
2142
|
+
* @public
|
|
1871
2143
|
* <p>The unique configured table ID that this configured table association refers to.</p>
|
|
1872
2144
|
*/
|
|
1873
2145
|
configuredTableId: string | undefined;
|
|
1874
2146
|
/**
|
|
2147
|
+
* @public
|
|
1875
2148
|
* <p>The unique ID for the membership that the configured table association belongs
|
|
1876
2149
|
* to.</p>
|
|
1877
2150
|
*/
|
|
1878
2151
|
membershipId: string | undefined;
|
|
1879
2152
|
/**
|
|
2153
|
+
* @public
|
|
1880
2154
|
* <p>The unique ARN for the membership that the configured table association belongs
|
|
1881
2155
|
* to.</p>
|
|
1882
2156
|
*/
|
|
1883
2157
|
membershipArn: string | undefined;
|
|
1884
2158
|
/**
|
|
2159
|
+
* @public
|
|
1885
2160
|
* <p>The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.</p>
|
|
1886
2161
|
*/
|
|
1887
2162
|
name: string | undefined;
|
|
1888
2163
|
/**
|
|
2164
|
+
* @public
|
|
1889
2165
|
* <p>The time the configured table association was created.</p>
|
|
1890
2166
|
*/
|
|
1891
2167
|
createTime: Date | undefined;
|
|
1892
2168
|
/**
|
|
2169
|
+
* @public
|
|
1893
2170
|
* <p>The time the configured table association was last updated.</p>
|
|
1894
2171
|
*/
|
|
1895
2172
|
updateTime: Date | undefined;
|
|
1896
2173
|
/**
|
|
2174
|
+
* @public
|
|
1897
2175
|
* <p>The unique ID for the configured table association.</p>
|
|
1898
2176
|
*/
|
|
1899
2177
|
id: string | undefined;
|
|
1900
2178
|
/**
|
|
2179
|
+
* @public
|
|
1901
2180
|
* <p>The unique ARN for the configured table association.</p>
|
|
1902
2181
|
*/
|
|
1903
2182
|
arn: string | undefined;
|
|
@@ -1907,10 +2186,12 @@ export interface ConfiguredTableAssociationSummary {
|
|
|
1907
2186
|
*/
|
|
1908
2187
|
export interface ListConfiguredTableAssociationsOutput {
|
|
1909
2188
|
/**
|
|
2189
|
+
* @public
|
|
1910
2190
|
* <p>The retrieved list of configured table associations.</p>
|
|
1911
2191
|
*/
|
|
1912
2192
|
configuredTableAssociationSummaries: ConfiguredTableAssociationSummary[] | undefined;
|
|
1913
2193
|
/**
|
|
2194
|
+
* @public
|
|
1914
2195
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
1915
2196
|
*/
|
|
1916
2197
|
nextToken?: string;
|
|
@@ -1920,19 +2201,23 @@ export interface ListConfiguredTableAssociationsOutput {
|
|
|
1920
2201
|
*/
|
|
1921
2202
|
export interface UpdateConfiguredTableAssociationInput {
|
|
1922
2203
|
/**
|
|
2204
|
+
* @public
|
|
1923
2205
|
* <p>The unique identifier for the configured table association to update. Currently accepts the configured table association ID.</p>
|
|
1924
2206
|
*/
|
|
1925
2207
|
configuredTableAssociationIdentifier: string | undefined;
|
|
1926
2208
|
/**
|
|
2209
|
+
* @public
|
|
1927
2210
|
* <p>The unique ID for the membership that the configured table association belongs
|
|
1928
2211
|
* to.</p>
|
|
1929
2212
|
*/
|
|
1930
2213
|
membershipIdentifier: string | undefined;
|
|
1931
2214
|
/**
|
|
2215
|
+
* @public
|
|
1932
2216
|
* <p>A new description for the configured table association.</p>
|
|
1933
2217
|
*/
|
|
1934
2218
|
description?: string;
|
|
1935
2219
|
/**
|
|
2220
|
+
* @public
|
|
1936
2221
|
* <p>The service will assume this role to access catalog metadata and query the table.</p>
|
|
1937
2222
|
*/
|
|
1938
2223
|
roleArn?: string;
|
|
@@ -1942,6 +2227,7 @@ export interface UpdateConfiguredTableAssociationInput {
|
|
|
1942
2227
|
*/
|
|
1943
2228
|
export interface UpdateConfiguredTableAssociationOutput {
|
|
1944
2229
|
/**
|
|
2230
|
+
* @public
|
|
1945
2231
|
* <p>The entire updated configured table association.</p>
|
|
1946
2232
|
*/
|
|
1947
2233
|
configuredTableAssociation: ConfiguredTableAssociation | undefined;
|
|
@@ -1952,10 +2238,12 @@ export interface UpdateConfiguredTableAssociationOutput {
|
|
|
1952
2238
|
*/
|
|
1953
2239
|
export interface GlueTableReference {
|
|
1954
2240
|
/**
|
|
2241
|
+
* @public
|
|
1955
2242
|
* <p>The name of the Glue table.</p>
|
|
1956
2243
|
*/
|
|
1957
2244
|
tableName: string | undefined;
|
|
1958
2245
|
/**
|
|
2246
|
+
* @public
|
|
1959
2247
|
* <p>The name of the database the Glue table belongs to.</p>
|
|
1960
2248
|
*/
|
|
1961
2249
|
databaseName: string | undefined;
|
|
@@ -1970,6 +2258,7 @@ export type TableReference = TableReference.GlueMember | TableReference.$Unknown
|
|
|
1970
2258
|
*/
|
|
1971
2259
|
export declare namespace TableReference {
|
|
1972
2260
|
/**
|
|
2261
|
+
* @public
|
|
1973
2262
|
* <p>If present, a reference to the Glue table referred to by this table
|
|
1974
2263
|
* reference.</p>
|
|
1975
2264
|
*/
|
|
@@ -1977,6 +2266,9 @@ export declare namespace TableReference {
|
|
|
1977
2266
|
glue: GlueTableReference;
|
|
1978
2267
|
$unknown?: never;
|
|
1979
2268
|
}
|
|
2269
|
+
/**
|
|
2270
|
+
* @public
|
|
2271
|
+
*/
|
|
1980
2272
|
interface $UnknownMember {
|
|
1981
2273
|
glue?: never;
|
|
1982
2274
|
$unknown: [string, any];
|
|
@@ -1992,26 +2284,32 @@ export declare namespace TableReference {
|
|
|
1992
2284
|
*/
|
|
1993
2285
|
export interface CreateConfiguredTableInput {
|
|
1994
2286
|
/**
|
|
2287
|
+
* @public
|
|
1995
2288
|
* <p>The name of the configured table.</p>
|
|
1996
2289
|
*/
|
|
1997
2290
|
name: string | undefined;
|
|
1998
2291
|
/**
|
|
2292
|
+
* @public
|
|
1999
2293
|
* <p>A description for the configured table.</p>
|
|
2000
2294
|
*/
|
|
2001
2295
|
description?: string;
|
|
2002
2296
|
/**
|
|
2297
|
+
* @public
|
|
2003
2298
|
* <p>A reference to the Glue table being configured.</p>
|
|
2004
2299
|
*/
|
|
2005
2300
|
tableReference: TableReference | undefined;
|
|
2006
2301
|
/**
|
|
2302
|
+
* @public
|
|
2007
2303
|
* <p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>
|
|
2008
2304
|
*/
|
|
2009
2305
|
allowedColumns: string[] | undefined;
|
|
2010
2306
|
/**
|
|
2307
|
+
* @public
|
|
2011
2308
|
* <p>The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.</p>
|
|
2012
2309
|
*/
|
|
2013
2310
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
2014
2311
|
/**
|
|
2312
|
+
* @public
|
|
2015
2313
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
2016
2314
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
2017
2315
|
* you can also use tag-based access control in IAM policies to control access to this
|
|
@@ -2038,42 +2336,52 @@ export type ConfiguredTableAnalysisRuleType = (typeof ConfiguredTableAnalysisRul
|
|
|
2038
2336
|
*/
|
|
2039
2337
|
export interface ConfiguredTable {
|
|
2040
2338
|
/**
|
|
2339
|
+
* @public
|
|
2041
2340
|
* <p>The unique ID for the configured table.</p>
|
|
2042
2341
|
*/
|
|
2043
2342
|
id: string | undefined;
|
|
2044
2343
|
/**
|
|
2344
|
+
* @public
|
|
2045
2345
|
* <p>The unique ARN for the configured table.</p>
|
|
2046
2346
|
*/
|
|
2047
2347
|
arn: string | undefined;
|
|
2048
2348
|
/**
|
|
2349
|
+
* @public
|
|
2049
2350
|
* <p>A name for the configured table.</p>
|
|
2050
2351
|
*/
|
|
2051
2352
|
name: string | undefined;
|
|
2052
2353
|
/**
|
|
2354
|
+
* @public
|
|
2053
2355
|
* <p>A description for the configured table.</p>
|
|
2054
2356
|
*/
|
|
2055
2357
|
description?: string;
|
|
2056
2358
|
/**
|
|
2359
|
+
* @public
|
|
2057
2360
|
* <p>The Glue table that this configured table represents.</p>
|
|
2058
2361
|
*/
|
|
2059
2362
|
tableReference: TableReference | undefined;
|
|
2060
2363
|
/**
|
|
2364
|
+
* @public
|
|
2061
2365
|
* <p>The time the configured table was created.</p>
|
|
2062
2366
|
*/
|
|
2063
2367
|
createTime: Date | undefined;
|
|
2064
2368
|
/**
|
|
2369
|
+
* @public
|
|
2065
2370
|
* <p>The time the configured table was last updated</p>
|
|
2066
2371
|
*/
|
|
2067
2372
|
updateTime: Date | undefined;
|
|
2068
2373
|
/**
|
|
2374
|
+
* @public
|
|
2069
2375
|
* <p>The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.</p>
|
|
2070
2376
|
*/
|
|
2071
2377
|
analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined;
|
|
2072
2378
|
/**
|
|
2379
|
+
* @public
|
|
2073
2380
|
* <p>The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.</p>
|
|
2074
2381
|
*/
|
|
2075
2382
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
2076
2383
|
/**
|
|
2384
|
+
* @public
|
|
2077
2385
|
* <p>The columns within the underlying Glue table that can be utilized within
|
|
2078
2386
|
* collaborations.</p>
|
|
2079
2387
|
*/
|
|
@@ -2084,6 +2392,7 @@ export interface ConfiguredTable {
|
|
|
2084
2392
|
*/
|
|
2085
2393
|
export interface CreateConfiguredTableOutput {
|
|
2086
2394
|
/**
|
|
2395
|
+
* @public
|
|
2087
2396
|
* <p>The created configured table.</p>
|
|
2088
2397
|
*/
|
|
2089
2398
|
configuredTable: ConfiguredTable | undefined;
|
|
@@ -2098,6 +2407,7 @@ export type ConfiguredTableAnalysisRulePolicyV1 = ConfiguredTableAnalysisRulePol
|
|
|
2098
2407
|
*/
|
|
2099
2408
|
export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
2100
2409
|
/**
|
|
2410
|
+
* @public
|
|
2101
2411
|
* <p>Analysis rule type that enables only list queries on a configured table.</p>
|
|
2102
2412
|
*/
|
|
2103
2413
|
interface ListMember {
|
|
@@ -2107,6 +2417,7 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
|
2107
2417
|
$unknown?: never;
|
|
2108
2418
|
}
|
|
2109
2419
|
/**
|
|
2420
|
+
* @public
|
|
2110
2421
|
* <p>Analysis rule type that enables only aggregation queries on a configured table.</p>
|
|
2111
2422
|
*/
|
|
2112
2423
|
interface AggregationMember {
|
|
@@ -2116,6 +2427,7 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
|
2116
2427
|
$unknown?: never;
|
|
2117
2428
|
}
|
|
2118
2429
|
/**
|
|
2430
|
+
* @public
|
|
2119
2431
|
* <p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.</p>
|
|
2120
2432
|
*/
|
|
2121
2433
|
interface CustomMember {
|
|
@@ -2124,6 +2436,9 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
|
|
|
2124
2436
|
custom: AnalysisRuleCustom;
|
|
2125
2437
|
$unknown?: never;
|
|
2126
2438
|
}
|
|
2439
|
+
/**
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2127
2442
|
interface $UnknownMember {
|
|
2128
2443
|
list?: never;
|
|
2129
2444
|
aggregation?: never;
|
|
@@ -2148,12 +2463,16 @@ export type ConfiguredTableAnalysisRulePolicy = ConfiguredTableAnalysisRulePolic
|
|
|
2148
2463
|
*/
|
|
2149
2464
|
export declare namespace ConfiguredTableAnalysisRulePolicy {
|
|
2150
2465
|
/**
|
|
2466
|
+
* @public
|
|
2151
2467
|
* <p>Controls on the query specifications that can be run on a configured table.</p>
|
|
2152
2468
|
*/
|
|
2153
2469
|
interface V1Member {
|
|
2154
2470
|
v1: ConfiguredTableAnalysisRulePolicyV1;
|
|
2155
2471
|
$unknown?: never;
|
|
2156
2472
|
}
|
|
2473
|
+
/**
|
|
2474
|
+
* @public
|
|
2475
|
+
*/
|
|
2157
2476
|
interface $UnknownMember {
|
|
2158
2477
|
v1?: never;
|
|
2159
2478
|
$unknown: [string, any];
|
|
@@ -2169,14 +2488,17 @@ export declare namespace ConfiguredTableAnalysisRulePolicy {
|
|
|
2169
2488
|
*/
|
|
2170
2489
|
export interface CreateConfiguredTableAnalysisRuleInput {
|
|
2171
2490
|
/**
|
|
2491
|
+
* @public
|
|
2172
2492
|
* <p>The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID. </p>
|
|
2173
2493
|
*/
|
|
2174
2494
|
configuredTableIdentifier: string | undefined;
|
|
2175
2495
|
/**
|
|
2496
|
+
* @public
|
|
2176
2497
|
* <p>The type of analysis rule.</p>
|
|
2177
2498
|
*/
|
|
2178
2499
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2179
2500
|
/**
|
|
2501
|
+
* @public
|
|
2180
2502
|
* <p>The entire created configured table analysis rule object.</p>
|
|
2181
2503
|
*/
|
|
2182
2504
|
analysisRulePolicy: ConfiguredTableAnalysisRulePolicy | undefined;
|
|
@@ -2187,26 +2509,32 @@ export interface CreateConfiguredTableAnalysisRuleInput {
|
|
|
2187
2509
|
*/
|
|
2188
2510
|
export interface ConfiguredTableAnalysisRule {
|
|
2189
2511
|
/**
|
|
2512
|
+
* @public
|
|
2190
2513
|
* <p>The unique ID for the configured table.</p>
|
|
2191
2514
|
*/
|
|
2192
2515
|
configuredTableId: string | undefined;
|
|
2193
2516
|
/**
|
|
2517
|
+
* @public
|
|
2194
2518
|
* <p>The unique ARN for the configured table.</p>
|
|
2195
2519
|
*/
|
|
2196
2520
|
configuredTableArn: string | undefined;
|
|
2197
2521
|
/**
|
|
2522
|
+
* @public
|
|
2198
2523
|
* <p>The policy that controls SQL query rules.</p>
|
|
2199
2524
|
*/
|
|
2200
2525
|
policy: ConfiguredTableAnalysisRulePolicy | undefined;
|
|
2201
2526
|
/**
|
|
2527
|
+
* @public
|
|
2202
2528
|
* <p>The type of configured table analysis rule.</p>
|
|
2203
2529
|
*/
|
|
2204
2530
|
type: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2205
2531
|
/**
|
|
2532
|
+
* @public
|
|
2206
2533
|
* <p>The time the configured table analysis rule was created.</p>
|
|
2207
2534
|
*/
|
|
2208
2535
|
createTime: Date | undefined;
|
|
2209
2536
|
/**
|
|
2537
|
+
* @public
|
|
2210
2538
|
* <p>The time the configured table analysis rule was last updated.</p>
|
|
2211
2539
|
*/
|
|
2212
2540
|
updateTime: Date | undefined;
|
|
@@ -2216,6 +2544,7 @@ export interface ConfiguredTableAnalysisRule {
|
|
|
2216
2544
|
*/
|
|
2217
2545
|
export interface CreateConfiguredTableAnalysisRuleOutput {
|
|
2218
2546
|
/**
|
|
2547
|
+
* @public
|
|
2219
2548
|
* <p>The entire created analysis rule.</p>
|
|
2220
2549
|
*/
|
|
2221
2550
|
analysisRule: ConfiguredTableAnalysisRule | undefined;
|
|
@@ -2225,6 +2554,7 @@ export interface CreateConfiguredTableAnalysisRuleOutput {
|
|
|
2225
2554
|
*/
|
|
2226
2555
|
export interface DeleteConfiguredTableInput {
|
|
2227
2556
|
/**
|
|
2557
|
+
* @public
|
|
2228
2558
|
* <p>The unique ID for the configured table to delete.</p>
|
|
2229
2559
|
*/
|
|
2230
2560
|
configuredTableIdentifier: string | undefined;
|
|
@@ -2240,11 +2570,13 @@ export interface DeleteConfiguredTableOutput {
|
|
|
2240
2570
|
*/
|
|
2241
2571
|
export interface DeleteConfiguredTableAnalysisRuleInput {
|
|
2242
2572
|
/**
|
|
2573
|
+
* @public
|
|
2243
2574
|
* <p>The unique identifier for the configured table that the analysis rule applies to.
|
|
2244
2575
|
* Currently accepts the configured table ID.</p>
|
|
2245
2576
|
*/
|
|
2246
2577
|
configuredTableIdentifier: string | undefined;
|
|
2247
2578
|
/**
|
|
2579
|
+
* @public
|
|
2248
2580
|
* <p>The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
2249
2581
|
*/
|
|
2250
2582
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
@@ -2260,6 +2592,7 @@ export interface DeleteConfiguredTableAnalysisRuleOutput {
|
|
|
2260
2592
|
*/
|
|
2261
2593
|
export interface GetConfiguredTableInput {
|
|
2262
2594
|
/**
|
|
2595
|
+
* @public
|
|
2263
2596
|
* <p>The unique ID for the configured table to retrieve.</p>
|
|
2264
2597
|
*/
|
|
2265
2598
|
configuredTableIdentifier: string | undefined;
|
|
@@ -2269,6 +2602,7 @@ export interface GetConfiguredTableInput {
|
|
|
2269
2602
|
*/
|
|
2270
2603
|
export interface GetConfiguredTableOutput {
|
|
2271
2604
|
/**
|
|
2605
|
+
* @public
|
|
2272
2606
|
* <p>The retrieved configured table.</p>
|
|
2273
2607
|
*/
|
|
2274
2608
|
configuredTable: ConfiguredTable | undefined;
|
|
@@ -2278,10 +2612,12 @@ export interface GetConfiguredTableOutput {
|
|
|
2278
2612
|
*/
|
|
2279
2613
|
export interface GetConfiguredTableAnalysisRuleInput {
|
|
2280
2614
|
/**
|
|
2615
|
+
* @public
|
|
2281
2616
|
* <p>The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.</p>
|
|
2282
2617
|
*/
|
|
2283
2618
|
configuredTableIdentifier: string | undefined;
|
|
2284
2619
|
/**
|
|
2620
|
+
* @public
|
|
2285
2621
|
* <p>The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
2286
2622
|
*/
|
|
2287
2623
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
@@ -2291,6 +2627,7 @@ export interface GetConfiguredTableAnalysisRuleInput {
|
|
|
2291
2627
|
*/
|
|
2292
2628
|
export interface GetConfiguredTableAnalysisRuleOutput {
|
|
2293
2629
|
/**
|
|
2630
|
+
* @public
|
|
2294
2631
|
* <p>The entire analysis rule output.</p>
|
|
2295
2632
|
*/
|
|
2296
2633
|
analysisRule: ConfiguredTableAnalysisRule | undefined;
|
|
@@ -2300,10 +2637,12 @@ export interface GetConfiguredTableAnalysisRuleOutput {
|
|
|
2300
2637
|
*/
|
|
2301
2638
|
export interface ListConfiguredTablesInput {
|
|
2302
2639
|
/**
|
|
2640
|
+
* @public
|
|
2303
2641
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2304
2642
|
*/
|
|
2305
2643
|
nextToken?: string;
|
|
2306
2644
|
/**
|
|
2645
|
+
* @public
|
|
2307
2646
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
2308
2647
|
*/
|
|
2309
2648
|
maxResults?: number;
|
|
@@ -2314,30 +2653,37 @@ export interface ListConfiguredTablesInput {
|
|
|
2314
2653
|
*/
|
|
2315
2654
|
export interface ConfiguredTableSummary {
|
|
2316
2655
|
/**
|
|
2656
|
+
* @public
|
|
2317
2657
|
* <p>The unique ID of the configured table.</p>
|
|
2318
2658
|
*/
|
|
2319
2659
|
id: string | undefined;
|
|
2320
2660
|
/**
|
|
2661
|
+
* @public
|
|
2321
2662
|
* <p>The unique ARN of the configured table.</p>
|
|
2322
2663
|
*/
|
|
2323
2664
|
arn: string | undefined;
|
|
2324
2665
|
/**
|
|
2666
|
+
* @public
|
|
2325
2667
|
* <p>The name of the configured table.</p>
|
|
2326
2668
|
*/
|
|
2327
2669
|
name: string | undefined;
|
|
2328
2670
|
/**
|
|
2671
|
+
* @public
|
|
2329
2672
|
* <p>The time the configured table was created.</p>
|
|
2330
2673
|
*/
|
|
2331
2674
|
createTime: Date | undefined;
|
|
2332
2675
|
/**
|
|
2676
|
+
* @public
|
|
2333
2677
|
* <p>The time the configured table was last updated.</p>
|
|
2334
2678
|
*/
|
|
2335
2679
|
updateTime: Date | undefined;
|
|
2336
2680
|
/**
|
|
2681
|
+
* @public
|
|
2337
2682
|
* <p>The types of analysis rules associated with this configured table.</p>
|
|
2338
2683
|
*/
|
|
2339
2684
|
analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined;
|
|
2340
2685
|
/**
|
|
2686
|
+
* @public
|
|
2341
2687
|
* <p>The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.</p>
|
|
2342
2688
|
*/
|
|
2343
2689
|
analysisMethod: AnalysisMethod | string | undefined;
|
|
@@ -2347,10 +2693,12 @@ export interface ConfiguredTableSummary {
|
|
|
2347
2693
|
*/
|
|
2348
2694
|
export interface ListConfiguredTablesOutput {
|
|
2349
2695
|
/**
|
|
2696
|
+
* @public
|
|
2350
2697
|
* <p>The configured tables listed by the request.</p>
|
|
2351
2698
|
*/
|
|
2352
2699
|
configuredTableSummaries: ConfiguredTableSummary[] | undefined;
|
|
2353
2700
|
/**
|
|
2701
|
+
* @public
|
|
2354
2702
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2355
2703
|
*/
|
|
2356
2704
|
nextToken?: string;
|
|
@@ -2360,14 +2708,17 @@ export interface ListConfiguredTablesOutput {
|
|
|
2360
2708
|
*/
|
|
2361
2709
|
export interface UpdateConfiguredTableInput {
|
|
2362
2710
|
/**
|
|
2711
|
+
* @public
|
|
2363
2712
|
* <p>The identifier for the configured table to update. Currently accepts the configured table ID.</p>
|
|
2364
2713
|
*/
|
|
2365
2714
|
configuredTableIdentifier: string | undefined;
|
|
2366
2715
|
/**
|
|
2716
|
+
* @public
|
|
2367
2717
|
* <p>A new name for the configured table.</p>
|
|
2368
2718
|
*/
|
|
2369
2719
|
name?: string;
|
|
2370
2720
|
/**
|
|
2721
|
+
* @public
|
|
2371
2722
|
* <p>A new description for the configured table.</p>
|
|
2372
2723
|
*/
|
|
2373
2724
|
description?: string;
|
|
@@ -2377,6 +2728,7 @@ export interface UpdateConfiguredTableInput {
|
|
|
2377
2728
|
*/
|
|
2378
2729
|
export interface UpdateConfiguredTableOutput {
|
|
2379
2730
|
/**
|
|
2731
|
+
* @public
|
|
2380
2732
|
* <p>The updated configured table.</p>
|
|
2381
2733
|
*/
|
|
2382
2734
|
configuredTable: ConfiguredTable | undefined;
|
|
@@ -2386,15 +2738,18 @@ export interface UpdateConfiguredTableOutput {
|
|
|
2386
2738
|
*/
|
|
2387
2739
|
export interface UpdateConfiguredTableAnalysisRuleInput {
|
|
2388
2740
|
/**
|
|
2741
|
+
* @public
|
|
2389
2742
|
* <p>The unique identifier for the configured table that the analysis rule applies to.
|
|
2390
2743
|
* Currently accepts the configured table ID.</p>
|
|
2391
2744
|
*/
|
|
2392
2745
|
configuredTableIdentifier: string | undefined;
|
|
2393
2746
|
/**
|
|
2747
|
+
* @public
|
|
2394
2748
|
* <p>The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>
|
|
2395
2749
|
*/
|
|
2396
2750
|
analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
|
|
2397
2751
|
/**
|
|
2752
|
+
* @public
|
|
2398
2753
|
* <p>The new analysis rule policy for the configured table analysis rule.</p>
|
|
2399
2754
|
*/
|
|
2400
2755
|
analysisRulePolicy: ConfiguredTableAnalysisRulePolicy | undefined;
|
|
@@ -2404,6 +2759,7 @@ export interface UpdateConfiguredTableAnalysisRuleInput {
|
|
|
2404
2759
|
*/
|
|
2405
2760
|
export interface UpdateConfiguredTableAnalysisRuleOutput {
|
|
2406
2761
|
/**
|
|
2762
|
+
* @public
|
|
2407
2763
|
* <p>The entire updated analysis rule.</p>
|
|
2408
2764
|
*/
|
|
2409
2765
|
analysisRule: ConfiguredTableAnalysisRule | undefined;
|
|
@@ -2413,6 +2769,7 @@ export interface UpdateConfiguredTableAnalysisRuleOutput {
|
|
|
2413
2769
|
*/
|
|
2414
2770
|
export interface ListTagsForResourceInput {
|
|
2415
2771
|
/**
|
|
2772
|
+
* @public
|
|
2416
2773
|
* <p>The Amazon Resource Name (ARN) associated with the resource you want to list tags on.</p>
|
|
2417
2774
|
*/
|
|
2418
2775
|
resourceArn: string | undefined;
|
|
@@ -2422,6 +2779,7 @@ export interface ListTagsForResourceInput {
|
|
|
2422
2779
|
*/
|
|
2423
2780
|
export interface ListTagsForResourceOutput {
|
|
2424
2781
|
/**
|
|
2782
|
+
* @public
|
|
2425
2783
|
* <p>A map of objects specifying each key name and value.</p>
|
|
2426
2784
|
*/
|
|
2427
2785
|
tags: Record<string, string> | undefined;
|
|
@@ -2443,15 +2801,18 @@ export type MembershipQueryLogStatus = (typeof MembershipQueryLogStatus)[keyof t
|
|
|
2443
2801
|
*/
|
|
2444
2802
|
export interface CreateMembershipInput {
|
|
2445
2803
|
/**
|
|
2804
|
+
* @public
|
|
2446
2805
|
* <p>The unique ID for the associated collaboration.</p>
|
|
2447
2806
|
*/
|
|
2448
2807
|
collaborationIdentifier: string | undefined;
|
|
2449
2808
|
/**
|
|
2809
|
+
* @public
|
|
2450
2810
|
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
2451
2811
|
* collaboration.</p>
|
|
2452
2812
|
*/
|
|
2453
2813
|
queryLogStatus: MembershipQueryLogStatus | string | undefined;
|
|
2454
2814
|
/**
|
|
2815
|
+
* @public
|
|
2455
2816
|
* <p>An optional label that you can assign to a resource when you create it. Each tag
|
|
2456
2817
|
* consists of a key and an optional value, both of which you define. When you use tagging,
|
|
2457
2818
|
* you can also use tag-based access control in IAM policies to control access to this
|
|
@@ -2478,50 +2839,62 @@ export type MembershipStatus = (typeof MembershipStatus)[keyof typeof Membership
|
|
|
2478
2839
|
*/
|
|
2479
2840
|
export interface Membership {
|
|
2480
2841
|
/**
|
|
2842
|
+
* @public
|
|
2481
2843
|
* <p>The unique ID of the membership.</p>
|
|
2482
2844
|
*/
|
|
2483
2845
|
id: string | undefined;
|
|
2484
2846
|
/**
|
|
2847
|
+
* @public
|
|
2485
2848
|
* <p>The unique ARN for the membership.</p>
|
|
2486
2849
|
*/
|
|
2487
2850
|
arn: string | undefined;
|
|
2488
2851
|
/**
|
|
2852
|
+
* @public
|
|
2489
2853
|
* <p>The unique ARN for the membership's associated collaboration.</p>
|
|
2490
2854
|
*/
|
|
2491
2855
|
collaborationArn: string | undefined;
|
|
2492
2856
|
/**
|
|
2857
|
+
* @public
|
|
2493
2858
|
* <p>The unique ID for the membership's collaboration.</p>
|
|
2494
2859
|
*/
|
|
2495
2860
|
collaborationId: string | undefined;
|
|
2496
2861
|
/**
|
|
2862
|
+
* @public
|
|
2497
2863
|
* <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
2498
2864
|
*/
|
|
2499
2865
|
collaborationCreatorAccountId: string | undefined;
|
|
2500
2866
|
/**
|
|
2867
|
+
* @public
|
|
2501
2868
|
* <p>The display name of the collaboration creator.</p>
|
|
2502
2869
|
*/
|
|
2503
2870
|
collaborationCreatorDisplayName: string | undefined;
|
|
2504
2871
|
/**
|
|
2872
|
+
* @public
|
|
2505
2873
|
* <p>The name of the membership's collaboration.</p>
|
|
2506
2874
|
*/
|
|
2507
2875
|
collaborationName: string | undefined;
|
|
2508
2876
|
/**
|
|
2877
|
+
* @public
|
|
2509
2878
|
* <p>The time when the membership was created.</p>
|
|
2510
2879
|
*/
|
|
2511
2880
|
createTime: Date | undefined;
|
|
2512
2881
|
/**
|
|
2882
|
+
* @public
|
|
2513
2883
|
* <p>The time the membership metadata was last updated.</p>
|
|
2514
2884
|
*/
|
|
2515
2885
|
updateTime: Date | undefined;
|
|
2516
2886
|
/**
|
|
2887
|
+
* @public
|
|
2517
2888
|
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.</p>
|
|
2518
2889
|
*/
|
|
2519
2890
|
status: MembershipStatus | string | undefined;
|
|
2520
2891
|
/**
|
|
2892
|
+
* @public
|
|
2521
2893
|
* <p>The abilities granted to the collaboration member.</p>
|
|
2522
2894
|
*/
|
|
2523
2895
|
memberAbilities: (MemberAbility | string)[] | undefined;
|
|
2524
2896
|
/**
|
|
2897
|
+
* @public
|
|
2525
2898
|
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
2526
2899
|
* collaboration.</p>
|
|
2527
2900
|
*/
|
|
@@ -2532,6 +2905,7 @@ export interface Membership {
|
|
|
2532
2905
|
*/
|
|
2533
2906
|
export interface CreateMembershipOutput {
|
|
2534
2907
|
/**
|
|
2908
|
+
* @public
|
|
2535
2909
|
* <p>The membership that was created.</p>
|
|
2536
2910
|
*/
|
|
2537
2911
|
membership: Membership | undefined;
|
|
@@ -2541,6 +2915,7 @@ export interface CreateMembershipOutput {
|
|
|
2541
2915
|
*/
|
|
2542
2916
|
export interface DeleteMembershipInput {
|
|
2543
2917
|
/**
|
|
2918
|
+
* @public
|
|
2544
2919
|
* <p>The identifier for a membership resource.</p>
|
|
2545
2920
|
*/
|
|
2546
2921
|
membershipIdentifier: string | undefined;
|
|
@@ -2555,6 +2930,7 @@ export interface DeleteMembershipOutput {
|
|
|
2555
2930
|
*/
|
|
2556
2931
|
export interface GetMembershipInput {
|
|
2557
2932
|
/**
|
|
2933
|
+
* @public
|
|
2558
2934
|
* <p>The identifier for a membership resource.</p>
|
|
2559
2935
|
*/
|
|
2560
2936
|
membershipIdentifier: string | undefined;
|
|
@@ -2564,6 +2940,7 @@ export interface GetMembershipInput {
|
|
|
2564
2940
|
*/
|
|
2565
2941
|
export interface GetMembershipOutput {
|
|
2566
2942
|
/**
|
|
2943
|
+
* @public
|
|
2567
2944
|
* <p>The membership retrieved for the provided identifier.</p>
|
|
2568
2945
|
*/
|
|
2569
2946
|
membership: Membership | undefined;
|
|
@@ -2573,10 +2950,12 @@ export interface GetMembershipOutput {
|
|
|
2573
2950
|
*/
|
|
2574
2951
|
export interface GetProtectedQueryInput {
|
|
2575
2952
|
/**
|
|
2953
|
+
* @public
|
|
2576
2954
|
* <p>The identifier for a membership in a protected query instance.</p>
|
|
2577
2955
|
*/
|
|
2578
2956
|
membershipIdentifier: string | undefined;
|
|
2579
2957
|
/**
|
|
2958
|
+
* @public
|
|
2580
2959
|
* <p>The identifier for a protected query instance.</p>
|
|
2581
2960
|
*/
|
|
2582
2961
|
protectedQueryIdentifier: string | undefined;
|
|
@@ -2587,10 +2966,12 @@ export interface GetProtectedQueryInput {
|
|
|
2587
2966
|
*/
|
|
2588
2967
|
export interface ProtectedQueryError {
|
|
2589
2968
|
/**
|
|
2969
|
+
* @public
|
|
2590
2970
|
* <p>A description of why the query failed.</p>
|
|
2591
2971
|
*/
|
|
2592
2972
|
message: string | undefined;
|
|
2593
2973
|
/**
|
|
2974
|
+
* @public
|
|
2594
2975
|
* <p>An error code for the error.</p>
|
|
2595
2976
|
*/
|
|
2596
2977
|
code: string | undefined;
|
|
@@ -2601,6 +2982,7 @@ export interface ProtectedQueryError {
|
|
|
2601
2982
|
*/
|
|
2602
2983
|
export interface ProtectedQueryS3Output {
|
|
2603
2984
|
/**
|
|
2985
|
+
* @public
|
|
2604
2986
|
* <p>The S3 location of the result.</p>
|
|
2605
2987
|
*/
|
|
2606
2988
|
location: string | undefined;
|
|
@@ -2615,12 +2997,16 @@ export type ProtectedQueryOutput = ProtectedQueryOutput.S3Member | ProtectedQuer
|
|
|
2615
2997
|
*/
|
|
2616
2998
|
export declare namespace ProtectedQueryOutput {
|
|
2617
2999
|
/**
|
|
3000
|
+
* @public
|
|
2618
3001
|
* <p>If present, the output for a protected query with an `S3` output type.</p>
|
|
2619
3002
|
*/
|
|
2620
3003
|
interface S3Member {
|
|
2621
3004
|
s3: ProtectedQueryS3Output;
|
|
2622
3005
|
$unknown?: never;
|
|
2623
3006
|
}
|
|
3007
|
+
/**
|
|
3008
|
+
* @public
|
|
3009
|
+
*/
|
|
2624
3010
|
interface $UnknownMember {
|
|
2625
3011
|
s3?: never;
|
|
2626
3012
|
$unknown: [string, any];
|
|
@@ -2637,6 +3023,7 @@ export declare namespace ProtectedQueryOutput {
|
|
|
2637
3023
|
*/
|
|
2638
3024
|
export interface ProtectedQueryResult {
|
|
2639
3025
|
/**
|
|
3026
|
+
* @public
|
|
2640
3027
|
* <p>The output of the protected query.</p>
|
|
2641
3028
|
*/
|
|
2642
3029
|
output: ProtectedQueryOutput | undefined;
|
|
@@ -2659,14 +3046,17 @@ export type ResultFormat = (typeof ResultFormat)[keyof typeof ResultFormat];
|
|
|
2659
3046
|
*/
|
|
2660
3047
|
export interface ProtectedQueryS3OutputConfiguration {
|
|
2661
3048
|
/**
|
|
3049
|
+
* @public
|
|
2662
3050
|
* <p>Intended file format of the result.</p>
|
|
2663
3051
|
*/
|
|
2664
3052
|
resultFormat: ResultFormat | string | undefined;
|
|
2665
3053
|
/**
|
|
3054
|
+
* @public
|
|
2666
3055
|
* <p>The S3 bucket to unload the protected query results.</p>
|
|
2667
3056
|
*/
|
|
2668
3057
|
bucket: string | undefined;
|
|
2669
3058
|
/**
|
|
3059
|
+
* @public
|
|
2670
3060
|
* <p>The S3 prefix to unload the protected query results.</p>
|
|
2671
3061
|
*/
|
|
2672
3062
|
keyPrefix?: string;
|
|
@@ -2681,12 +3071,16 @@ export type ProtectedQueryOutputConfiguration = ProtectedQueryOutputConfiguratio
|
|
|
2681
3071
|
*/
|
|
2682
3072
|
export declare namespace ProtectedQueryOutputConfiguration {
|
|
2683
3073
|
/**
|
|
3074
|
+
* @public
|
|
2684
3075
|
* <p>Required configuration for a protected query with an `S3` output type.</p>
|
|
2685
3076
|
*/
|
|
2686
3077
|
interface S3Member {
|
|
2687
3078
|
s3: ProtectedQueryS3OutputConfiguration;
|
|
2688
3079
|
$unknown?: never;
|
|
2689
3080
|
}
|
|
3081
|
+
/**
|
|
3082
|
+
* @public
|
|
3083
|
+
*/
|
|
2690
3084
|
interface $UnknownMember {
|
|
2691
3085
|
s3?: never;
|
|
2692
3086
|
$unknown: [string, any];
|
|
@@ -2703,6 +3097,7 @@ export declare namespace ProtectedQueryOutputConfiguration {
|
|
|
2703
3097
|
*/
|
|
2704
3098
|
export interface ProtectedQueryResultConfiguration {
|
|
2705
3099
|
/**
|
|
3100
|
+
* @public
|
|
2706
3101
|
* <p>Configuration for protected query results.</p>
|
|
2707
3102
|
*/
|
|
2708
3103
|
outputConfiguration: ProtectedQueryOutputConfiguration | undefined;
|
|
@@ -2713,14 +3108,17 @@ export interface ProtectedQueryResultConfiguration {
|
|
|
2713
3108
|
*/
|
|
2714
3109
|
export interface ProtectedQuerySQLParameters {
|
|
2715
3110
|
/**
|
|
3111
|
+
* @public
|
|
2716
3112
|
* <p>The query string to be submitted.</p>
|
|
2717
3113
|
*/
|
|
2718
3114
|
queryString?: string;
|
|
2719
3115
|
/**
|
|
3116
|
+
* @public
|
|
2720
3117
|
* <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
|
|
2721
3118
|
*/
|
|
2722
3119
|
analysisTemplateArn?: string;
|
|
2723
3120
|
/**
|
|
3121
|
+
* @public
|
|
2724
3122
|
* <p>The protected query SQL parameters.</p>
|
|
2725
3123
|
*/
|
|
2726
3124
|
parameters?: Record<string, string>;
|
|
@@ -2731,6 +3129,7 @@ export interface ProtectedQuerySQLParameters {
|
|
|
2731
3129
|
*/
|
|
2732
3130
|
export interface ProtectedQueryStatistics {
|
|
2733
3131
|
/**
|
|
3132
|
+
* @public
|
|
2734
3133
|
* <p>The duration of the Protected Query, from creation until query completion.</p>
|
|
2735
3134
|
*/
|
|
2736
3135
|
totalDurationInMillis?: number;
|
|
@@ -2758,42 +3157,52 @@ export type ProtectedQueryStatus = (typeof ProtectedQueryStatus)[keyof typeof Pr
|
|
|
2758
3157
|
*/
|
|
2759
3158
|
export interface ProtectedQuery {
|
|
2760
3159
|
/**
|
|
3160
|
+
* @public
|
|
2761
3161
|
* <p>The identifier for a protected query instance.</p>
|
|
2762
3162
|
*/
|
|
2763
3163
|
id: string | undefined;
|
|
2764
3164
|
/**
|
|
3165
|
+
* @public
|
|
2765
3166
|
* <p>The identifier for the membership.</p>
|
|
2766
3167
|
*/
|
|
2767
3168
|
membershipId: string | undefined;
|
|
2768
3169
|
/**
|
|
3170
|
+
* @public
|
|
2769
3171
|
* <p>The ARN of the membership.</p>
|
|
2770
3172
|
*/
|
|
2771
3173
|
membershipArn: string | undefined;
|
|
2772
3174
|
/**
|
|
3175
|
+
* @public
|
|
2773
3176
|
* <p>The time at which the protected query was created.</p>
|
|
2774
3177
|
*/
|
|
2775
3178
|
createTime: Date | undefined;
|
|
2776
3179
|
/**
|
|
3180
|
+
* @public
|
|
2777
3181
|
* <p>The protected query SQL parameters.</p>
|
|
2778
3182
|
*/
|
|
2779
3183
|
sqlParameters: ProtectedQuerySQLParameters | undefined;
|
|
2780
3184
|
/**
|
|
3185
|
+
* @public
|
|
2781
3186
|
* <p>The status of the query.</p>
|
|
2782
3187
|
*/
|
|
2783
3188
|
status: ProtectedQueryStatus | string | undefined;
|
|
2784
3189
|
/**
|
|
3190
|
+
* @public
|
|
2785
3191
|
* <p>Contains any details needed to write the query results.</p>
|
|
2786
3192
|
*/
|
|
2787
3193
|
resultConfiguration: ProtectedQueryResultConfiguration | undefined;
|
|
2788
3194
|
/**
|
|
3195
|
+
* @public
|
|
2789
3196
|
* <p>Statistics about protected query execution.</p>
|
|
2790
3197
|
*/
|
|
2791
3198
|
statistics?: ProtectedQueryStatistics;
|
|
2792
3199
|
/**
|
|
3200
|
+
* @public
|
|
2793
3201
|
* <p>The result of the protected query.</p>
|
|
2794
3202
|
*/
|
|
2795
3203
|
result?: ProtectedQueryResult;
|
|
2796
3204
|
/**
|
|
3205
|
+
* @public
|
|
2797
3206
|
* <p>An error thrown by the protected query.</p>
|
|
2798
3207
|
*/
|
|
2799
3208
|
error?: ProtectedQueryError;
|
|
@@ -2803,6 +3212,7 @@ export interface ProtectedQuery {
|
|
|
2803
3212
|
*/
|
|
2804
3213
|
export interface GetProtectedQueryOutput {
|
|
2805
3214
|
/**
|
|
3215
|
+
* @public
|
|
2806
3216
|
* <p>The query processing metadata.</p>
|
|
2807
3217
|
*/
|
|
2808
3218
|
protectedQuery: ProtectedQuery | undefined;
|
|
@@ -2812,14 +3222,17 @@ export interface GetProtectedQueryOutput {
|
|
|
2812
3222
|
*/
|
|
2813
3223
|
export interface ListMembershipsInput {
|
|
2814
3224
|
/**
|
|
3225
|
+
* @public
|
|
2815
3226
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2816
3227
|
*/
|
|
2817
3228
|
nextToken?: string;
|
|
2818
3229
|
/**
|
|
3230
|
+
* @public
|
|
2819
3231
|
* <p>The maximum size of the results that is returned per call.</p>
|
|
2820
3232
|
*/
|
|
2821
3233
|
maxResults?: number;
|
|
2822
3234
|
/**
|
|
3235
|
+
* @public
|
|
2823
3236
|
* <p>A filter which will return only memberships in the specified status.</p>
|
|
2824
3237
|
*/
|
|
2825
3238
|
status?: MembershipStatus | string;
|
|
@@ -2830,46 +3243,57 @@ export interface ListMembershipsInput {
|
|
|
2830
3243
|
*/
|
|
2831
3244
|
export interface MembershipSummary {
|
|
2832
3245
|
/**
|
|
3246
|
+
* @public
|
|
2833
3247
|
* <p>The unique ID for the membership's collaboration.</p>
|
|
2834
3248
|
*/
|
|
2835
3249
|
id: string | undefined;
|
|
2836
3250
|
/**
|
|
3251
|
+
* @public
|
|
2837
3252
|
* <p>The unique ARN for the membership.</p>
|
|
2838
3253
|
*/
|
|
2839
3254
|
arn: string | undefined;
|
|
2840
3255
|
/**
|
|
3256
|
+
* @public
|
|
2841
3257
|
* <p>The unique ARN for the membership's associated collaboration.</p>
|
|
2842
3258
|
*/
|
|
2843
3259
|
collaborationArn: string | undefined;
|
|
2844
3260
|
/**
|
|
3261
|
+
* @public
|
|
2845
3262
|
* <p>The unique ID for the membership's collaboration.</p>
|
|
2846
3263
|
*/
|
|
2847
3264
|
collaborationId: string | undefined;
|
|
2848
3265
|
/**
|
|
3266
|
+
* @public
|
|
2849
3267
|
* <p>The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.</p>
|
|
2850
3268
|
*/
|
|
2851
3269
|
collaborationCreatorAccountId: string | undefined;
|
|
2852
3270
|
/**
|
|
3271
|
+
* @public
|
|
2853
3272
|
* <p>The display name of the collaboration creator.</p>
|
|
2854
3273
|
*/
|
|
2855
3274
|
collaborationCreatorDisplayName: string | undefined;
|
|
2856
3275
|
/**
|
|
3276
|
+
* @public
|
|
2857
3277
|
* <p>The name for the membership's collaboration.</p>
|
|
2858
3278
|
*/
|
|
2859
3279
|
collaborationName: string | undefined;
|
|
2860
3280
|
/**
|
|
3281
|
+
* @public
|
|
2861
3282
|
* <p>The time when the membership was created.</p>
|
|
2862
3283
|
*/
|
|
2863
3284
|
createTime: Date | undefined;
|
|
2864
3285
|
/**
|
|
3286
|
+
* @public
|
|
2865
3287
|
* <p>The time the membership metadata was last updated.</p>
|
|
2866
3288
|
*/
|
|
2867
3289
|
updateTime: Date | undefined;
|
|
2868
3290
|
/**
|
|
3291
|
+
* @public
|
|
2869
3292
|
* <p>The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.</p>
|
|
2870
3293
|
*/
|
|
2871
3294
|
status: MembershipStatus | string | undefined;
|
|
2872
3295
|
/**
|
|
3296
|
+
* @public
|
|
2873
3297
|
* <p>The abilities granted to the collaboration member.</p>
|
|
2874
3298
|
*/
|
|
2875
3299
|
memberAbilities: (MemberAbility | string)[] | undefined;
|
|
@@ -2879,10 +3303,12 @@ export interface MembershipSummary {
|
|
|
2879
3303
|
*/
|
|
2880
3304
|
export interface ListMembershipsOutput {
|
|
2881
3305
|
/**
|
|
3306
|
+
* @public
|
|
2882
3307
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2883
3308
|
*/
|
|
2884
3309
|
nextToken?: string;
|
|
2885
3310
|
/**
|
|
3311
|
+
* @public
|
|
2886
3312
|
* <p>The list of memberships returned from the ListMemberships operation.</p>
|
|
2887
3313
|
*/
|
|
2888
3314
|
membershipSummaries: MembershipSummary[] | undefined;
|
|
@@ -2892,18 +3318,22 @@ export interface ListMembershipsOutput {
|
|
|
2892
3318
|
*/
|
|
2893
3319
|
export interface ListProtectedQueriesInput {
|
|
2894
3320
|
/**
|
|
3321
|
+
* @public
|
|
2895
3322
|
* <p>The identifier for the membership in the collaboration.</p>
|
|
2896
3323
|
*/
|
|
2897
3324
|
membershipIdentifier: string | undefined;
|
|
2898
3325
|
/**
|
|
3326
|
+
* @public
|
|
2899
3327
|
* <p>A filter on the status of the protected query.</p>
|
|
2900
3328
|
*/
|
|
2901
3329
|
status?: ProtectedQueryStatus | string;
|
|
2902
3330
|
/**
|
|
3331
|
+
* @public
|
|
2903
3332
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2904
3333
|
*/
|
|
2905
3334
|
nextToken?: string;
|
|
2906
3335
|
/**
|
|
3336
|
+
* @public
|
|
2907
3337
|
* <p>The maximum size of the results that is returned per call. Service chooses a default if
|
|
2908
3338
|
* it has not been set. Service can return a nextToken even if the maximum results has not
|
|
2909
3339
|
* been met. </p>
|
|
@@ -2916,22 +3346,27 @@ export interface ListProtectedQueriesInput {
|
|
|
2916
3346
|
*/
|
|
2917
3347
|
export interface ProtectedQuerySummary {
|
|
2918
3348
|
/**
|
|
3349
|
+
* @public
|
|
2919
3350
|
* <p>The unique ID of the protected query.</p>
|
|
2920
3351
|
*/
|
|
2921
3352
|
id: string | undefined;
|
|
2922
3353
|
/**
|
|
3354
|
+
* @public
|
|
2923
3355
|
* <p>The unique ID for the membership that initiated the protected query.</p>
|
|
2924
3356
|
*/
|
|
2925
3357
|
membershipId: string | undefined;
|
|
2926
3358
|
/**
|
|
3359
|
+
* @public
|
|
2927
3360
|
* <p>The unique ARN for the membership that initiated the protected query.</p>
|
|
2928
3361
|
*/
|
|
2929
3362
|
membershipArn: string | undefined;
|
|
2930
3363
|
/**
|
|
3364
|
+
* @public
|
|
2931
3365
|
* <p>The time the protected query was created.</p>
|
|
2932
3366
|
*/
|
|
2933
3367
|
createTime: Date | undefined;
|
|
2934
3368
|
/**
|
|
3369
|
+
* @public
|
|
2935
3370
|
* <p>The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.</p>
|
|
2936
3371
|
*/
|
|
2937
3372
|
status: ProtectedQueryStatus | string | undefined;
|
|
@@ -2941,10 +3376,12 @@ export interface ProtectedQuerySummary {
|
|
|
2941
3376
|
*/
|
|
2942
3377
|
export interface ListProtectedQueriesOutput {
|
|
2943
3378
|
/**
|
|
3379
|
+
* @public
|
|
2944
3380
|
* <p>The token value retrieved from a previous call to access the next page of results.</p>
|
|
2945
3381
|
*/
|
|
2946
3382
|
nextToken?: string;
|
|
2947
3383
|
/**
|
|
3384
|
+
* @public
|
|
2948
3385
|
* <p>A list of protected queries.</p>
|
|
2949
3386
|
*/
|
|
2950
3387
|
protectedQueries: ProtectedQuerySummary[] | undefined;
|
|
@@ -2965,18 +3402,22 @@ export type ProtectedQueryType = (typeof ProtectedQueryType)[keyof typeof Protec
|
|
|
2965
3402
|
*/
|
|
2966
3403
|
export interface StartProtectedQueryInput {
|
|
2967
3404
|
/**
|
|
3405
|
+
* @public
|
|
2968
3406
|
* <p>The type of the protected query to be started.</p>
|
|
2969
3407
|
*/
|
|
2970
3408
|
type: ProtectedQueryType | string | undefined;
|
|
2971
3409
|
/**
|
|
3410
|
+
* @public
|
|
2972
3411
|
* <p>A unique identifier for the membership to run this query against. Currently accepts a membership ID.</p>
|
|
2973
3412
|
*/
|
|
2974
3413
|
membershipIdentifier: string | undefined;
|
|
2975
3414
|
/**
|
|
3415
|
+
* @public
|
|
2976
3416
|
* <p>The protected SQL query parameters.</p>
|
|
2977
3417
|
*/
|
|
2978
3418
|
sqlParameters: ProtectedQuerySQLParameters | undefined;
|
|
2979
3419
|
/**
|
|
3420
|
+
* @public
|
|
2980
3421
|
* <p>The details needed to write the query results.</p>
|
|
2981
3422
|
*/
|
|
2982
3423
|
resultConfiguration: ProtectedQueryResultConfiguration | undefined;
|
|
@@ -2986,6 +3427,7 @@ export interface StartProtectedQueryInput {
|
|
|
2986
3427
|
*/
|
|
2987
3428
|
export interface StartProtectedQueryOutput {
|
|
2988
3429
|
/**
|
|
3430
|
+
* @public
|
|
2989
3431
|
* <p>The protected query.</p>
|
|
2990
3432
|
*/
|
|
2991
3433
|
protectedQuery: ProtectedQuery | undefined;
|
|
@@ -2995,10 +3437,12 @@ export interface StartProtectedQueryOutput {
|
|
|
2995
3437
|
*/
|
|
2996
3438
|
export interface UpdateMembershipInput {
|
|
2997
3439
|
/**
|
|
3440
|
+
* @public
|
|
2998
3441
|
* <p>The unique identifier of the membership.</p>
|
|
2999
3442
|
*/
|
|
3000
3443
|
membershipIdentifier: string | undefined;
|
|
3001
3444
|
/**
|
|
3445
|
+
* @public
|
|
3002
3446
|
* <p>An indicator as to whether query logging has been enabled or disabled for the
|
|
3003
3447
|
* collaboration.</p>
|
|
3004
3448
|
*/
|
|
@@ -3009,6 +3453,7 @@ export interface UpdateMembershipInput {
|
|
|
3009
3453
|
*/
|
|
3010
3454
|
export interface UpdateMembershipOutput {
|
|
3011
3455
|
/**
|
|
3456
|
+
* @public
|
|
3012
3457
|
* <p>The membership object.</p>
|
|
3013
3458
|
*/
|
|
3014
3459
|
membership: Membership | undefined;
|
|
@@ -3029,14 +3474,17 @@ export type TargetProtectedQueryStatus = (typeof TargetProtectedQueryStatus)[key
|
|
|
3029
3474
|
*/
|
|
3030
3475
|
export interface UpdateProtectedQueryInput {
|
|
3031
3476
|
/**
|
|
3477
|
+
* @public
|
|
3032
3478
|
* <p>The identifier for a member of a protected query instance.</p>
|
|
3033
3479
|
*/
|
|
3034
3480
|
membershipIdentifier: string | undefined;
|
|
3035
3481
|
/**
|
|
3482
|
+
* @public
|
|
3036
3483
|
* <p>The identifier for a protected query instance.</p>
|
|
3037
3484
|
*/
|
|
3038
3485
|
protectedQueryIdentifier: string | undefined;
|
|
3039
3486
|
/**
|
|
3487
|
+
* @public
|
|
3040
3488
|
* <p>The target status of a query. Used to update the execution status of a currently running query.</p>
|
|
3041
3489
|
*/
|
|
3042
3490
|
targetStatus: TargetProtectedQueryStatus | string | undefined;
|
|
@@ -3046,6 +3494,7 @@ export interface UpdateProtectedQueryInput {
|
|
|
3046
3494
|
*/
|
|
3047
3495
|
export interface UpdateProtectedQueryOutput {
|
|
3048
3496
|
/**
|
|
3497
|
+
* @public
|
|
3049
3498
|
* <p>The protected query output.</p>
|
|
3050
3499
|
*/
|
|
3051
3500
|
protectedQuery: ProtectedQuery | undefined;
|
|
@@ -3055,10 +3504,12 @@ export interface UpdateProtectedQueryOutput {
|
|
|
3055
3504
|
*/
|
|
3056
3505
|
export interface TagResourceInput {
|
|
3057
3506
|
/**
|
|
3507
|
+
* @public
|
|
3058
3508
|
* <p>The Amazon Resource Name (ARN) associated with the resource you want to tag.</p>
|
|
3059
3509
|
*/
|
|
3060
3510
|
resourceArn: string | undefined;
|
|
3061
3511
|
/**
|
|
3512
|
+
* @public
|
|
3062
3513
|
* <p>A map of objects specifying each key name and value.</p>
|
|
3063
3514
|
*/
|
|
3064
3515
|
tags: Record<string, string> | undefined;
|
|
@@ -3073,10 +3524,12 @@ export interface TagResourceOutput {
|
|
|
3073
3524
|
*/
|
|
3074
3525
|
export interface UntagResourceInput {
|
|
3075
3526
|
/**
|
|
3527
|
+
* @public
|
|
3076
3528
|
* <p>The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.</p>
|
|
3077
3529
|
*/
|
|
3078
3530
|
resourceArn: string | undefined;
|
|
3079
3531
|
/**
|
|
3532
|
+
* @public
|
|
3080
3533
|
* <p>A list of key names of tags to be removed.</p>
|
|
3081
3534
|
*/
|
|
3082
3535
|
tagKeys: string[] | undefined;
|