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