@aws-sdk/client-cleanrooms 3.378.0 → 3.381.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/README.md +71 -7
  2. package/dist-cjs/CleanRooms.js +16 -0
  3. package/dist-cjs/commands/BatchGetCollaborationAnalysisTemplateCommand.js +47 -0
  4. package/dist-cjs/commands/CreateAnalysisTemplateCommand.js +47 -0
  5. package/dist-cjs/commands/DeleteAnalysisTemplateCommand.js +46 -0
  6. package/dist-cjs/commands/GetAnalysisTemplateCommand.js +47 -0
  7. package/dist-cjs/commands/GetCollaborationAnalysisTemplateCommand.js +47 -0
  8. package/dist-cjs/commands/ListAnalysisTemplatesCommand.js +46 -0
  9. package/dist-cjs/commands/ListCollaborationAnalysisTemplatesCommand.js +46 -0
  10. package/dist-cjs/commands/UpdateAnalysisTemplateCommand.js +47 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/models/models_0.js +139 -45
  13. package/dist-cjs/pagination/ListAnalysisTemplatesPaginator.js +29 -0
  14. package/dist-cjs/pagination/ListCollaborationAnalysisTemplatesPaginator.js +29 -0
  15. package/dist-cjs/pagination/index.js +2 -0
  16. package/dist-cjs/protocols/Aws_restJson1.js +673 -36
  17. package/dist-es/CleanRooms.js +16 -0
  18. package/dist-es/commands/BatchGetCollaborationAnalysisTemplateCommand.js +43 -0
  19. package/dist-es/commands/CreateAnalysisTemplateCommand.js +43 -0
  20. package/dist-es/commands/DeleteAnalysisTemplateCommand.js +42 -0
  21. package/dist-es/commands/GetAnalysisTemplateCommand.js +43 -0
  22. package/dist-es/commands/GetCollaborationAnalysisTemplateCommand.js +43 -0
  23. package/dist-es/commands/ListAnalysisTemplatesCommand.js +42 -0
  24. package/dist-es/commands/ListCollaborationAnalysisTemplatesCommand.js +42 -0
  25. package/dist-es/commands/UpdateAnalysisTemplateCommand.js +43 -0
  26. package/dist-es/commands/index.js +8 -0
  27. package/dist-es/models/models_0.js +125 -42
  28. package/dist-es/pagination/ListAnalysisTemplatesPaginator.js +25 -0
  29. package/dist-es/pagination/ListCollaborationAnalysisTemplatesPaginator.js +25 -0
  30. package/dist-es/pagination/index.js +2 -0
  31. package/dist-es/protocols/Aws_restJson1.js +698 -77
  32. package/dist-types/CleanRooms.d.ts +56 -0
  33. package/dist-types/CleanRoomsClient.d.ts +10 -2
  34. package/dist-types/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +126 -0
  35. package/dist-types/commands/BatchGetSchemaCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateAnalysisTemplateCommand.d.ts +137 -0
  37. package/dist-types/commands/CreateConfiguredTableAnalysisRuleCommand.d.ts +18 -2
  38. package/dist-types/commands/CreateConfiguredTableCommand.d.ts +1 -1
  39. package/dist-types/commands/DeleteAnalysisTemplateCommand.d.ts +87 -0
  40. package/dist-types/commands/DeleteConfiguredTableAnalysisRuleCommand.d.ts +1 -1
  41. package/dist-types/commands/GetAnalysisTemplateCommand.d.ts +116 -0
  42. package/dist-types/commands/GetCollaborationAnalysisTemplateCommand.d.ts +115 -0
  43. package/dist-types/commands/GetConfiguredTableAnalysisRuleCommand.d.ts +10 -2
  44. package/dist-types/commands/GetConfiguredTableCommand.d.ts +1 -1
  45. package/dist-types/commands/GetProtectedQueryCommand.d.ts +4 -0
  46. package/dist-types/commands/GetSchemaAnalysisRuleCommand.d.ts +10 -2
  47. package/dist-types/commands/GetSchemaCommand.d.ts +1 -1
  48. package/dist-types/commands/ListAnalysisTemplatesCommand.d.ts +104 -0
  49. package/dist-types/commands/ListCollaborationAnalysisTemplatesCommand.d.ts +103 -0
  50. package/dist-types/commands/ListConfiguredTablesCommand.d.ts +1 -1
  51. package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
  52. package/dist-types/commands/StartProtectedQueryCommand.d.ts +8 -0
  53. package/dist-types/commands/UpdateAnalysisTemplateCommand.d.ts +117 -0
  54. package/dist-types/commands/UpdateConfiguredTableAnalysisRuleCommand.d.ts +18 -2
  55. package/dist-types/commands/UpdateConfiguredTableCommand.d.ts +1 -1
  56. package/dist-types/commands/UpdateProtectedQueryCommand.d.ts +4 -0
  57. package/dist-types/commands/index.d.ts +8 -0
  58. package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
  59. package/dist-types/index.d.ts +1 -0
  60. package/dist-types/models/models_0.d.ts +793 -166
  61. package/dist-types/pagination/ListAnalysisTemplatesPaginator.d.ts +7 -0
  62. package/dist-types/pagination/ListCollaborationAnalysisTemplatesPaginator.d.ts +7 -0
  63. package/dist-types/pagination/index.d.ts +2 -0
  64. package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
  65. package/dist-types/runtimeConfig.browser.d.ts +3 -1
  66. package/dist-types/ts3.4/CleanRooms.d.ts +148 -0
  67. package/dist-types/ts3.4/CleanRoomsClient.d.ts +48 -0
  68. package/dist-types/ts3.4/commands/BatchGetCollaborationAnalysisTemplateCommand.d.ts +42 -0
  69. package/dist-types/ts3.4/commands/CreateAnalysisTemplateCommand.d.ts +42 -0
  70. package/dist-types/ts3.4/commands/DeleteAnalysisTemplateCommand.d.ts +42 -0
  71. package/dist-types/ts3.4/commands/GetAnalysisTemplateCommand.d.ts +39 -0
  72. package/dist-types/ts3.4/commands/GetCollaborationAnalysisTemplateCommand.d.ts +42 -0
  73. package/dist-types/ts3.4/commands/ListAnalysisTemplatesCommand.d.ts +42 -0
  74. package/dist-types/ts3.4/commands/ListCollaborationAnalysisTemplatesCommand.d.ts +42 -0
  75. package/dist-types/ts3.4/commands/UpdateAnalysisTemplateCommand.d.ts +42 -0
  76. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  77. package/dist-types/ts3.4/index.d.ts +1 -0
  78. package/dist-types/ts3.4/models/models_0.d.ts +294 -58
  79. package/dist-types/ts3.4/pagination/ListAnalysisTemplatesPaginator.d.ts +11 -0
  80. package/dist-types/ts3.4/pagination/ListCollaborationAnalysisTemplatesPaginator.d.ts +11 -0
  81. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  82. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
  83. package/package.json +6 -6
@@ -88,6 +88,17 @@ export interface AggregationConstraint {
88
88
  */
89
89
  type: AggregationType | string | undefined;
90
90
  }
91
+ /**
92
+ * @public
93
+ * @enum
94
+ */
95
+ export declare const AnalysisFormat: {
96
+ readonly SQL: "SQL";
97
+ };
98
+ /**
99
+ * @public
100
+ */
101
+ export type AnalysisFormat = (typeof AnalysisFormat)[keyof typeof AnalysisFormat];
91
102
  /**
92
103
  * @public
93
104
  * @enum
@@ -99,6 +110,52 @@ export declare const AnalysisMethod: {
99
110
  * @public
100
111
  */
101
112
  export type AnalysisMethod = (typeof AnalysisMethod)[keyof typeof AnalysisMethod];
113
+ /**
114
+ * @public
115
+ * @enum
116
+ */
117
+ export declare const ParameterType: {
118
+ readonly BIGINT: "BIGINT";
119
+ readonly BOOLEAN: "BOOLEAN";
120
+ readonly CHAR: "CHAR";
121
+ readonly DATE: "DATE";
122
+ readonly DECIMAL: "DECIMAL";
123
+ readonly DOUBLE_PRECISION: "DOUBLE_PRECISION";
124
+ readonly INTEGER: "INTEGER";
125
+ readonly REAL: "REAL";
126
+ readonly SMALLINT: "SMALLINT";
127
+ readonly TIME: "TIME";
128
+ readonly TIMESTAMP: "TIMESTAMP";
129
+ readonly TIMESTAMPTZ: "TIMESTAMPTZ";
130
+ readonly TIMETZ: "TIMETZ";
131
+ readonly VARBYTE: "VARBYTE";
132
+ readonly VARCHAR: "VARCHAR";
133
+ };
134
+ /**
135
+ * @public
136
+ */
137
+ export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
138
+ /**
139
+ * @public
140
+ * <p>Optional. The member who can query can provide this placeholder for a literal data value
141
+ * in an analysis template.</p>
142
+ */
143
+ export interface AnalysisParameter {
144
+ /**
145
+ * <p>The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)
146
+ * characters but cannot start or end with a hyphen.</p>
147
+ */
148
+ name: string | undefined;
149
+ /**
150
+ * <p>The type of parameter.</p>
151
+ */
152
+ type: ParameterType | string | undefined;
153
+ /**
154
+ * <p>Optional. The default value that is applied in the analysis template. The member who can
155
+ * query can override this value in the query editor.</p>
156
+ */
157
+ defaultValue?: string;
158
+ }
102
159
  /**
103
160
  * @public
104
161
  * @enum
@@ -147,7 +204,7 @@ export declare const ScalarFunctions: {
147
204
  export type ScalarFunctions = (typeof ScalarFunctions)[keyof typeof ScalarFunctions];
148
205
  /**
149
206
  * @public
150
- * <p>Enables query structure and specified queries that produce aggregate statistics.</p>
207
+ * <p>A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.</p>
151
208
  */
152
209
  export interface AnalysisRuleAggregation {
153
210
  /**
@@ -182,6 +239,21 @@ export interface AnalysisRuleAggregation {
182
239
  */
183
240
  outputConstraints: AggregationConstraint[] | undefined;
184
241
  }
242
+ /**
243
+ * @public
244
+ * <p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.</p>
245
+ */
246
+ export interface AnalysisRuleCustom {
247
+ /**
248
+ * <p>The analysis templates that are allowed by the custom analysis rule.</p>
249
+ */
250
+ allowedAnalyses: string[] | undefined;
251
+ /**
252
+ * <p>The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when
253
+ * <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>
254
+ */
255
+ allowedAnalysisProviders?: string[];
256
+ }
185
257
  /**
186
258
  * @public
187
259
  * <p>A type of analysis rule that enables row-level analysis.</p>
@@ -192,7 +264,7 @@ export interface AnalysisRuleList {
192
264
  */
193
265
  joinColumns: string[] | undefined;
194
266
  /**
195
- * <p>Which logical operators (if any) are to be used in an INNER JOIN match condition.
267
+ * <p>The logical operators (if any) that are to be used in an INNER JOIN match condition.
196
268
  * Default is <code>AND</code>.</p>
197
269
  */
198
270
  allowedJoinOperators?: (JoinOperator | string)[];
@@ -203,9 +275,9 @@ export interface AnalysisRuleList {
203
275
  }
204
276
  /**
205
277
  * @public
206
- * <p>Controls on the query specifications that can be run on configured table..</p>
278
+ * <p>Controls on the query specifications that can be run on configured table.</p>
207
279
  */
208
- export type AnalysisRulePolicyV1 = AnalysisRulePolicyV1.AggregationMember | AnalysisRulePolicyV1.ListMember | AnalysisRulePolicyV1.$UnknownMember;
280
+ export type AnalysisRulePolicyV1 = AnalysisRulePolicyV1.AggregationMember | AnalysisRulePolicyV1.CustomMember | AnalysisRulePolicyV1.ListMember | AnalysisRulePolicyV1.$UnknownMember;
209
281
  /**
210
282
  * @public
211
283
  */
@@ -216,6 +288,7 @@ export declare namespace AnalysisRulePolicyV1 {
216
288
  interface ListMember {
217
289
  list: AnalysisRuleList;
218
290
  aggregation?: never;
291
+ custom?: never;
219
292
  $unknown?: never;
220
293
  }
221
294
  /**
@@ -224,23 +297,35 @@ export declare namespace AnalysisRulePolicyV1 {
224
297
  interface AggregationMember {
225
298
  list?: never;
226
299
  aggregation: AnalysisRuleAggregation;
300
+ custom?: never;
301
+ $unknown?: never;
302
+ }
303
+ /**
304
+ * <p>Analysis rule type that enables custom SQL queries on a configured table.</p>
305
+ */
306
+ interface CustomMember {
307
+ list?: never;
308
+ aggregation?: never;
309
+ custom: AnalysisRuleCustom;
227
310
  $unknown?: never;
228
311
  }
229
312
  interface $UnknownMember {
230
313
  list?: never;
231
314
  aggregation?: never;
315
+ custom?: never;
232
316
  $unknown: [string, any];
233
317
  }
234
318
  interface Visitor<T> {
235
319
  list: (value: AnalysisRuleList) => T;
236
320
  aggregation: (value: AnalysisRuleAggregation) => T;
321
+ custom: (value: AnalysisRuleCustom) => T;
237
322
  _: (name: string, value: any) => T;
238
323
  }
239
324
  const visit: <T>(value: AnalysisRulePolicyV1, visitor: Visitor<T>) => T;
240
325
  }
241
326
  /**
242
327
  * @public
243
- * <p>Controls on the query specifications that can be run on configured table..</p>
328
+ * <p>Controls on the query specifications that can be run on configured table.</p>
244
329
  */
245
330
  export type AnalysisRulePolicy = AnalysisRulePolicy.V1Member | AnalysisRulePolicy.$UnknownMember;
246
331
  /**
@@ -248,7 +333,7 @@ export type AnalysisRulePolicy = AnalysisRulePolicy.V1Member | AnalysisRulePolic
248
333
  */
249
334
  export declare namespace AnalysisRulePolicy {
250
335
  /**
251
- * <p>Controls on the query specifications that can be run on configured table..</p>
336
+ * <p>Controls on the query specifications that can be run on configured table.</p>
252
337
  */
253
338
  interface V1Member {
254
339
  v1: AnalysisRulePolicyV1;
@@ -270,6 +355,7 @@ export declare namespace AnalysisRulePolicy {
270
355
  */
271
356
  export declare const AnalysisRuleType: {
272
357
  readonly AGGREGATION: "AGGREGATION";
358
+ readonly CUSTOM: "CUSTOM";
273
359
  readonly LIST: "LIST";
274
360
  };
275
361
  /**
@@ -286,7 +372,7 @@ export interface AnalysisRule {
286
372
  */
287
373
  collaborationId: string | undefined;
288
374
  /**
289
- * <p>The type of analysis rule. Valid values are `AGGREGATION` and `LIST`.</p>
375
+ * <p>The type of analysis rule.</p>
290
376
  */
291
377
  type: AnalysisRuleType | string | undefined;
292
378
  /**
@@ -308,130 +394,195 @@ export interface AnalysisRule {
308
394
  }
309
395
  /**
310
396
  * @public
397
+ * <p>A relation within an analysis.</p>
311
398
  */
312
- export interface BatchGetSchemaInput {
399
+ export interface AnalysisSchema {
313
400
  /**
314
- * <p>A unique identifier for the collaboration that the schemas belong to. Currently accepts
315
- * collaboration ID.</p>
401
+ * <p>The tables referenced in the analysis schema.</p>
316
402
  */
317
- collaborationIdentifier: string | undefined;
403
+ referencedTables?: string[];
404
+ }
405
+ /**
406
+ * @public
407
+ * <p>The structure that defines the body of the analysis template.</p>
408
+ */
409
+ export type AnalysisSource = AnalysisSource.TextMember | AnalysisSource.$UnknownMember;
410
+ /**
411
+ * @public
412
+ */
413
+ export declare namespace AnalysisSource {
318
414
  /**
319
- * <p>The names for the schema objects to retrieve.&gt;</p>
415
+ * <p>The query text.</p>
320
416
  */
321
- names: string[] | undefined;
417
+ interface TextMember {
418
+ text: string;
419
+ $unknown?: never;
420
+ }
421
+ interface $UnknownMember {
422
+ text?: never;
423
+ $unknown: [string, any];
424
+ }
425
+ interface Visitor<T> {
426
+ text: (value: string) => T;
427
+ _: (name: string, value: any) => T;
428
+ }
429
+ const visit: <T>(value: AnalysisSource, visitor: Visitor<T>) => T;
322
430
  }
323
431
  /**
324
432
  * @public
325
- * <p>An error describing why a schema could not be fetched.</p>
433
+ * <p>The analysis template.</p>
326
434
  */
327
- export interface BatchGetSchemaError {
435
+ export interface AnalysisTemplate {
328
436
  /**
329
- * <p>An error name for the error.</p>
437
+ * <p>The identifier for the analysis template.</p>
330
438
  */
331
- name: string | undefined;
439
+ id: string | undefined;
332
440
  /**
333
- * <p>An error code for the error. </p>
441
+ * <p>The Amazon Resource Name (ARN) of the analysis template.</p>
334
442
  */
335
- code: string | undefined;
443
+ arn: string | undefined;
336
444
  /**
337
- * <p>An error message for the error.</p>
445
+ * <p>The unique ID for the associated collaboration of the analysis template.</p>
338
446
  */
339
- message: string | undefined;
340
- }
341
- /**
342
- * @public
343
- * <p>A column within a schema relation, derived from the underlying Glue table.</p>
344
- */
345
- export interface Column {
447
+ collaborationId: string | undefined;
346
448
  /**
347
- * <p>The name of the column.</p>
449
+ * <p>The unique ARN for the analysis template’s associated collaboration.</p>
450
+ */
451
+ collaborationArn: string | undefined;
452
+ /**
453
+ * <p>The identifier of a member who created the analysis template.</p>
454
+ */
455
+ membershipId: string | undefined;
456
+ /**
457
+ * <p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>
458
+ */
459
+ membershipArn: string | undefined;
460
+ /**
461
+ * <p>The description of the analysis template.</p>
462
+ */
463
+ description?: string;
464
+ /**
465
+ * <p>The name of the analysis template.</p>
348
466
  */
349
467
  name: string | undefined;
350
468
  /**
351
- * <p>The type of the column.</p>
469
+ * <p>The time that the analysis template was created.</p>
352
470
  */
353
- type: string | undefined;
471
+ createTime: Date | undefined;
472
+ /**
473
+ * <p>The time that the analysis template was last updated.</p>
474
+ */
475
+ updateTime: Date | undefined;
476
+ /**
477
+ * <p>The entire schema object.</p>
478
+ */
479
+ schema: AnalysisSchema | undefined;
480
+ /**
481
+ * <p>The format of the analysis template.</p>
482
+ */
483
+ format: AnalysisFormat | string | undefined;
484
+ /**
485
+ * <p>The source of the analysis template.</p>
486
+ */
487
+ source: AnalysisSource | undefined;
488
+ /**
489
+ * <p>The parameters of the analysis template.</p>
490
+ */
491
+ analysisParameters?: AnalysisParameter[];
354
492
  }
355
493
  /**
356
494
  * @public
357
495
  * @enum
358
496
  */
359
- export declare const SchemaType: {
360
- readonly TABLE: "TABLE";
497
+ export declare const ConflictExceptionReason: {
498
+ readonly ALREADY_EXISTS: "ALREADY_EXISTS";
499
+ readonly INVALID_STATE: "INVALID_STATE";
500
+ readonly SUBRESOURCES_EXIST: "SUBRESOURCES_EXIST";
361
501
  };
362
502
  /**
363
503
  * @public
364
504
  */
365
- export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
505
+ export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
366
506
  /**
367
507
  * @public
368
- * <p>A schema is a relation within a collaboration.</p>
508
+ * @enum
369
509
  */
370
- export interface Schema {
371
- /**
372
- * <p>The columns for the relation this schema represents.</p>
373
- */
374
- columns: Column[] | undefined;
510
+ export declare const ResourceType: {
511
+ readonly COLLABORATION: "COLLABORATION";
512
+ readonly CONFIGURED_TABLE: "CONFIGURED_TABLE";
513
+ readonly CONFIGURED_TABLE_ASSOCIATION: "CONFIGURED_TABLE_ASSOCIATION";
514
+ readonly MEMBERSHIP: "MEMBERSHIP";
515
+ };
516
+ /**
517
+ * @public
518
+ */
519
+ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
520
+ /**
521
+ * @public
522
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
523
+ */
524
+ export declare class ConflictException extends __BaseException {
525
+ readonly name: "ConflictException";
526
+ readonly $fault: "client";
375
527
  /**
376
- * <p>The partition keys for the dataset underlying this schema.</p>
528
+ * <p>The ID of the conflicting resource.</p>
377
529
  */
378
- partitionKeys: Column[] | undefined;
530
+ resourceId?: string;
379
531
  /**
380
- * <p>The analysis rule types associated with the schema. Valued values are LIST and
381
- * AGGREGATION. Currently, only one entry is present.</p>
532
+ * <p>The type of the conflicting resource.</p>
382
533
  */
383
- analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
534
+ resourceType?: ResourceType | string;
384
535
  /**
385
- * <p>The analysis method for the schema. The only valid value is currently
386
- * DIRECT_QUERY.</p>
536
+ * <p>A reason code for the exception.</p>
387
537
  */
388
- analysisMethod?: AnalysisMethod | string;
538
+ reason?: ConflictExceptionReason | string;
389
539
  /**
390
- * <p>The unique account ID for the Amazon Web Services account that owns the schema.</p>
540
+ * @internal
391
541
  */
392
- creatorAccountId: string | undefined;
542
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
543
+ }
544
+ /**
545
+ * @public
546
+ */
547
+ export interface CreateAnalysisTemplateInput {
393
548
  /**
394
- * <p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>
549
+ * <p>The description of the analysis template.</p>
395
550
  */
396
- name: string | undefined;
551
+ description?: string;
397
552
  /**
398
- * <p>The unique ID for the collaboration that the schema belongs to.</p>
553
+ * <p>The identifier for a membership resource.</p>
399
554
  */
400
- collaborationId: string | undefined;
555
+ membershipIdentifier: string | undefined;
401
556
  /**
402
- * <p>The unique ARN for the collaboration that the schema belongs to.</p>
557
+ * <p>The name of the analysis template.</p>
403
558
  */
404
- collaborationArn: string | undefined;
559
+ name: string | undefined;
405
560
  /**
406
- * <p>A description for the schema.</p>
561
+ * <p>The format of the analysis template.</p>
407
562
  */
408
- description: string | undefined;
563
+ format: AnalysisFormat | string | undefined;
409
564
  /**
410
- * <p>The time the schema was created.</p>
565
+ * <p>The information in the analysis template. Currently supports <code>text</code>, the
566
+ * query text for the analysis template.</p>
411
567
  */
412
- createTime: Date | undefined;
568
+ source: AnalysisSource | undefined;
413
569
  /**
414
- * <p>The time the schema was last updated.</p>
570
+ * <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>
415
571
  */
416
- updateTime: Date | undefined;
572
+ tags?: Record<string, string>;
417
573
  /**
418
- * <p>The type of schema. The only valid value is currently `TABLE`.</p>
574
+ * <p>The parameters of the analysis template.</p>
419
575
  */
420
- type: SchemaType | string | undefined;
576
+ analysisParameters?: AnalysisParameter[];
421
577
  }
422
578
  /**
423
579
  * @public
424
580
  */
425
- export interface BatchGetSchemaOutput {
581
+ export interface CreateAnalysisTemplateOutput {
426
582
  /**
427
- * <p>The retrieved list of schemas.</p>
583
+ * <p>The analysis template.</p>
428
584
  */
429
- schemas: Schema[] | undefined;
430
- /**
431
- * <p>Error reasons for schemas that could not be retrieved. One error is returned for every
432
- * schema that could not be retrieved.</p>
433
- */
434
- errors: BatchGetSchemaError[] | undefined;
585
+ analysisTemplate: AnalysisTemplate | undefined;
435
586
  }
436
587
  /**
437
588
  * @public
@@ -445,20 +596,6 @@ export declare class InternalServerException extends __BaseException {
445
596
  */
446
597
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
447
598
  }
448
- /**
449
- * @public
450
- * @enum
451
- */
452
- export declare const ResourceType: {
453
- readonly COLLABORATION: "COLLABORATION";
454
- readonly CONFIGURED_TABLE: "CONFIGURED_TABLE";
455
- readonly CONFIGURED_TABLE_ASSOCIATION: "CONFIGURED_TABLE_ASSOCIATION";
456
- readonly MEMBERSHIP: "MEMBERSHIP";
457
- };
458
- /**
459
- * @public
460
- */
461
- export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
462
599
  /**
463
600
  * @public
464
601
  * <p>Request references a resource which does not exist.</p>
@@ -479,6 +616,26 @@ export declare class ResourceNotFoundException extends __BaseException {
479
616
  */
480
617
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
481
618
  }
619
+ /**
620
+ * @public
621
+ * <p>Request denied because service quota has been exceeded.</p>
622
+ */
623
+ export declare class ServiceQuotaExceededException extends __BaseException {
624
+ readonly name: "ServiceQuotaExceededException";
625
+ readonly $fault: "client";
626
+ /**
627
+ * <p>The name of the quota.</p>
628
+ */
629
+ quotaName: string | undefined;
630
+ /**
631
+ * <p>The value of the quota.</p>
632
+ */
633
+ quotaValue: number | undefined;
634
+ /**
635
+ * @internal
636
+ */
637
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
638
+ }
482
639
  /**
483
640
  * @public
484
641
  * <p>Request was denied due to request throttling.</p>
@@ -493,50 +650,421 @@ export declare class ThrottlingException extends __BaseException {
493
650
  }
494
651
  /**
495
652
  * @public
496
- * <p>Describes validation errors for specific input parameters.</p>
653
+ * <p>Describes validation errors for specific input parameters.</p>
654
+ */
655
+ export interface ValidationExceptionField {
656
+ /**
657
+ * <p>The name of the input parameter.</p>
658
+ */
659
+ name: string | undefined;
660
+ /**
661
+ * <p>A message for the input validation error.</p>
662
+ */
663
+ message: string | undefined;
664
+ }
665
+ /**
666
+ * @public
667
+ * @enum
668
+ */
669
+ export declare const ValidationExceptionReason: {
670
+ readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
671
+ readonly IAM_SYNCHRONIZATION_DELAY: "IAM_SYNCHRONIZATION_DELAY";
672
+ readonly INVALID_CONFIGURATION: "INVALID_CONFIGURATION";
673
+ readonly INVALID_QUERY: "INVALID_QUERY";
674
+ };
675
+ /**
676
+ * @public
677
+ */
678
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
679
+ /**
680
+ * @public
681
+ * <p>The input fails to satisfy the specified constraints.</p>
682
+ */
683
+ export declare class ValidationException extends __BaseException {
684
+ readonly name: "ValidationException";
685
+ readonly $fault: "client";
686
+ /**
687
+ * <p>A reason code for the exception.</p>
688
+ */
689
+ reason?: ValidationExceptionReason | string;
690
+ /**
691
+ * <p>Validation errors for specific input parameters.</p>
692
+ */
693
+ fieldList?: ValidationExceptionField[];
694
+ /**
695
+ * @internal
696
+ */
697
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
698
+ }
699
+ /**
700
+ * @public
701
+ */
702
+ export interface DeleteAnalysisTemplateInput {
703
+ /**
704
+ * <p>The identifier for a membership resource.</p>
705
+ */
706
+ membershipIdentifier: string | undefined;
707
+ /**
708
+ * <p>The identifier for the analysis template resource.</p>
709
+ */
710
+ analysisTemplateIdentifier: string | undefined;
711
+ }
712
+ /**
713
+ * @public
714
+ */
715
+ export interface DeleteAnalysisTemplateOutput {
716
+ }
717
+ /**
718
+ * @public
719
+ */
720
+ export interface GetAnalysisTemplateInput {
721
+ /**
722
+ * <p>The identifier for a membership resource.</p>
723
+ */
724
+ membershipIdentifier: string | undefined;
725
+ /**
726
+ * <p>The identifier for the analysis template resource.</p>
727
+ */
728
+ analysisTemplateIdentifier: string | undefined;
729
+ }
730
+ /**
731
+ * @public
732
+ */
733
+ export interface GetAnalysisTemplateOutput {
734
+ /**
735
+ * <p>The analysis template.</p>
736
+ */
737
+ analysisTemplate: AnalysisTemplate | undefined;
738
+ }
739
+ /**
740
+ * @public
741
+ */
742
+ export interface ListAnalysisTemplatesInput {
743
+ /**
744
+ * <p>The identifier for a membership resource.</p>
745
+ */
746
+ membershipIdentifier: string | undefined;
747
+ /**
748
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
749
+ */
750
+ nextToken?: string;
751
+ /**
752
+ * <p>The maximum size of the results that is returned per call.</p>
753
+ */
754
+ maxResults?: number;
755
+ }
756
+ /**
757
+ * @public
758
+ * <p>The metadata of the analysis template.</p>
759
+ */
760
+ export interface AnalysisTemplateSummary {
761
+ /**
762
+ * <p>The Amazon Resource Name (ARN) of the analysis template.</p>
763
+ */
764
+ arn: string | undefined;
765
+ /**
766
+ * <p>The time that the analysis template summary was created.</p>
767
+ */
768
+ createTime: Date | undefined;
769
+ /**
770
+ * <p>The identifier of the analysis template.</p>
771
+ */
772
+ id: string | undefined;
773
+ /**
774
+ * <p>The name of the analysis template. </p>
775
+ */
776
+ name: string | undefined;
777
+ /**
778
+ * <p>The time that the analysis template summary was last updated.</p>
779
+ */
780
+ updateTime: Date | undefined;
781
+ /**
782
+ * <p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>
783
+ */
784
+ membershipArn: string | undefined;
785
+ /**
786
+ * <p>The identifier for a membership resource.</p>
787
+ */
788
+ membershipId: string | undefined;
789
+ /**
790
+ * <p>The unique ARN for the analysis template summary’s associated collaboration.</p>
791
+ */
792
+ collaborationArn: string | undefined;
793
+ /**
794
+ * <p>A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.</p>
795
+ */
796
+ collaborationId: string | undefined;
797
+ /**
798
+ * <p>The description of the analysis template.</p>
799
+ */
800
+ description?: string;
801
+ }
802
+ /**
803
+ * @public
804
+ */
805
+ export interface ListAnalysisTemplatesOutput {
806
+ /**
807
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
808
+ */
809
+ nextToken?: string;
810
+ /**
811
+ * <p>Lists analysis template metadata.</p>
812
+ */
813
+ analysisTemplateSummaries: AnalysisTemplateSummary[] | undefined;
814
+ }
815
+ /**
816
+ * @public
817
+ */
818
+ export interface UpdateAnalysisTemplateInput {
819
+ /**
820
+ * <p>The identifier for a membership resource.</p>
821
+ */
822
+ membershipIdentifier: string | undefined;
823
+ /**
824
+ * <p>The identifier for the analysis template resource.</p>
825
+ */
826
+ analysisTemplateIdentifier: string | undefined;
827
+ /**
828
+ * <p>A new description for the analysis template.</p>
829
+ */
830
+ description?: string;
831
+ }
832
+ /**
833
+ * @public
834
+ */
835
+ export interface UpdateAnalysisTemplateOutput {
836
+ /**
837
+ * <p>The analysis template.</p>
838
+ */
839
+ analysisTemplate: AnalysisTemplate | undefined;
840
+ }
841
+ /**
842
+ * @public
843
+ */
844
+ export interface BatchGetCollaborationAnalysisTemplateInput {
845
+ /**
846
+ * <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
847
+ */
848
+ collaborationIdentifier: string | undefined;
849
+ /**
850
+ * <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
851
+ */
852
+ analysisTemplateArns: string[] | undefined;
853
+ }
854
+ /**
855
+ * @public
856
+ * <p>The analysis template within a collaboration.</p>
857
+ */
858
+ export interface CollaborationAnalysisTemplate {
859
+ /**
860
+ * <p>The identifier of the analysis template.</p>
861
+ */
862
+ id: string | undefined;
863
+ /**
864
+ * <p>The Amazon Resource Name (ARN) of the analysis template.</p>
865
+ */
866
+ arn: string | undefined;
867
+ /**
868
+ * <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
869
+ */
870
+ collaborationId: string | undefined;
871
+ /**
872
+ * <p>The unique ARN for the analysis template’s associated collaboration.</p>
873
+ */
874
+ collaborationArn: string | undefined;
875
+ /**
876
+ * <p>The description of the analysis template.</p>
877
+ */
878
+ description?: string;
879
+ /**
880
+ * <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
881
+ */
882
+ creatorAccountId: string | undefined;
883
+ /**
884
+ * <p>The name of the analysis template.</p>
885
+ */
886
+ name: string | undefined;
887
+ /**
888
+ * <p>The time that the analysis template within a collaboration was created.</p>
889
+ */
890
+ createTime: Date | undefined;
891
+ /**
892
+ * <p>The time that the analysis template in the collaboration was last updated.</p>
893
+ */
894
+ updateTime: Date | undefined;
895
+ /**
896
+ * <p>The entire schema object.</p>
897
+ */
898
+ schema: AnalysisSchema | undefined;
899
+ /**
900
+ * <p>The format of the analysis template in the collaboration.</p>
901
+ */
902
+ format: AnalysisFormat | string | undefined;
903
+ /**
904
+ * <p>The source of the analysis template within a collaboration.</p>
905
+ */
906
+ source: AnalysisSource | undefined;
907
+ /**
908
+ * <p>The analysis parameters that have been specified in the analysis template.</p>
909
+ */
910
+ analysisParameters?: AnalysisParameter[];
911
+ }
912
+ /**
913
+ * @public
914
+ * <p>Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.</p>
915
+ */
916
+ export interface BatchGetCollaborationAnalysisTemplateError {
917
+ /**
918
+ * <p>The Amazon Resource Name (ARN) of the analysis template.</p>
919
+ */
920
+ arn: string | undefined;
921
+ /**
922
+ * <p>An error code for the error.</p>
923
+ */
924
+ code: string | undefined;
925
+ /**
926
+ * <p>A description of why the call failed.</p>
927
+ */
928
+ message: string | undefined;
929
+ }
930
+ /**
931
+ * @public
932
+ */
933
+ export interface BatchGetCollaborationAnalysisTemplateOutput {
934
+ /**
935
+ * <p>The retrieved list of analysis templates within a collaboration.</p>
936
+ */
937
+ collaborationAnalysisTemplates: CollaborationAnalysisTemplate[] | undefined;
938
+ /**
939
+ * <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
+ */
941
+ errors: BatchGetCollaborationAnalysisTemplateError[] | undefined;
942
+ }
943
+ /**
944
+ * @public
945
+ */
946
+ export interface BatchGetSchemaInput {
947
+ /**
948
+ * <p>A unique identifier for the collaboration that the schemas belong to. Currently accepts
949
+ * collaboration ID.</p>
950
+ */
951
+ collaborationIdentifier: string | undefined;
952
+ /**
953
+ * <p>The names for the schema objects to retrieve.&gt;</p>
954
+ */
955
+ names: string[] | undefined;
956
+ }
957
+ /**
958
+ * @public
959
+ * <p>An error describing why a schema could not be fetched.</p>
960
+ */
961
+ export interface BatchGetSchemaError {
962
+ /**
963
+ * <p>An error name for the error.</p>
964
+ */
965
+ name: string | undefined;
966
+ /**
967
+ * <p>An error code for the error. </p>
968
+ */
969
+ code: string | undefined;
970
+ /**
971
+ * <p>An error message for the error.</p>
972
+ */
973
+ message: string | undefined;
974
+ }
975
+ /**
976
+ * @public
977
+ * <p>A column within a schema relation, derived from the underlying Glue table.</p>
497
978
  */
498
- export interface ValidationExceptionField {
979
+ export interface Column {
499
980
  /**
500
- * <p>The name of the input parameter.</p>
981
+ * <p>The name of the column.</p>
501
982
  */
502
983
  name: string | undefined;
503
984
  /**
504
- * <p>A message for the input validation error.</p>
985
+ * <p>The type of the column.</p>
505
986
  */
506
- message: string | undefined;
987
+ type: string | undefined;
507
988
  }
508
989
  /**
509
990
  * @public
510
991
  * @enum
511
992
  */
512
- export declare const ValidationExceptionReason: {
513
- readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
514
- readonly INVALID_CONFIGURATION: "INVALID_CONFIGURATION";
515
- readonly INVALID_QUERY: "INVALID_QUERY";
993
+ export declare const SchemaType: {
994
+ readonly TABLE: "TABLE";
516
995
  };
517
996
  /**
518
997
  * @public
519
998
  */
520
- export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
999
+ export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
521
1000
  /**
522
1001
  * @public
523
- * <p>The input fails to satisfy the specified constraints.</p>
1002
+ * <p>A schema is a relation within a collaboration.</p>
524
1003
  */
525
- export declare class ValidationException extends __BaseException {
526
- readonly name: "ValidationException";
527
- readonly $fault: "client";
1004
+ export interface Schema {
528
1005
  /**
529
- * <p>A reason code for the exception.</p>
1006
+ * <p>The columns for the relation this schema represents.</p>
530
1007
  */
531
- reason?: ValidationExceptionReason | string;
1008
+ columns: Column[] | undefined;
532
1009
  /**
533
- * <p>Validation errors for specific input parameters.</p>
1010
+ * <p>The partition keys for the dataset underlying this schema.</p>
534
1011
  */
535
- fieldList?: ValidationExceptionField[];
1012
+ partitionKeys: Column[] | undefined;
536
1013
  /**
537
- * @internal
1014
+ * <p>The analysis rule types associated with the schema. Currently, only one entry is present.</p>
538
1015
  */
539
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
1016
+ analysisRuleTypes: (AnalysisRuleType | string)[] | undefined;
1017
+ /**
1018
+ * <p>The analysis method for the schema. The only valid value is currently
1019
+ * DIRECT_QUERY.</p>
1020
+ */
1021
+ analysisMethod?: AnalysisMethod | string;
1022
+ /**
1023
+ * <p>The unique account ID for the Amazon Web Services account that owns the schema.</p>
1024
+ */
1025
+ creatorAccountId: string | undefined;
1026
+ /**
1027
+ * <p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>
1028
+ */
1029
+ name: string | undefined;
1030
+ /**
1031
+ * <p>The unique ID for the collaboration that the schema belongs to.</p>
1032
+ */
1033
+ collaborationId: string | undefined;
1034
+ /**
1035
+ * <p>The unique ARN for the collaboration that the schema belongs to.</p>
1036
+ */
1037
+ collaborationArn: string | undefined;
1038
+ /**
1039
+ * <p>A description for the schema.</p>
1040
+ */
1041
+ description: string | undefined;
1042
+ /**
1043
+ * <p>The time the schema was created.</p>
1044
+ */
1045
+ createTime: Date | undefined;
1046
+ /**
1047
+ * <p>The time the schema was last updated.</p>
1048
+ */
1049
+ updateTime: Date | undefined;
1050
+ /**
1051
+ * <p>The type of schema. The only valid value is currently `TABLE`.</p>
1052
+ */
1053
+ type: SchemaType | string | undefined;
1054
+ }
1055
+ /**
1056
+ * @public
1057
+ */
1058
+ export interface BatchGetSchemaOutput {
1059
+ /**
1060
+ * <p>The retrieved list of schemas.</p>
1061
+ */
1062
+ schemas: Schema[] | undefined;
1063
+ /**
1064
+ * <p>Error reasons for schemas that could not be retrieved. One error is returned for every
1065
+ * schema that could not be retrieved.</p>
1066
+ */
1067
+ errors: BatchGetSchemaError[] | undefined;
540
1068
  }
541
1069
  /**
542
1070
  * @public
@@ -725,26 +1253,6 @@ export interface CreateCollaborationOutput {
725
1253
  */
726
1254
  collaboration: Collaboration | undefined;
727
1255
  }
728
- /**
729
- * @public
730
- * <p>Request denied because service quota has been exceeded.</p>
731
- */
732
- export declare class ServiceQuotaExceededException extends __BaseException {
733
- readonly name: "ServiceQuotaExceededException";
734
- readonly $fault: "client";
735
- /**
736
- * <p>The name of the quota.</p>
737
- */
738
- quotaName: string | undefined;
739
- /**
740
- * <p>The value of the quota.</p>
741
- */
742
- quotaValue: number | undefined;
743
- /**
744
- * @internal
745
- */
746
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
747
- }
748
1256
  /**
749
1257
  * @public
750
1258
  */
@@ -759,43 +1267,6 @@ export interface DeleteCollaborationInput {
759
1267
  */
760
1268
  export interface DeleteCollaborationOutput {
761
1269
  }
762
- /**
763
- * @public
764
- * @enum
765
- */
766
- export declare const ConflictExceptionReason: {
767
- readonly ALREADY_EXISTS: "ALREADY_EXISTS";
768
- readonly INVALID_STATE: "INVALID_STATE";
769
- readonly SUBRESOURCES_EXIST: "SUBRESOURCES_EXIST";
770
- };
771
- /**
772
- * @public
773
- */
774
- export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
775
- /**
776
- * @public
777
- * <p>Updating or deleting a resource can cause an inconsistent state.</p>
778
- */
779
- export declare class ConflictException extends __BaseException {
780
- readonly name: "ConflictException";
781
- readonly $fault: "client";
782
- /**
783
- * <p>The ID of the conflicting resource.</p>
784
- */
785
- resourceId?: string;
786
- /**
787
- * <p>The type of the conflicting resource.</p>
788
- */
789
- resourceType?: ResourceType | string;
790
- /**
791
- * <p>A reason code for the exception.</p>
792
- */
793
- reason?: ConflictExceptionReason | string;
794
- /**
795
- * @internal
796
- */
797
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
798
- }
799
1270
  /**
800
1271
  * @public
801
1272
  */
@@ -832,6 +1303,28 @@ export interface GetCollaborationOutput {
832
1303
  */
833
1304
  collaboration: Collaboration | undefined;
834
1305
  }
1306
+ /**
1307
+ * @public
1308
+ */
1309
+ export interface GetCollaborationAnalysisTemplateInput {
1310
+ /**
1311
+ * <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
1312
+ */
1313
+ collaborationIdentifier: string | undefined;
1314
+ /**
1315
+ * <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
1316
+ */
1317
+ analysisTemplateArn: string | undefined;
1318
+ }
1319
+ /**
1320
+ * @public
1321
+ */
1322
+ export interface GetCollaborationAnalysisTemplateOutput {
1323
+ /**
1324
+ * <p>The analysis template within a collaboration.</p>
1325
+ */
1326
+ collaborationAnalysisTemplate: CollaborationAnalysisTemplate | undefined;
1327
+ }
835
1328
  /**
836
1329
  * @public
837
1330
  */
@@ -882,6 +1375,78 @@ export interface GetSchemaAnalysisRuleOutput {
882
1375
  */
883
1376
  analysisRule: AnalysisRule | undefined;
884
1377
  }
1378
+ /**
1379
+ * @public
1380
+ */
1381
+ export interface ListCollaborationAnalysisTemplatesInput {
1382
+ /**
1383
+ * <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
1384
+ */
1385
+ collaborationIdentifier: string | undefined;
1386
+ /**
1387
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1388
+ */
1389
+ nextToken?: string;
1390
+ /**
1391
+ * <p>The maximum size of the results that is returned per call.</p>
1392
+ */
1393
+ maxResults?: number;
1394
+ }
1395
+ /**
1396
+ * @public
1397
+ * <p>The metadata of the analysis template within a collaboration.</p>
1398
+ */
1399
+ export interface CollaborationAnalysisTemplateSummary {
1400
+ /**
1401
+ * <p>The Amazon Resource Name (ARN) of the analysis template.</p>
1402
+ */
1403
+ arn: string | undefined;
1404
+ /**
1405
+ * <p>The time that the summary of the analysis template in a collaboration was created.</p>
1406
+ */
1407
+ createTime: Date | undefined;
1408
+ /**
1409
+ * <p>The identifier of the analysis template.</p>
1410
+ */
1411
+ id: string | undefined;
1412
+ /**
1413
+ * <p>The name of the analysis template.</p>
1414
+ */
1415
+ name: string | undefined;
1416
+ /**
1417
+ * <p>The time that the summary of the analysis template in the collaboration was last updated.</p>
1418
+ */
1419
+ updateTime: Date | undefined;
1420
+ /**
1421
+ * <p>The unique ARN for the analysis template’s associated collaboration.</p>
1422
+ */
1423
+ collaborationArn: string | undefined;
1424
+ /**
1425
+ * <p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>
1426
+ */
1427
+ collaborationId: string | undefined;
1428
+ /**
1429
+ * <p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>
1430
+ */
1431
+ creatorAccountId: string | undefined;
1432
+ /**
1433
+ * <p>The description of the analysis template.</p>
1434
+ */
1435
+ description?: string;
1436
+ }
1437
+ /**
1438
+ * @public
1439
+ */
1440
+ export interface ListCollaborationAnalysisTemplatesOutput {
1441
+ /**
1442
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1443
+ */
1444
+ nextToken?: string;
1445
+ /**
1446
+ * <p>The metadata of the analysis template within a collaboration.</p>
1447
+ */
1448
+ collaborationAnalysisTemplateSummaries: CollaborationAnalysisTemplateSummary[] | undefined;
1449
+ }
885
1450
  /**
886
1451
  * @public
887
1452
  * @enum
@@ -1460,6 +2025,7 @@ export interface CreateConfiguredTableInput {
1460
2025
  */
1461
2026
  export declare const ConfiguredTableAnalysisRuleType: {
1462
2027
  readonly AGGREGATION: "AGGREGATION";
2028
+ readonly CUSTOM: "CUSTOM";
1463
2029
  readonly LIST: "LIST";
1464
2030
  };
1465
2031
  /**
@@ -1500,7 +2066,7 @@ export interface ConfiguredTable {
1500
2066
  */
1501
2067
  updateTime: Date | undefined;
1502
2068
  /**
1503
- * <p>The types of analysis rules associated with this configured table. Valid values are `AGGREGATION` and `LIST`. Currently, only one analysis rule may be associated with a configured table.</p>
2069
+ * <p>The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.</p>
1504
2070
  */
1505
2071
  analysisRuleTypes: (ConfiguredTableAnalysisRuleType | string)[] | undefined;
1506
2072
  /**
@@ -1526,7 +2092,7 @@ export interface CreateConfiguredTableOutput {
1526
2092
  * @public
1527
2093
  * <p>Controls on the query specifications that can be run on a configured table.</p>
1528
2094
  */
1529
- export type ConfiguredTableAnalysisRulePolicyV1 = ConfiguredTableAnalysisRulePolicyV1.AggregationMember | ConfiguredTableAnalysisRulePolicyV1.ListMember | ConfiguredTableAnalysisRulePolicyV1.$UnknownMember;
2095
+ export type ConfiguredTableAnalysisRulePolicyV1 = ConfiguredTableAnalysisRulePolicyV1.AggregationMember | ConfiguredTableAnalysisRulePolicyV1.CustomMember | ConfiguredTableAnalysisRulePolicyV1.ListMember | ConfiguredTableAnalysisRulePolicyV1.$UnknownMember;
1530
2096
  /**
1531
2097
  * @public
1532
2098
  */
@@ -1537,6 +2103,7 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
1537
2103
  interface ListMember {
1538
2104
  list: AnalysisRuleList;
1539
2105
  aggregation?: never;
2106
+ custom?: never;
1540
2107
  $unknown?: never;
1541
2108
  }
1542
2109
  /**
@@ -1545,16 +2112,28 @@ export declare namespace ConfiguredTableAnalysisRulePolicyV1 {
1545
2112
  interface AggregationMember {
1546
2113
  list?: never;
1547
2114
  aggregation: AnalysisRuleAggregation;
2115
+ custom?: never;
2116
+ $unknown?: never;
2117
+ }
2118
+ /**
2119
+ * <p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.</p>
2120
+ */
2121
+ interface CustomMember {
2122
+ list?: never;
2123
+ aggregation?: never;
2124
+ custom: AnalysisRuleCustom;
1548
2125
  $unknown?: never;
1549
2126
  }
1550
2127
  interface $UnknownMember {
1551
2128
  list?: never;
1552
2129
  aggregation?: never;
2130
+ custom?: never;
1553
2131
  $unknown: [string, any];
1554
2132
  }
1555
2133
  interface Visitor<T> {
1556
2134
  list: (value: AnalysisRuleList) => T;
1557
2135
  aggregation: (value: AnalysisRuleAggregation) => T;
2136
+ custom: (value: AnalysisRuleCustom) => T;
1558
2137
  _: (name: string, value: any) => T;
1559
2138
  }
1560
2139
  const visit: <T>(value: ConfiguredTableAnalysisRulePolicyV1, visitor: Visitor<T>) => T;
@@ -1594,7 +2173,7 @@ export interface CreateConfiguredTableAnalysisRuleInput {
1594
2173
  */
1595
2174
  configuredTableIdentifier: string | undefined;
1596
2175
  /**
1597
- * <p>The type of analysis rule. Valid values are AGGREGATION and LIST.</p>
2176
+ * <p>The type of analysis rule.</p>
1598
2177
  */
1599
2178
  analysisRuleType: ConfiguredTableAnalysisRuleType | string | undefined;
1600
2179
  /**
@@ -1620,7 +2199,7 @@ export interface ConfiguredTableAnalysisRule {
1620
2199
  */
1621
2200
  policy: ConfiguredTableAnalysisRulePolicy | undefined;
1622
2201
  /**
1623
- * <p>The type of configured table analysis rule. Valid values are `AGGREGATION` and `LIST`.</p>
2202
+ * <p>The type of configured table analysis rule.</p>
1624
2203
  */
1625
2204
  type: ConfiguredTableAnalysisRuleType | string | undefined;
1626
2205
  /**
@@ -2137,6 +2716,14 @@ export interface ProtectedQuerySQLParameters {
2137
2716
  * <p>The query string to be submitted.</p>
2138
2717
  */
2139
2718
  queryString?: string;
2719
+ /**
2720
+ * <p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>
2721
+ */
2722
+ analysisTemplateArn?: string;
2723
+ /**
2724
+ * <p>The protected query SQL parameters.</p>
2725
+ */
2726
+ parameters?: Record<string, string>;
2140
2727
  }
2141
2728
  /**
2142
2729
  * @public
@@ -2499,6 +3086,46 @@ export interface UntagResourceInput {
2499
3086
  */
2500
3087
  export interface UntagResourceOutput {
2501
3088
  }
3089
+ /**
3090
+ * @internal
3091
+ */
3092
+ export declare const AnalysisParameterFilterSensitiveLog: (obj: AnalysisParameter) => any;
3093
+ /**
3094
+ * @internal
3095
+ */
3096
+ export declare const AnalysisSourceFilterSensitiveLog: (obj: AnalysisSource) => any;
3097
+ /**
3098
+ * @internal
3099
+ */
3100
+ export declare const AnalysisTemplateFilterSensitiveLog: (obj: AnalysisTemplate) => any;
3101
+ /**
3102
+ * @internal
3103
+ */
3104
+ export declare const CreateAnalysisTemplateInputFilterSensitiveLog: (obj: CreateAnalysisTemplateInput) => any;
3105
+ /**
3106
+ * @internal
3107
+ */
3108
+ export declare const CreateAnalysisTemplateOutputFilterSensitiveLog: (obj: CreateAnalysisTemplateOutput) => any;
3109
+ /**
3110
+ * @internal
3111
+ */
3112
+ export declare const GetAnalysisTemplateOutputFilterSensitiveLog: (obj: GetAnalysisTemplateOutput) => any;
3113
+ /**
3114
+ * @internal
3115
+ */
3116
+ export declare const UpdateAnalysisTemplateOutputFilterSensitiveLog: (obj: UpdateAnalysisTemplateOutput) => any;
3117
+ /**
3118
+ * @internal
3119
+ */
3120
+ export declare const CollaborationAnalysisTemplateFilterSensitiveLog: (obj: CollaborationAnalysisTemplate) => any;
3121
+ /**
3122
+ * @internal
3123
+ */
3124
+ export declare const BatchGetCollaborationAnalysisTemplateOutputFilterSensitiveLog: (obj: BatchGetCollaborationAnalysisTemplateOutput) => any;
3125
+ /**
3126
+ * @internal
3127
+ */
3128
+ export declare const GetCollaborationAnalysisTemplateOutputFilterSensitiveLog: (obj: GetCollaborationAnalysisTemplateOutput) => any;
2502
3129
  /**
2503
3130
  * @internal
2504
3131
  */