@aws-sdk/client-lakeformation 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +358 -0
- package/package.json +5 -5
|
@@ -9,6 +9,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
10
10
|
readonly $fault: "client";
|
|
11
11
|
/**
|
|
12
|
+
* @public
|
|
12
13
|
* <p>A message describing the problem.</p>
|
|
13
14
|
*/
|
|
14
15
|
Message?: string;
|
|
@@ -23,14 +24,17 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
23
24
|
*/
|
|
24
25
|
export interface LFTagPair {
|
|
25
26
|
/**
|
|
27
|
+
* @public
|
|
26
28
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
27
29
|
*/
|
|
28
30
|
CatalogId?: string;
|
|
29
31
|
/**
|
|
32
|
+
* @public
|
|
30
33
|
* <p>The key-name for the LF-tag.</p>
|
|
31
34
|
*/
|
|
32
35
|
TagKey: string | undefined;
|
|
33
36
|
/**
|
|
37
|
+
* @public
|
|
34
38
|
* <p>A list of possible values an attribute can take.</p>
|
|
35
39
|
*/
|
|
36
40
|
TagValues: string[] | undefined;
|
|
@@ -47,10 +51,12 @@ export interface CatalogResource {
|
|
|
47
51
|
*/
|
|
48
52
|
export interface DatabaseResource {
|
|
49
53
|
/**
|
|
54
|
+
* @public
|
|
50
55
|
* <p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>
|
|
51
56
|
*/
|
|
52
57
|
CatalogId?: string;
|
|
53
58
|
/**
|
|
59
|
+
* @public
|
|
54
60
|
* <p>The name of the database resource. Unique to the Data Catalog.</p>
|
|
55
61
|
*/
|
|
56
62
|
Name: string | undefined;
|
|
@@ -61,18 +67,22 @@ export interface DatabaseResource {
|
|
|
61
67
|
*/
|
|
62
68
|
export interface DataCellsFilterResource {
|
|
63
69
|
/**
|
|
70
|
+
* @public
|
|
64
71
|
* <p>The ID of the catalog to which the table belongs.</p>
|
|
65
72
|
*/
|
|
66
73
|
TableCatalogId?: string;
|
|
67
74
|
/**
|
|
75
|
+
* @public
|
|
68
76
|
* <p>A database in the Glue Data Catalog.</p>
|
|
69
77
|
*/
|
|
70
78
|
DatabaseName?: string;
|
|
71
79
|
/**
|
|
80
|
+
* @public
|
|
72
81
|
* <p>The name of the table.</p>
|
|
73
82
|
*/
|
|
74
83
|
TableName?: string;
|
|
75
84
|
/**
|
|
85
|
+
* @public
|
|
76
86
|
* <p>The name of the data cells filter. </p>
|
|
77
87
|
*/
|
|
78
88
|
Name?: string;
|
|
@@ -83,10 +93,12 @@ export interface DataCellsFilterResource {
|
|
|
83
93
|
*/
|
|
84
94
|
export interface DataLocationResource {
|
|
85
95
|
/**
|
|
96
|
+
* @public
|
|
86
97
|
* <p>The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.</p>
|
|
87
98
|
*/
|
|
88
99
|
CatalogId?: string;
|
|
89
100
|
/**
|
|
101
|
+
* @public
|
|
90
102
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</p>
|
|
91
103
|
*/
|
|
92
104
|
ResourceArn: string | undefined;
|
|
@@ -97,14 +109,17 @@ export interface DataLocationResource {
|
|
|
97
109
|
*/
|
|
98
110
|
export interface LFTagKeyResource {
|
|
99
111
|
/**
|
|
112
|
+
* @public
|
|
100
113
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
101
114
|
*/
|
|
102
115
|
CatalogId?: string;
|
|
103
116
|
/**
|
|
117
|
+
* @public
|
|
104
118
|
* <p>The key-name for the LF-tag.</p>
|
|
105
119
|
*/
|
|
106
120
|
TagKey: string | undefined;
|
|
107
121
|
/**
|
|
122
|
+
* @public
|
|
108
123
|
* <p>A list of possible values an attribute can take.</p>
|
|
109
124
|
*/
|
|
110
125
|
TagValues: string[] | undefined;
|
|
@@ -115,10 +130,12 @@ export interface LFTagKeyResource {
|
|
|
115
130
|
*/
|
|
116
131
|
export interface LFTag {
|
|
117
132
|
/**
|
|
133
|
+
* @public
|
|
118
134
|
* <p>The key-name for the LF-tag.</p>
|
|
119
135
|
*/
|
|
120
136
|
TagKey: string | undefined;
|
|
121
137
|
/**
|
|
138
|
+
* @public
|
|
122
139
|
* <p>A list of possible values an attribute can take.</p>
|
|
123
140
|
*/
|
|
124
141
|
TagValues: string[] | undefined;
|
|
@@ -141,14 +158,17 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
|
141
158
|
*/
|
|
142
159
|
export interface LFTagPolicyResource {
|
|
143
160
|
/**
|
|
161
|
+
* @public
|
|
144
162
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
145
163
|
*/
|
|
146
164
|
CatalogId?: string;
|
|
147
165
|
/**
|
|
166
|
+
* @public
|
|
148
167
|
* <p>The resource type for which the LF-tag policy applies.</p>
|
|
149
168
|
*/
|
|
150
169
|
ResourceType: ResourceType | string | undefined;
|
|
151
170
|
/**
|
|
171
|
+
* @public
|
|
152
172
|
* <p>A list of LF-tag conditions that apply to the resource's LF-tag policy.</p>
|
|
153
173
|
*/
|
|
154
174
|
Expression: LFTag[] | undefined;
|
|
@@ -165,18 +185,22 @@ export interface TableWildcard {
|
|
|
165
185
|
*/
|
|
166
186
|
export interface TableResource {
|
|
167
187
|
/**
|
|
188
|
+
* @public
|
|
168
189
|
* <p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>
|
|
169
190
|
*/
|
|
170
191
|
CatalogId?: string;
|
|
171
192
|
/**
|
|
193
|
+
* @public
|
|
172
194
|
* <p>The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>
|
|
173
195
|
*/
|
|
174
196
|
DatabaseName: string | undefined;
|
|
175
197
|
/**
|
|
198
|
+
* @public
|
|
176
199
|
* <p>The name of the table.</p>
|
|
177
200
|
*/
|
|
178
201
|
Name?: string;
|
|
179
202
|
/**
|
|
203
|
+
* @public
|
|
180
204
|
* <p>A wildcard object representing every table under a database.</p>
|
|
181
205
|
* <p>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</p>
|
|
182
206
|
*/
|
|
@@ -188,6 +212,7 @@ export interface TableResource {
|
|
|
188
212
|
*/
|
|
189
213
|
export interface ColumnWildcard {
|
|
190
214
|
/**
|
|
215
|
+
* @public
|
|
191
216
|
* <p>Excludes column names. Any column with this name will be excluded.</p>
|
|
192
217
|
*/
|
|
193
218
|
ExcludedColumnNames?: string[];
|
|
@@ -199,22 +224,27 @@ export interface ColumnWildcard {
|
|
|
199
224
|
*/
|
|
200
225
|
export interface TableWithColumnsResource {
|
|
201
226
|
/**
|
|
227
|
+
* @public
|
|
202
228
|
* <p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>
|
|
203
229
|
*/
|
|
204
230
|
CatalogId?: string;
|
|
205
231
|
/**
|
|
232
|
+
* @public
|
|
206
233
|
* <p>The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>
|
|
207
234
|
*/
|
|
208
235
|
DatabaseName: string | undefined;
|
|
209
236
|
/**
|
|
237
|
+
* @public
|
|
210
238
|
* <p>The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>
|
|
211
239
|
*/
|
|
212
240
|
Name: string | undefined;
|
|
213
241
|
/**
|
|
242
|
+
* @public
|
|
214
243
|
* <p>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</p>
|
|
215
244
|
*/
|
|
216
245
|
ColumnNames?: string[];
|
|
217
246
|
/**
|
|
247
|
+
* @public
|
|
218
248
|
* <p>A wildcard specified by a <code>ColumnWildcard</code> object. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</p>
|
|
219
249
|
*/
|
|
220
250
|
ColumnWildcard?: ColumnWildcard;
|
|
@@ -225,34 +255,42 @@ export interface TableWithColumnsResource {
|
|
|
225
255
|
*/
|
|
226
256
|
export interface Resource {
|
|
227
257
|
/**
|
|
258
|
+
* @public
|
|
228
259
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
229
260
|
*/
|
|
230
261
|
Catalog?: CatalogResource;
|
|
231
262
|
/**
|
|
263
|
+
* @public
|
|
232
264
|
* <p>The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. </p>
|
|
233
265
|
*/
|
|
234
266
|
Database?: DatabaseResource;
|
|
235
267
|
/**
|
|
268
|
+
* @public
|
|
236
269
|
* <p>The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>
|
|
237
270
|
*/
|
|
238
271
|
Table?: TableResource;
|
|
239
272
|
/**
|
|
273
|
+
* @public
|
|
240
274
|
* <p>The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.</p>
|
|
241
275
|
*/
|
|
242
276
|
TableWithColumns?: TableWithColumnsResource;
|
|
243
277
|
/**
|
|
278
|
+
* @public
|
|
244
279
|
* <p>The location of an Amazon S3 path where permissions are granted or revoked. </p>
|
|
245
280
|
*/
|
|
246
281
|
DataLocation?: DataLocationResource;
|
|
247
282
|
/**
|
|
283
|
+
* @public
|
|
248
284
|
* <p>A data cell filter.</p>
|
|
249
285
|
*/
|
|
250
286
|
DataCellsFilter?: DataCellsFilterResource;
|
|
251
287
|
/**
|
|
288
|
+
* @public
|
|
252
289
|
* <p>The LF-tag key and values attached to a resource.</p>
|
|
253
290
|
*/
|
|
254
291
|
LFTag?: LFTagKeyResource;
|
|
255
292
|
/**
|
|
293
|
+
* @public
|
|
256
294
|
* <p>A list of LF-tag conditions that define a resource's LF-tag policy.</p>
|
|
257
295
|
*/
|
|
258
296
|
LFTagPolicy?: LFTagPolicyResource;
|
|
@@ -262,14 +300,17 @@ export interface Resource {
|
|
|
262
300
|
*/
|
|
263
301
|
export interface AddLFTagsToResourceRequest {
|
|
264
302
|
/**
|
|
303
|
+
* @public
|
|
265
304
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
266
305
|
*/
|
|
267
306
|
CatalogId?: string;
|
|
268
307
|
/**
|
|
308
|
+
* @public
|
|
269
309
|
* <p>The database, table, or column resource to which to attach an LF-tag.</p>
|
|
270
310
|
*/
|
|
271
311
|
Resource: Resource | undefined;
|
|
272
312
|
/**
|
|
313
|
+
* @public
|
|
273
314
|
* <p>The LF-tags to attach to the resource.</p>
|
|
274
315
|
*/
|
|
275
316
|
LFTags: LFTagPair[] | undefined;
|
|
@@ -280,10 +321,12 @@ export interface AddLFTagsToResourceRequest {
|
|
|
280
321
|
*/
|
|
281
322
|
export interface ErrorDetail {
|
|
282
323
|
/**
|
|
324
|
+
* @public
|
|
283
325
|
* <p>The code associated with this error.</p>
|
|
284
326
|
*/
|
|
285
327
|
ErrorCode?: string;
|
|
286
328
|
/**
|
|
329
|
+
* @public
|
|
287
330
|
* <p>A message describing the error.</p>
|
|
288
331
|
*/
|
|
289
332
|
ErrorMessage?: string;
|
|
@@ -294,10 +337,12 @@ export interface ErrorDetail {
|
|
|
294
337
|
*/
|
|
295
338
|
export interface LFTagError {
|
|
296
339
|
/**
|
|
340
|
+
* @public
|
|
297
341
|
* <p>The key-name of the LF-tag.</p>
|
|
298
342
|
*/
|
|
299
343
|
LFTag?: LFTagPair;
|
|
300
344
|
/**
|
|
345
|
+
* @public
|
|
301
346
|
* <p>An error that occurred with the attachment or detachment of the LF-tag.</p>
|
|
302
347
|
*/
|
|
303
348
|
Error?: ErrorDetail;
|
|
@@ -307,6 +352,7 @@ export interface LFTagError {
|
|
|
307
352
|
*/
|
|
308
353
|
export interface AddLFTagsToResourceResponse {
|
|
309
354
|
/**
|
|
355
|
+
* @public
|
|
310
356
|
* <p>A list of failures to tag the resource.</p>
|
|
311
357
|
*/
|
|
312
358
|
Failures?: LFTagError[];
|
|
@@ -319,6 +365,7 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
319
365
|
readonly name: "ConcurrentModificationException";
|
|
320
366
|
readonly $fault: "client";
|
|
321
367
|
/**
|
|
368
|
+
* @public
|
|
322
369
|
* <p>A message describing the problem.</p>
|
|
323
370
|
*/
|
|
324
371
|
Message?: string;
|
|
@@ -335,6 +382,7 @@ export declare class EntityNotFoundException extends __BaseException {
|
|
|
335
382
|
readonly name: "EntityNotFoundException";
|
|
336
383
|
readonly $fault: "client";
|
|
337
384
|
/**
|
|
385
|
+
* @public
|
|
338
386
|
* <p>A message describing the problem.</p>
|
|
339
387
|
*/
|
|
340
388
|
Message?: string;
|
|
@@ -351,6 +399,7 @@ export declare class InternalServiceException extends __BaseException {
|
|
|
351
399
|
readonly name: "InternalServiceException";
|
|
352
400
|
readonly $fault: "server";
|
|
353
401
|
/**
|
|
402
|
+
* @public
|
|
354
403
|
* <p>A message describing the problem.</p>
|
|
355
404
|
*/
|
|
356
405
|
Message?: string;
|
|
@@ -367,6 +416,7 @@ export declare class InvalidInputException extends __BaseException {
|
|
|
367
416
|
readonly name: "InvalidInputException";
|
|
368
417
|
readonly $fault: "client";
|
|
369
418
|
/**
|
|
419
|
+
* @public
|
|
370
420
|
* <p>A message describing the problem.</p>
|
|
371
421
|
*/
|
|
372
422
|
Message?: string;
|
|
@@ -383,6 +433,7 @@ export declare class OperationTimeoutException extends __BaseException {
|
|
|
383
433
|
readonly name: "OperationTimeoutException";
|
|
384
434
|
readonly $fault: "client";
|
|
385
435
|
/**
|
|
436
|
+
* @public
|
|
386
437
|
* <p>A message describing the problem.</p>
|
|
387
438
|
*/
|
|
388
439
|
Message?: string;
|
|
@@ -397,18 +448,22 @@ export declare class OperationTimeoutException extends __BaseException {
|
|
|
397
448
|
*/
|
|
398
449
|
export interface AddObjectInput {
|
|
399
450
|
/**
|
|
451
|
+
* @public
|
|
400
452
|
* <p>The Amazon S3 location of the object.</p>
|
|
401
453
|
*/
|
|
402
454
|
Uri: string | undefined;
|
|
403
455
|
/**
|
|
456
|
+
* @public
|
|
404
457
|
* <p>The Amazon S3 ETag of the object. Returned by <code>GetTableObjects</code> for validation and used to identify changes to the underlying data.</p>
|
|
405
458
|
*/
|
|
406
459
|
ETag: string | undefined;
|
|
407
460
|
/**
|
|
461
|
+
* @public
|
|
408
462
|
* <p>The size of the Amazon S3 object in bytes.</p>
|
|
409
463
|
*/
|
|
410
464
|
Size: number | undefined;
|
|
411
465
|
/**
|
|
466
|
+
* @public
|
|
412
467
|
* <p>A list of partition values for the object. A value must be specified for each partition key associated with the table.</p>
|
|
413
468
|
* <p>The supported data types are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.</p>
|
|
414
469
|
*/
|
|
@@ -428,6 +483,7 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
428
483
|
readonly name: "AlreadyExistsException";
|
|
429
484
|
readonly $fault: "client";
|
|
430
485
|
/**
|
|
486
|
+
* @public
|
|
431
487
|
* <p>A message describing the problem.</p>
|
|
432
488
|
*/
|
|
433
489
|
Message?: string;
|
|
@@ -441,18 +497,22 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
441
497
|
*/
|
|
442
498
|
export interface AssumeDecoratedRoleWithSAMLRequest {
|
|
443
499
|
/**
|
|
500
|
+
* @public
|
|
444
501
|
* <p>A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded.</p>
|
|
445
502
|
*/
|
|
446
503
|
SAMLAssertion: string | undefined;
|
|
447
504
|
/**
|
|
505
|
+
* @public
|
|
448
506
|
* <p>The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as <code>GetTemporaryTableCredentials</code>. The caller must also have iam:PassRole permission on this role. </p>
|
|
449
507
|
*/
|
|
450
508
|
RoleArn: string | undefined;
|
|
451
509
|
/**
|
|
510
|
+
* @public
|
|
452
511
|
* <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.</p>
|
|
453
512
|
*/
|
|
454
513
|
PrincipalArn: string | undefined;
|
|
455
514
|
/**
|
|
515
|
+
* @public
|
|
456
516
|
* <p>The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.</p>
|
|
457
517
|
*/
|
|
458
518
|
DurationSeconds?: number;
|
|
@@ -462,18 +522,22 @@ export interface AssumeDecoratedRoleWithSAMLRequest {
|
|
|
462
522
|
*/
|
|
463
523
|
export interface AssumeDecoratedRoleWithSAMLResponse {
|
|
464
524
|
/**
|
|
525
|
+
* @public
|
|
465
526
|
* <p>The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key).</p>
|
|
466
527
|
*/
|
|
467
528
|
AccessKeyId?: string;
|
|
468
529
|
/**
|
|
530
|
+
* @public
|
|
469
531
|
* <p>The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key).</p>
|
|
470
532
|
*/
|
|
471
533
|
SecretAccessKey?: string;
|
|
472
534
|
/**
|
|
535
|
+
* @public
|
|
473
536
|
* <p>The session token for the temporary credentials.</p>
|
|
474
537
|
*/
|
|
475
538
|
SessionToken?: string;
|
|
476
539
|
/**
|
|
540
|
+
* @public
|
|
477
541
|
* <p>The date and time when the temporary credentials expire.</p>
|
|
478
542
|
*/
|
|
479
543
|
Expiration?: Date;
|
|
@@ -484,6 +548,7 @@ export interface AssumeDecoratedRoleWithSAMLResponse {
|
|
|
484
548
|
*/
|
|
485
549
|
export interface AuditContext {
|
|
486
550
|
/**
|
|
551
|
+
* @public
|
|
487
552
|
* <p>The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.</p>
|
|
488
553
|
*/
|
|
489
554
|
AdditionalAuditContext?: string;
|
|
@@ -518,6 +583,7 @@ export type Permission = (typeof Permission)[keyof typeof Permission];
|
|
|
518
583
|
*/
|
|
519
584
|
export interface DataLakePrincipal {
|
|
520
585
|
/**
|
|
586
|
+
* @public
|
|
521
587
|
* <p>An identifier for the Lake Formation principal.</p>
|
|
522
588
|
*/
|
|
523
589
|
DataLakePrincipalIdentifier?: string;
|
|
@@ -528,22 +594,27 @@ export interface DataLakePrincipal {
|
|
|
528
594
|
*/
|
|
529
595
|
export interface BatchPermissionsRequestEntry {
|
|
530
596
|
/**
|
|
597
|
+
* @public
|
|
531
598
|
* <p>A unique identifier for the batch permissions request entry.</p>
|
|
532
599
|
*/
|
|
533
600
|
Id: string | undefined;
|
|
534
601
|
/**
|
|
602
|
+
* @public
|
|
535
603
|
* <p>The principal to be granted a permission.</p>
|
|
536
604
|
*/
|
|
537
605
|
Principal?: DataLakePrincipal;
|
|
538
606
|
/**
|
|
607
|
+
* @public
|
|
539
608
|
* <p>The resource to which the principal is to be granted a permission.</p>
|
|
540
609
|
*/
|
|
541
610
|
Resource?: Resource;
|
|
542
611
|
/**
|
|
612
|
+
* @public
|
|
543
613
|
* <p>The permissions to be granted.</p>
|
|
544
614
|
*/
|
|
545
615
|
Permissions?: (Permission | string)[];
|
|
546
616
|
/**
|
|
617
|
+
* @public
|
|
547
618
|
* <p>Indicates if the option to pass permissions is granted.</p>
|
|
548
619
|
*/
|
|
549
620
|
PermissionsWithGrantOption?: (Permission | string)[];
|
|
@@ -553,10 +624,12 @@ export interface BatchPermissionsRequestEntry {
|
|
|
553
624
|
*/
|
|
554
625
|
export interface BatchGrantPermissionsRequest {
|
|
555
626
|
/**
|
|
627
|
+
* @public
|
|
556
628
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
557
629
|
*/
|
|
558
630
|
CatalogId?: string;
|
|
559
631
|
/**
|
|
632
|
+
* @public
|
|
560
633
|
* <p>A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.</p>
|
|
561
634
|
*/
|
|
562
635
|
Entries: BatchPermissionsRequestEntry[] | undefined;
|
|
@@ -567,10 +640,12 @@ export interface BatchGrantPermissionsRequest {
|
|
|
567
640
|
*/
|
|
568
641
|
export interface BatchPermissionsFailureEntry {
|
|
569
642
|
/**
|
|
643
|
+
* @public
|
|
570
644
|
* <p>An identifier for an entry of the batch request.</p>
|
|
571
645
|
*/
|
|
572
646
|
RequestEntry?: BatchPermissionsRequestEntry;
|
|
573
647
|
/**
|
|
648
|
+
* @public
|
|
574
649
|
* <p>An error message that applies to the failure of the entry.</p>
|
|
575
650
|
*/
|
|
576
651
|
Error?: ErrorDetail;
|
|
@@ -580,6 +655,7 @@ export interface BatchPermissionsFailureEntry {
|
|
|
580
655
|
*/
|
|
581
656
|
export interface BatchGrantPermissionsResponse {
|
|
582
657
|
/**
|
|
658
|
+
* @public
|
|
583
659
|
* <p>A list of failures to grant permissions to the resources.</p>
|
|
584
660
|
*/
|
|
585
661
|
Failures?: BatchPermissionsFailureEntry[];
|
|
@@ -589,10 +665,12 @@ export interface BatchGrantPermissionsResponse {
|
|
|
589
665
|
*/
|
|
590
666
|
export interface BatchRevokePermissionsRequest {
|
|
591
667
|
/**
|
|
668
|
+
* @public
|
|
592
669
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
593
670
|
*/
|
|
594
671
|
CatalogId?: string;
|
|
595
672
|
/**
|
|
673
|
+
* @public
|
|
596
674
|
* <p>A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.</p>
|
|
597
675
|
*/
|
|
598
676
|
Entries: BatchPermissionsRequestEntry[] | undefined;
|
|
@@ -602,6 +680,7 @@ export interface BatchRevokePermissionsRequest {
|
|
|
602
680
|
*/
|
|
603
681
|
export interface BatchRevokePermissionsResponse {
|
|
604
682
|
/**
|
|
683
|
+
* @public
|
|
605
684
|
* <p>A list of failures to revoke permissions to the resources.</p>
|
|
606
685
|
*/
|
|
607
686
|
Failures?: BatchPermissionsFailureEntry[];
|
|
@@ -611,6 +690,7 @@ export interface BatchRevokePermissionsResponse {
|
|
|
611
690
|
*/
|
|
612
691
|
export interface CancelTransactionRequest {
|
|
613
692
|
/**
|
|
693
|
+
* @public
|
|
614
694
|
* <p>The transaction to cancel.</p>
|
|
615
695
|
*/
|
|
616
696
|
TransactionId: string | undefined;
|
|
@@ -628,6 +708,7 @@ export declare class TransactionCommitInProgressException extends __BaseExceptio
|
|
|
628
708
|
readonly name: "TransactionCommitInProgressException";
|
|
629
709
|
readonly $fault: "client";
|
|
630
710
|
/**
|
|
711
|
+
* @public
|
|
631
712
|
* <p>A message describing the error.</p>
|
|
632
713
|
*/
|
|
633
714
|
Message?: string;
|
|
@@ -644,6 +725,7 @@ export declare class TransactionCommittedException extends __BaseException {
|
|
|
644
725
|
readonly name: "TransactionCommittedException";
|
|
645
726
|
readonly $fault: "client";
|
|
646
727
|
/**
|
|
728
|
+
* @public
|
|
647
729
|
* <p>A message describing the error.</p>
|
|
648
730
|
*/
|
|
649
731
|
Message?: string;
|
|
@@ -657,6 +739,7 @@ export declare class TransactionCommittedException extends __BaseException {
|
|
|
657
739
|
*/
|
|
658
740
|
export interface CommitTransactionRequest {
|
|
659
741
|
/**
|
|
742
|
+
* @public
|
|
660
743
|
* <p>The transaction to commit.</p>
|
|
661
744
|
*/
|
|
662
745
|
TransactionId: string | undefined;
|
|
@@ -680,6 +763,7 @@ export type TransactionStatus = (typeof TransactionStatus)[keyof typeof Transact
|
|
|
680
763
|
*/
|
|
681
764
|
export interface CommitTransactionResponse {
|
|
682
765
|
/**
|
|
766
|
+
* @public
|
|
683
767
|
* <p>The status of the transaction.</p>
|
|
684
768
|
*/
|
|
685
769
|
TransactionStatus?: TransactionStatus | string;
|
|
@@ -692,6 +776,7 @@ export declare class TransactionCanceledException extends __BaseException {
|
|
|
692
776
|
readonly name: "TransactionCanceledException";
|
|
693
777
|
readonly $fault: "client";
|
|
694
778
|
/**
|
|
779
|
+
* @public
|
|
695
780
|
* <p>A message describing the error.</p>
|
|
696
781
|
*/
|
|
697
782
|
Message?: string;
|
|
@@ -706,10 +791,12 @@ export declare class TransactionCanceledException extends __BaseException {
|
|
|
706
791
|
*/
|
|
707
792
|
export interface RowFilter {
|
|
708
793
|
/**
|
|
794
|
+
* @public
|
|
709
795
|
* <p>A filter expression.</p>
|
|
710
796
|
*/
|
|
711
797
|
FilterExpression?: string;
|
|
712
798
|
/**
|
|
799
|
+
* @public
|
|
713
800
|
* <p>A wildcard for all rows.</p>
|
|
714
801
|
*/
|
|
715
802
|
AllRowsWildcard?: AllRowsWildcard;
|
|
@@ -720,36 +807,44 @@ export interface RowFilter {
|
|
|
720
807
|
*/
|
|
721
808
|
export interface DataCellsFilter {
|
|
722
809
|
/**
|
|
810
|
+
* @public
|
|
723
811
|
* <p>The ID of the catalog to which the table belongs.</p>
|
|
724
812
|
*/
|
|
725
813
|
TableCatalogId: string | undefined;
|
|
726
814
|
/**
|
|
815
|
+
* @public
|
|
727
816
|
* <p>A database in the Glue Data Catalog.</p>
|
|
728
817
|
*/
|
|
729
818
|
DatabaseName: string | undefined;
|
|
730
819
|
/**
|
|
820
|
+
* @public
|
|
731
821
|
* <p>A table in the database.</p>
|
|
732
822
|
*/
|
|
733
823
|
TableName: string | undefined;
|
|
734
824
|
/**
|
|
825
|
+
* @public
|
|
735
826
|
* <p>The name given by the user to the data filter cell.</p>
|
|
736
827
|
*/
|
|
737
828
|
Name: string | undefined;
|
|
738
829
|
/**
|
|
830
|
+
* @public
|
|
739
831
|
* <p>A PartiQL predicate.</p>
|
|
740
832
|
*/
|
|
741
833
|
RowFilter?: RowFilter;
|
|
742
834
|
/**
|
|
835
|
+
* @public
|
|
743
836
|
* <p>A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.</p>
|
|
744
837
|
*/
|
|
745
838
|
ColumnNames?: string[];
|
|
746
839
|
/**
|
|
840
|
+
* @public
|
|
747
841
|
* <p>A wildcard with exclusions.</p>
|
|
748
842
|
* <p>You must specify either a <code>ColumnNames</code> list or the
|
|
749
843
|
* <code>ColumnWildCard</code>. </p>
|
|
750
844
|
*/
|
|
751
845
|
ColumnWildcard?: ColumnWildcard;
|
|
752
846
|
/**
|
|
847
|
+
* @public
|
|
753
848
|
* <p>The ID of the data cells filter version.</p>
|
|
754
849
|
*/
|
|
755
850
|
VersionId?: string;
|
|
@@ -759,6 +854,7 @@ export interface DataCellsFilter {
|
|
|
759
854
|
*/
|
|
760
855
|
export interface CreateDataCellsFilterRequest {
|
|
761
856
|
/**
|
|
857
|
+
* @public
|
|
762
858
|
* <p>A <code>DataCellsFilter</code> structure containing information about the data cells filter.</p>
|
|
763
859
|
*/
|
|
764
860
|
TableData: DataCellsFilter | undefined;
|
|
@@ -776,6 +872,7 @@ export declare class ResourceNumberLimitExceededException extends __BaseExceptio
|
|
|
776
872
|
readonly name: "ResourceNumberLimitExceededException";
|
|
777
873
|
readonly $fault: "client";
|
|
778
874
|
/**
|
|
875
|
+
* @public
|
|
779
876
|
* <p>A message describing the problem.</p>
|
|
780
877
|
*/
|
|
781
878
|
Message?: string;
|
|
@@ -789,14 +886,17 @@ export declare class ResourceNumberLimitExceededException extends __BaseExceptio
|
|
|
789
886
|
*/
|
|
790
887
|
export interface CreateLFTagRequest {
|
|
791
888
|
/**
|
|
889
|
+
* @public
|
|
792
890
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
793
891
|
*/
|
|
794
892
|
CatalogId?: string;
|
|
795
893
|
/**
|
|
894
|
+
* @public
|
|
796
895
|
* <p>The key-name for the LF-tag.</p>
|
|
797
896
|
*/
|
|
798
897
|
TagKey: string | undefined;
|
|
799
898
|
/**
|
|
899
|
+
* @public
|
|
800
900
|
* <p>A list of possible values an attribute can take.</p>
|
|
801
901
|
*/
|
|
802
902
|
TagValues: string[] | undefined;
|
|
@@ -811,18 +911,22 @@ export interface CreateLFTagResponse {
|
|
|
811
911
|
*/
|
|
812
912
|
export interface DeleteDataCellsFilterRequest {
|
|
813
913
|
/**
|
|
914
|
+
* @public
|
|
814
915
|
* <p>The ID of the catalog to which the table belongs.</p>
|
|
815
916
|
*/
|
|
816
917
|
TableCatalogId?: string;
|
|
817
918
|
/**
|
|
919
|
+
* @public
|
|
818
920
|
* <p>A database in the Glue Data Catalog.</p>
|
|
819
921
|
*/
|
|
820
922
|
DatabaseName?: string;
|
|
821
923
|
/**
|
|
924
|
+
* @public
|
|
822
925
|
* <p>A table in the database.</p>
|
|
823
926
|
*/
|
|
824
927
|
TableName?: string;
|
|
825
928
|
/**
|
|
929
|
+
* @public
|
|
826
930
|
* <p>The name given by the user to the data filter cell.</p>
|
|
827
931
|
*/
|
|
828
932
|
Name?: string;
|
|
@@ -837,10 +941,12 @@ export interface DeleteDataCellsFilterResponse {
|
|
|
837
941
|
*/
|
|
838
942
|
export interface DeleteLFTagRequest {
|
|
839
943
|
/**
|
|
944
|
+
* @public
|
|
840
945
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
841
946
|
*/
|
|
842
947
|
CatalogId?: string;
|
|
843
948
|
/**
|
|
949
|
+
* @public
|
|
844
950
|
* <p>The key-name for the LF-tag to delete.</p>
|
|
845
951
|
*/
|
|
846
952
|
TagKey: string | undefined;
|
|
@@ -857,10 +963,12 @@ export interface DeleteLFTagResponse {
|
|
|
857
963
|
*/
|
|
858
964
|
export interface VirtualObject {
|
|
859
965
|
/**
|
|
966
|
+
* @public
|
|
860
967
|
* <p>The path to the Amazon S3 object. Must start with s3://</p>
|
|
861
968
|
*/
|
|
862
969
|
Uri: string | undefined;
|
|
863
970
|
/**
|
|
971
|
+
* @public
|
|
864
972
|
* <p>The ETag of the Amazon S3 object.</p>
|
|
865
973
|
*/
|
|
866
974
|
ETag?: string;
|
|
@@ -870,22 +978,27 @@ export interface VirtualObject {
|
|
|
870
978
|
*/
|
|
871
979
|
export interface DeleteObjectsOnCancelRequest {
|
|
872
980
|
/**
|
|
981
|
+
* @public
|
|
873
982
|
* <p>The Glue data catalog that contains the governed table. Defaults to the current account ID.</p>
|
|
874
983
|
*/
|
|
875
984
|
CatalogId?: string;
|
|
876
985
|
/**
|
|
986
|
+
* @public
|
|
877
987
|
* <p>The database that contains the governed table.</p>
|
|
878
988
|
*/
|
|
879
989
|
DatabaseName: string | undefined;
|
|
880
990
|
/**
|
|
991
|
+
* @public
|
|
881
992
|
* <p>The name of the governed table.</p>
|
|
882
993
|
*/
|
|
883
994
|
TableName: string | undefined;
|
|
884
995
|
/**
|
|
996
|
+
* @public
|
|
885
997
|
* <p>ID of the transaction that the writes occur in.</p>
|
|
886
998
|
*/
|
|
887
999
|
TransactionId: string | undefined;
|
|
888
1000
|
/**
|
|
1001
|
+
* @public
|
|
889
1002
|
* <p>A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.</p>
|
|
890
1003
|
*/
|
|
891
1004
|
Objects: VirtualObject[] | undefined;
|
|
@@ -903,6 +1016,7 @@ export declare class ResourceNotReadyException extends __BaseException {
|
|
|
903
1016
|
readonly name: "ResourceNotReadyException";
|
|
904
1017
|
readonly $fault: "client";
|
|
905
1018
|
/**
|
|
1019
|
+
* @public
|
|
906
1020
|
* <p>A message describing the error.</p>
|
|
907
1021
|
*/
|
|
908
1022
|
Message?: string;
|
|
@@ -916,6 +1030,7 @@ export declare class ResourceNotReadyException extends __BaseException {
|
|
|
916
1030
|
*/
|
|
917
1031
|
export interface DeregisterResourceRequest {
|
|
918
1032
|
/**
|
|
1033
|
+
* @public
|
|
919
1034
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to deregister.</p>
|
|
920
1035
|
*/
|
|
921
1036
|
ResourceArn: string | undefined;
|
|
@@ -930,6 +1045,7 @@ export interface DeregisterResourceResponse {
|
|
|
930
1045
|
*/
|
|
931
1046
|
export interface DescribeResourceRequest {
|
|
932
1047
|
/**
|
|
1048
|
+
* @public
|
|
933
1049
|
* <p>The resource ARN.</p>
|
|
934
1050
|
*/
|
|
935
1051
|
ResourceArn: string | undefined;
|
|
@@ -940,18 +1056,22 @@ export interface DescribeResourceRequest {
|
|
|
940
1056
|
*/
|
|
941
1057
|
export interface ResourceInfo {
|
|
942
1058
|
/**
|
|
1059
|
+
* @public
|
|
943
1060
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
944
1061
|
*/
|
|
945
1062
|
ResourceArn?: string;
|
|
946
1063
|
/**
|
|
1064
|
+
* @public
|
|
947
1065
|
* <p>The IAM role that registered a resource.</p>
|
|
948
1066
|
*/
|
|
949
1067
|
RoleArn?: string;
|
|
950
1068
|
/**
|
|
1069
|
+
* @public
|
|
951
1070
|
* <p>The date and time the resource was last modified.</p>
|
|
952
1071
|
*/
|
|
953
1072
|
LastModified?: Date;
|
|
954
1073
|
/**
|
|
1074
|
+
* @public
|
|
955
1075
|
* <p>Whether or not the resource is a federated resource.</p>
|
|
956
1076
|
*/
|
|
957
1077
|
WithFederation?: boolean;
|
|
@@ -961,6 +1081,7 @@ export interface ResourceInfo {
|
|
|
961
1081
|
*/
|
|
962
1082
|
export interface DescribeResourceResponse {
|
|
963
1083
|
/**
|
|
1084
|
+
* @public
|
|
964
1085
|
* <p>A structure containing information about an Lake Formation resource.</p>
|
|
965
1086
|
*/
|
|
966
1087
|
ResourceInfo?: ResourceInfo;
|
|
@@ -970,6 +1091,7 @@ export interface DescribeResourceResponse {
|
|
|
970
1091
|
*/
|
|
971
1092
|
export interface DescribeTransactionRequest {
|
|
972
1093
|
/**
|
|
1094
|
+
* @public
|
|
973
1095
|
* <p>The transaction for which to return status.</p>
|
|
974
1096
|
*/
|
|
975
1097
|
TransactionId: string | undefined;
|
|
@@ -980,18 +1102,22 @@ export interface DescribeTransactionRequest {
|
|
|
980
1102
|
*/
|
|
981
1103
|
export interface TransactionDescription {
|
|
982
1104
|
/**
|
|
1105
|
+
* @public
|
|
983
1106
|
* <p>The ID of the transaction.</p>
|
|
984
1107
|
*/
|
|
985
1108
|
TransactionId?: string;
|
|
986
1109
|
/**
|
|
1110
|
+
* @public
|
|
987
1111
|
* <p>A status of ACTIVE, COMMITTED, or ABORTED.</p>
|
|
988
1112
|
*/
|
|
989
1113
|
TransactionStatus?: TransactionStatus | string;
|
|
990
1114
|
/**
|
|
1115
|
+
* @public
|
|
991
1116
|
* <p>The time when the transaction started.</p>
|
|
992
1117
|
*/
|
|
993
1118
|
TransactionStartTime?: Date;
|
|
994
1119
|
/**
|
|
1120
|
+
* @public
|
|
995
1121
|
* <p>The time when the transaction committed or aborted, if it is not currently active.</p>
|
|
996
1122
|
*/
|
|
997
1123
|
TransactionEndTime?: Date;
|
|
@@ -1001,6 +1127,7 @@ export interface TransactionDescription {
|
|
|
1001
1127
|
*/
|
|
1002
1128
|
export interface DescribeTransactionResponse {
|
|
1003
1129
|
/**
|
|
1130
|
+
* @public
|
|
1004
1131
|
* <p>Returns a <code>TransactionDescription</code> object containing information about the transaction.</p>
|
|
1005
1132
|
*/
|
|
1006
1133
|
TransactionDescription?: TransactionDescription;
|
|
@@ -1010,6 +1137,7 @@ export interface DescribeTransactionResponse {
|
|
|
1010
1137
|
*/
|
|
1011
1138
|
export interface ExtendTransactionRequest {
|
|
1012
1139
|
/**
|
|
1140
|
+
* @public
|
|
1013
1141
|
* <p>The transaction to extend.</p>
|
|
1014
1142
|
*/
|
|
1015
1143
|
TransactionId?: string;
|
|
@@ -1024,18 +1152,22 @@ export interface ExtendTransactionResponse {
|
|
|
1024
1152
|
*/
|
|
1025
1153
|
export interface GetDataCellsFilterRequest {
|
|
1026
1154
|
/**
|
|
1155
|
+
* @public
|
|
1027
1156
|
* <p>The ID of the catalog to which the table belongs.</p>
|
|
1028
1157
|
*/
|
|
1029
1158
|
TableCatalogId: string | undefined;
|
|
1030
1159
|
/**
|
|
1160
|
+
* @public
|
|
1031
1161
|
* <p>A database in the Glue Data Catalog.</p>
|
|
1032
1162
|
*/
|
|
1033
1163
|
DatabaseName: string | undefined;
|
|
1034
1164
|
/**
|
|
1165
|
+
* @public
|
|
1035
1166
|
* <p>A table in the database.</p>
|
|
1036
1167
|
*/
|
|
1037
1168
|
TableName: string | undefined;
|
|
1038
1169
|
/**
|
|
1170
|
+
* @public
|
|
1039
1171
|
* <p>The name given by the user to the data filter cell.</p>
|
|
1040
1172
|
*/
|
|
1041
1173
|
Name: string | undefined;
|
|
@@ -1045,6 +1177,7 @@ export interface GetDataCellsFilterRequest {
|
|
|
1045
1177
|
*/
|
|
1046
1178
|
export interface GetDataCellsFilterResponse {
|
|
1047
1179
|
/**
|
|
1180
|
+
* @public
|
|
1048
1181
|
* <p>A structure that describes certain columns on certain rows.</p>
|
|
1049
1182
|
*/
|
|
1050
1183
|
DataCellsFilter?: DataCellsFilter;
|
|
@@ -1054,6 +1187,7 @@ export interface GetDataCellsFilterResponse {
|
|
|
1054
1187
|
*/
|
|
1055
1188
|
export interface GetDataLakeSettingsRequest {
|
|
1056
1189
|
/**
|
|
1190
|
+
* @public
|
|
1057
1191
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1058
1192
|
*/
|
|
1059
1193
|
CatalogId?: string;
|
|
@@ -1064,10 +1198,12 @@ export interface GetDataLakeSettingsRequest {
|
|
|
1064
1198
|
*/
|
|
1065
1199
|
export interface PrincipalPermissions {
|
|
1066
1200
|
/**
|
|
1201
|
+
* @public
|
|
1067
1202
|
* <p>The principal who is granted permissions.</p>
|
|
1068
1203
|
*/
|
|
1069
1204
|
Principal?: DataLakePrincipal;
|
|
1070
1205
|
/**
|
|
1206
|
+
* @public
|
|
1071
1207
|
* <p>The permissions that are granted to the principal.</p>
|
|
1072
1208
|
*/
|
|
1073
1209
|
Permissions?: (Permission | string)[];
|
|
@@ -1078,14 +1214,17 @@ export interface PrincipalPermissions {
|
|
|
1078
1214
|
*/
|
|
1079
1215
|
export interface DataLakeSettings {
|
|
1080
1216
|
/**
|
|
1217
|
+
* @public
|
|
1081
1218
|
* <p>A list of Lake Formation principals. Supported principals are IAM users or IAM roles.</p>
|
|
1082
1219
|
*/
|
|
1083
1220
|
DataLakeAdmins?: DataLakePrincipal[];
|
|
1084
1221
|
/**
|
|
1222
|
+
* @public
|
|
1085
1223
|
* <p>A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.</p>
|
|
1086
1224
|
*/
|
|
1087
1225
|
ReadOnlyAdmins?: DataLakePrincipal[];
|
|
1088
1226
|
/**
|
|
1227
|
+
* @public
|
|
1089
1228
|
* <p>Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.</p>
|
|
1090
1229
|
* <p>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</p>
|
|
1091
1230
|
* <p>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</p>
|
|
@@ -1093,6 +1232,7 @@ export interface DataLakeSettings {
|
|
|
1093
1232
|
*/
|
|
1094
1233
|
CreateDatabaseDefaultPermissions?: PrincipalPermissions[];
|
|
1095
1234
|
/**
|
|
1235
|
+
* @public
|
|
1096
1236
|
* <p>Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.</p>
|
|
1097
1237
|
* <p>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</p>
|
|
1098
1238
|
* <p>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</p>
|
|
@@ -1100,15 +1240,18 @@ export interface DataLakeSettings {
|
|
|
1100
1240
|
*/
|
|
1101
1241
|
CreateTableDefaultPermissions?: PrincipalPermissions[];
|
|
1102
1242
|
/**
|
|
1243
|
+
* @public
|
|
1103
1244
|
* <p>A key-value map that provides an additional configuration on your data lake. CrossAccountVersion is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, and 3.</p>
|
|
1104
1245
|
*/
|
|
1105
1246
|
Parameters?: Record<string, string>;
|
|
1106
1247
|
/**
|
|
1248
|
+
* @public
|
|
1107
1249
|
* <p>A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log.</p>
|
|
1108
1250
|
* <p>You may want to specify this property when you are in a high-trust boundary, such as the same team or company. </p>
|
|
1109
1251
|
*/
|
|
1110
1252
|
TrustedResourceOwners?: string[];
|
|
1111
1253
|
/**
|
|
1254
|
+
* @public
|
|
1112
1255
|
* <p>Whether to allow Amazon EMR clusters to access data managed by Lake Formation. </p>
|
|
1113
1256
|
* <p>If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.</p>
|
|
1114
1257
|
* <p>If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.</p>
|
|
@@ -1116,14 +1259,17 @@ export interface DataLakeSettings {
|
|
|
1116
1259
|
*/
|
|
1117
1260
|
AllowExternalDataFiltering?: boolean;
|
|
1118
1261
|
/**
|
|
1262
|
+
* @public
|
|
1119
1263
|
* <p>Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.</p>
|
|
1120
1264
|
*/
|
|
1121
1265
|
AllowFullTableExternalDataAccess?: boolean;
|
|
1122
1266
|
/**
|
|
1267
|
+
* @public
|
|
1123
1268
|
* <p>A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.></p>
|
|
1124
1269
|
*/
|
|
1125
1270
|
ExternalDataFilteringAllowList?: DataLakePrincipal[];
|
|
1126
1271
|
/**
|
|
1272
|
+
* @public
|
|
1127
1273
|
* <p>Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs.</p>
|
|
1128
1274
|
*/
|
|
1129
1275
|
AuthorizedSessionTagValueList?: string[];
|
|
@@ -1133,6 +1279,7 @@ export interface DataLakeSettings {
|
|
|
1133
1279
|
*/
|
|
1134
1280
|
export interface GetDataLakeSettingsResponse {
|
|
1135
1281
|
/**
|
|
1282
|
+
* @public
|
|
1136
1283
|
* <p>A structure representing a list of Lake Formation principals designated as data lake administrators.</p>
|
|
1137
1284
|
*/
|
|
1138
1285
|
DataLakeSettings?: DataLakeSettings;
|
|
@@ -1142,18 +1289,22 @@ export interface GetDataLakeSettingsResponse {
|
|
|
1142
1289
|
*/
|
|
1143
1290
|
export interface GetEffectivePermissionsForPathRequest {
|
|
1144
1291
|
/**
|
|
1292
|
+
* @public
|
|
1145
1293
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1146
1294
|
*/
|
|
1147
1295
|
CatalogId?: string;
|
|
1148
1296
|
/**
|
|
1297
|
+
* @public
|
|
1149
1298
|
* <p>The Amazon Resource Name (ARN) of the resource for which you want to get permissions.</p>
|
|
1150
1299
|
*/
|
|
1151
1300
|
ResourceArn: string | undefined;
|
|
1152
1301
|
/**
|
|
1302
|
+
* @public
|
|
1153
1303
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
1154
1304
|
*/
|
|
1155
1305
|
NextToken?: string;
|
|
1156
1306
|
/**
|
|
1307
|
+
* @public
|
|
1157
1308
|
* <p>The maximum number of results to return.</p>
|
|
1158
1309
|
*/
|
|
1159
1310
|
MaxResults?: number;
|
|
@@ -1165,6 +1316,7 @@ export interface GetEffectivePermissionsForPathRequest {
|
|
|
1165
1316
|
*/
|
|
1166
1317
|
export interface DetailsMap {
|
|
1167
1318
|
/**
|
|
1319
|
+
* @public
|
|
1168
1320
|
* <p>A resource share ARN for a catalog resource shared through RAM.</p>
|
|
1169
1321
|
*/
|
|
1170
1322
|
ResourceShare?: string[];
|
|
@@ -1175,22 +1327,27 @@ export interface DetailsMap {
|
|
|
1175
1327
|
*/
|
|
1176
1328
|
export interface PrincipalResourcePermissions {
|
|
1177
1329
|
/**
|
|
1330
|
+
* @public
|
|
1178
1331
|
* <p>The Data Lake principal to be granted or revoked permissions.</p>
|
|
1179
1332
|
*/
|
|
1180
1333
|
Principal?: DataLakePrincipal;
|
|
1181
1334
|
/**
|
|
1335
|
+
* @public
|
|
1182
1336
|
* <p>The resource where permissions are to be granted or revoked.</p>
|
|
1183
1337
|
*/
|
|
1184
1338
|
Resource?: Resource;
|
|
1185
1339
|
/**
|
|
1340
|
+
* @public
|
|
1186
1341
|
* <p>The permissions to be granted or revoked on the resource.</p>
|
|
1187
1342
|
*/
|
|
1188
1343
|
Permissions?: (Permission | string)[];
|
|
1189
1344
|
/**
|
|
1345
|
+
* @public
|
|
1190
1346
|
* <p>Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).</p>
|
|
1191
1347
|
*/
|
|
1192
1348
|
PermissionsWithGrantOption?: (Permission | string)[];
|
|
1193
1349
|
/**
|
|
1350
|
+
* @public
|
|
1194
1351
|
* <p>This attribute can be used to return any additional details of <code>PrincipalResourcePermissions</code>. Currently returns only as a RAM resource share ARN.</p>
|
|
1195
1352
|
*/
|
|
1196
1353
|
AdditionalDetails?: DetailsMap;
|
|
@@ -1200,10 +1357,12 @@ export interface PrincipalResourcePermissions {
|
|
|
1200
1357
|
*/
|
|
1201
1358
|
export interface GetEffectivePermissionsForPathResponse {
|
|
1202
1359
|
/**
|
|
1360
|
+
* @public
|
|
1203
1361
|
* <p>A list of the permissions for the specified table or database resource located at the path in Amazon S3.</p>
|
|
1204
1362
|
*/
|
|
1205
1363
|
Permissions?: PrincipalResourcePermissions[];
|
|
1206
1364
|
/**
|
|
1365
|
+
* @public
|
|
1207
1366
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
1208
1367
|
*/
|
|
1209
1368
|
NextToken?: string;
|
|
@@ -1213,10 +1372,12 @@ export interface GetEffectivePermissionsForPathResponse {
|
|
|
1213
1372
|
*/
|
|
1214
1373
|
export interface GetLFTagRequest {
|
|
1215
1374
|
/**
|
|
1375
|
+
* @public
|
|
1216
1376
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1217
1377
|
*/
|
|
1218
1378
|
CatalogId?: string;
|
|
1219
1379
|
/**
|
|
1380
|
+
* @public
|
|
1220
1381
|
* <p>The key-name for the LF-tag.</p>
|
|
1221
1382
|
*/
|
|
1222
1383
|
TagKey: string | undefined;
|
|
@@ -1226,14 +1387,17 @@ export interface GetLFTagRequest {
|
|
|
1226
1387
|
*/
|
|
1227
1388
|
export interface GetLFTagResponse {
|
|
1228
1389
|
/**
|
|
1390
|
+
* @public
|
|
1229
1391
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1230
1392
|
*/
|
|
1231
1393
|
CatalogId?: string;
|
|
1232
1394
|
/**
|
|
1395
|
+
* @public
|
|
1233
1396
|
* <p>The key-name for the LF-tag.</p>
|
|
1234
1397
|
*/
|
|
1235
1398
|
TagKey?: string;
|
|
1236
1399
|
/**
|
|
1400
|
+
* @public
|
|
1237
1401
|
* <p>A list of possible values an attribute can take.</p>
|
|
1238
1402
|
*/
|
|
1239
1403
|
TagValues?: string[];
|
|
@@ -1243,6 +1407,7 @@ export interface GetLFTagResponse {
|
|
|
1243
1407
|
*/
|
|
1244
1408
|
export interface GetQueryStateRequest {
|
|
1245
1409
|
/**
|
|
1410
|
+
* @public
|
|
1246
1411
|
* <p>The ID of the plan query operation.</p>
|
|
1247
1412
|
*/
|
|
1248
1413
|
QueryId: string | undefined;
|
|
@@ -1268,10 +1433,12 @@ export type QueryStateString = (typeof QueryStateString)[keyof typeof QueryState
|
|
|
1268
1433
|
*/
|
|
1269
1434
|
export interface GetQueryStateResponse {
|
|
1270
1435
|
/**
|
|
1436
|
+
* @public
|
|
1271
1437
|
* <p>An error message when the operation fails.</p>
|
|
1272
1438
|
*/
|
|
1273
1439
|
Error?: string;
|
|
1274
1440
|
/**
|
|
1441
|
+
* @public
|
|
1275
1442
|
* <p>The state of a query previously submitted. The possible states are:</p>
|
|
1276
1443
|
* <ul>
|
|
1277
1444
|
* <li>
|
|
@@ -1298,6 +1465,7 @@ export declare class ExpiredException extends __BaseException {
|
|
|
1298
1465
|
readonly name: "ExpiredException";
|
|
1299
1466
|
readonly $fault: "client";
|
|
1300
1467
|
/**
|
|
1468
|
+
* @public
|
|
1301
1469
|
* <p>A message describing the error.</p>
|
|
1302
1470
|
*/
|
|
1303
1471
|
Message?: string;
|
|
@@ -1311,6 +1479,7 @@ export declare class ExpiredException extends __BaseException {
|
|
|
1311
1479
|
*/
|
|
1312
1480
|
export interface GetQueryStatisticsRequest {
|
|
1313
1481
|
/**
|
|
1482
|
+
* @public
|
|
1314
1483
|
* <p>The ID of the plan query operation.</p>
|
|
1315
1484
|
*/
|
|
1316
1485
|
QueryId: string | undefined;
|
|
@@ -1321,14 +1490,17 @@ export interface GetQueryStatisticsRequest {
|
|
|
1321
1490
|
*/
|
|
1322
1491
|
export interface ExecutionStatistics {
|
|
1323
1492
|
/**
|
|
1493
|
+
* @public
|
|
1324
1494
|
* <p>The average time the request took to be executed.</p>
|
|
1325
1495
|
*/
|
|
1326
1496
|
AverageExecutionTimeMillis?: number;
|
|
1327
1497
|
/**
|
|
1498
|
+
* @public
|
|
1328
1499
|
* <p>The amount of data that was scanned in bytes.</p>
|
|
1329
1500
|
*/
|
|
1330
1501
|
DataScannedBytes?: number;
|
|
1331
1502
|
/**
|
|
1503
|
+
* @public
|
|
1332
1504
|
* <p>The number of work units executed.</p>
|
|
1333
1505
|
*/
|
|
1334
1506
|
WorkUnitsExecutedCount?: number;
|
|
@@ -1339,18 +1511,22 @@ export interface ExecutionStatistics {
|
|
|
1339
1511
|
*/
|
|
1340
1512
|
export interface PlanningStatistics {
|
|
1341
1513
|
/**
|
|
1514
|
+
* @public
|
|
1342
1515
|
* <p>An estimate of the data that was scanned in bytes.</p>
|
|
1343
1516
|
*/
|
|
1344
1517
|
EstimatedDataToScanBytes?: number;
|
|
1345
1518
|
/**
|
|
1519
|
+
* @public
|
|
1346
1520
|
* <p>The time that it took to process the request.</p>
|
|
1347
1521
|
*/
|
|
1348
1522
|
PlanningTimeMillis?: number;
|
|
1349
1523
|
/**
|
|
1524
|
+
* @public
|
|
1350
1525
|
* <p>The time the request was in queue to be processed.</p>
|
|
1351
1526
|
*/
|
|
1352
1527
|
QueueTimeMillis?: number;
|
|
1353
1528
|
/**
|
|
1529
|
+
* @public
|
|
1354
1530
|
* <p>The number of work units generated.</p>
|
|
1355
1531
|
*/
|
|
1356
1532
|
WorkUnitsGeneratedCount?: number;
|
|
@@ -1360,14 +1536,17 @@ export interface PlanningStatistics {
|
|
|
1360
1536
|
*/
|
|
1361
1537
|
export interface GetQueryStatisticsResponse {
|
|
1362
1538
|
/**
|
|
1539
|
+
* @public
|
|
1363
1540
|
* <p>An <code>ExecutionStatistics</code> structure containing execution statistics.</p>
|
|
1364
1541
|
*/
|
|
1365
1542
|
ExecutionStatistics?: ExecutionStatistics;
|
|
1366
1543
|
/**
|
|
1544
|
+
* @public
|
|
1367
1545
|
* <p>A <code>PlanningStatistics</code> structure containing query planning statistics.</p>
|
|
1368
1546
|
*/
|
|
1369
1547
|
PlanningStatistics?: PlanningStatistics;
|
|
1370
1548
|
/**
|
|
1549
|
+
* @public
|
|
1371
1550
|
* <p>The time that the query was submitted.</p>
|
|
1372
1551
|
*/
|
|
1373
1552
|
QuerySubmissionTime?: Date;
|
|
@@ -1380,6 +1559,7 @@ export declare class StatisticsNotReadyYetException extends __BaseException {
|
|
|
1380
1559
|
readonly name: "StatisticsNotReadyYetException";
|
|
1381
1560
|
readonly $fault: "client";
|
|
1382
1561
|
/**
|
|
1562
|
+
* @public
|
|
1383
1563
|
* <p>A message describing the error.</p>
|
|
1384
1564
|
*/
|
|
1385
1565
|
Message?: string;
|
|
@@ -1399,6 +1579,7 @@ export declare class ThrottledException extends __BaseException {
|
|
|
1399
1579
|
throttling: boolean;
|
|
1400
1580
|
};
|
|
1401
1581
|
/**
|
|
1582
|
+
* @public
|
|
1402
1583
|
* <p>A message describing the error.</p>
|
|
1403
1584
|
*/
|
|
1404
1585
|
Message?: string;
|
|
@@ -1412,14 +1593,17 @@ export declare class ThrottledException extends __BaseException {
|
|
|
1412
1593
|
*/
|
|
1413
1594
|
export interface GetResourceLFTagsRequest {
|
|
1414
1595
|
/**
|
|
1596
|
+
* @public
|
|
1415
1597
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1416
1598
|
*/
|
|
1417
1599
|
CatalogId?: string;
|
|
1418
1600
|
/**
|
|
1601
|
+
* @public
|
|
1419
1602
|
* <p>The database, table, or column resource for which you want to return LF-tags.</p>
|
|
1420
1603
|
*/
|
|
1421
1604
|
Resource: Resource | undefined;
|
|
1422
1605
|
/**
|
|
1606
|
+
* @public
|
|
1423
1607
|
* <p>Indicates whether to show the assigned LF-tags.</p>
|
|
1424
1608
|
*/
|
|
1425
1609
|
ShowAssignedLFTags?: boolean;
|
|
@@ -1430,10 +1614,12 @@ export interface GetResourceLFTagsRequest {
|
|
|
1430
1614
|
*/
|
|
1431
1615
|
export interface ColumnLFTag {
|
|
1432
1616
|
/**
|
|
1617
|
+
* @public
|
|
1433
1618
|
* <p>The name of a column resource.</p>
|
|
1434
1619
|
*/
|
|
1435
1620
|
Name?: string;
|
|
1436
1621
|
/**
|
|
1622
|
+
* @public
|
|
1437
1623
|
* <p>The LF-tags attached to a column resource.</p>
|
|
1438
1624
|
*/
|
|
1439
1625
|
LFTags?: LFTagPair[];
|
|
@@ -1443,14 +1629,17 @@ export interface ColumnLFTag {
|
|
|
1443
1629
|
*/
|
|
1444
1630
|
export interface GetResourceLFTagsResponse {
|
|
1445
1631
|
/**
|
|
1632
|
+
* @public
|
|
1446
1633
|
* <p>A list of LF-tags applied to a database resource.</p>
|
|
1447
1634
|
*/
|
|
1448
1635
|
LFTagOnDatabase?: LFTagPair[];
|
|
1449
1636
|
/**
|
|
1637
|
+
* @public
|
|
1450
1638
|
* <p>A list of LF-tags applied to a table resource.</p>
|
|
1451
1639
|
*/
|
|
1452
1640
|
LFTagsOnTable?: LFTagPair[];
|
|
1453
1641
|
/**
|
|
1642
|
+
* @public
|
|
1454
1643
|
* <p>A list of LF-tags applied to a column resource.</p>
|
|
1455
1644
|
*/
|
|
1456
1645
|
LFTagsOnColumns?: ColumnLFTag[];
|
|
@@ -1463,6 +1652,7 @@ export declare class GlueEncryptionException extends __BaseException {
|
|
|
1463
1652
|
readonly name: "GlueEncryptionException";
|
|
1464
1653
|
readonly $fault: "client";
|
|
1465
1654
|
/**
|
|
1655
|
+
* @public
|
|
1466
1656
|
* <p>A message describing the problem.</p>
|
|
1467
1657
|
*/
|
|
1468
1658
|
Message?: string;
|
|
@@ -1476,26 +1666,32 @@ export declare class GlueEncryptionException extends __BaseException {
|
|
|
1476
1666
|
*/
|
|
1477
1667
|
export interface GetTableObjectsRequest {
|
|
1478
1668
|
/**
|
|
1669
|
+
* @public
|
|
1479
1670
|
* <p>The catalog containing the governed table. Defaults to the caller’s account.</p>
|
|
1480
1671
|
*/
|
|
1481
1672
|
CatalogId?: string;
|
|
1482
1673
|
/**
|
|
1674
|
+
* @public
|
|
1483
1675
|
* <p>The database containing the governed table.</p>
|
|
1484
1676
|
*/
|
|
1485
1677
|
DatabaseName: string | undefined;
|
|
1486
1678
|
/**
|
|
1679
|
+
* @public
|
|
1487
1680
|
* <p>The governed table for which to retrieve objects.</p>
|
|
1488
1681
|
*/
|
|
1489
1682
|
TableName: string | undefined;
|
|
1490
1683
|
/**
|
|
1684
|
+
* @public
|
|
1491
1685
|
* <p>The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</p>
|
|
1492
1686
|
*/
|
|
1493
1687
|
TransactionId?: string;
|
|
1494
1688
|
/**
|
|
1689
|
+
* @public
|
|
1495
1690
|
* <p>The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with <code>TransactionId</code>.</p>
|
|
1496
1691
|
*/
|
|
1497
1692
|
QueryAsOfTime?: Date;
|
|
1498
1693
|
/**
|
|
1694
|
+
* @public
|
|
1499
1695
|
* <p>A predicate to filter the objects returned based on the partition keys defined in the governed table.</p>
|
|
1500
1696
|
* <ul>
|
|
1501
1697
|
* <li>
|
|
@@ -1511,10 +1707,12 @@ export interface GetTableObjectsRequest {
|
|
|
1511
1707
|
*/
|
|
1512
1708
|
PartitionPredicate?: string;
|
|
1513
1709
|
/**
|
|
1710
|
+
* @public
|
|
1514
1711
|
* <p>Specifies how many values to return in a page.</p>
|
|
1515
1712
|
*/
|
|
1516
1713
|
MaxResults?: number;
|
|
1517
1714
|
/**
|
|
1715
|
+
* @public
|
|
1518
1716
|
* <p>A continuation token if this is not the first call to retrieve these objects.</p>
|
|
1519
1717
|
*/
|
|
1520
1718
|
NextToken?: string;
|
|
@@ -1525,14 +1723,17 @@ export interface GetTableObjectsRequest {
|
|
|
1525
1723
|
*/
|
|
1526
1724
|
export interface TableObject {
|
|
1527
1725
|
/**
|
|
1726
|
+
* @public
|
|
1528
1727
|
* <p>The Amazon S3 location of the object.</p>
|
|
1529
1728
|
*/
|
|
1530
1729
|
Uri?: string;
|
|
1531
1730
|
/**
|
|
1731
|
+
* @public
|
|
1532
1732
|
* <p>The Amazon S3 ETag of the object. Returned by <code>GetTableObjects</code> for validation and used to identify changes to the underlying data.</p>
|
|
1533
1733
|
*/
|
|
1534
1734
|
ETag?: string;
|
|
1535
1735
|
/**
|
|
1736
|
+
* @public
|
|
1536
1737
|
* <p>The size of the Amazon S3 object in bytes.</p>
|
|
1537
1738
|
*/
|
|
1538
1739
|
Size?: number;
|
|
@@ -1543,10 +1744,12 @@ export interface TableObject {
|
|
|
1543
1744
|
*/
|
|
1544
1745
|
export interface PartitionObjects {
|
|
1545
1746
|
/**
|
|
1747
|
+
* @public
|
|
1546
1748
|
* <p>A list of partition values.</p>
|
|
1547
1749
|
*/
|
|
1548
1750
|
PartitionValues?: string[];
|
|
1549
1751
|
/**
|
|
1752
|
+
* @public
|
|
1550
1753
|
* <p>A list of table objects</p>
|
|
1551
1754
|
*/
|
|
1552
1755
|
Objects?: TableObject[];
|
|
@@ -1556,10 +1759,12 @@ export interface PartitionObjects {
|
|
|
1556
1759
|
*/
|
|
1557
1760
|
export interface GetTableObjectsResponse {
|
|
1558
1761
|
/**
|
|
1762
|
+
* @public
|
|
1559
1763
|
* <p>A list of objects organized by partition keys.</p>
|
|
1560
1764
|
*/
|
|
1561
1765
|
Objects?: PartitionObjects[];
|
|
1562
1766
|
/**
|
|
1767
|
+
* @public
|
|
1563
1768
|
* <p>A continuation token indicating whether additional data is available.</p>
|
|
1564
1769
|
*/
|
|
1565
1770
|
NextToken?: string;
|
|
@@ -1570,6 +1775,7 @@ export interface GetTableObjectsResponse {
|
|
|
1570
1775
|
*/
|
|
1571
1776
|
export interface PartitionValueList {
|
|
1572
1777
|
/**
|
|
1778
|
+
* @public
|
|
1573
1779
|
* <p>The list of partition values.</p>
|
|
1574
1780
|
*/
|
|
1575
1781
|
Values: string[] | undefined;
|
|
@@ -1593,26 +1799,32 @@ export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType
|
|
|
1593
1799
|
*/
|
|
1594
1800
|
export interface GetTemporaryGluePartitionCredentialsRequest {
|
|
1595
1801
|
/**
|
|
1802
|
+
* @public
|
|
1596
1803
|
* <p>The ARN of the partitions' table.</p>
|
|
1597
1804
|
*/
|
|
1598
1805
|
TableArn: string | undefined;
|
|
1599
1806
|
/**
|
|
1807
|
+
* @public
|
|
1600
1808
|
* <p>A list of partition values identifying a single partition.</p>
|
|
1601
1809
|
*/
|
|
1602
1810
|
Partition: PartitionValueList | undefined;
|
|
1603
1811
|
/**
|
|
1812
|
+
* @public
|
|
1604
1813
|
* <p>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</p>
|
|
1605
1814
|
*/
|
|
1606
1815
|
Permissions?: (Permission | string)[];
|
|
1607
1816
|
/**
|
|
1817
|
+
* @public
|
|
1608
1818
|
* <p>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</p>
|
|
1609
1819
|
*/
|
|
1610
1820
|
DurationSeconds?: number;
|
|
1611
1821
|
/**
|
|
1822
|
+
* @public
|
|
1612
1823
|
* <p>A structure representing context to access a resource (column names, query ID, etc).</p>
|
|
1613
1824
|
*/
|
|
1614
1825
|
AuditContext?: AuditContext;
|
|
1615
1826
|
/**
|
|
1827
|
+
* @public
|
|
1616
1828
|
* <p>A list of supported permission types for the partition. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</p>
|
|
1617
1829
|
*/
|
|
1618
1830
|
SupportedPermissionTypes?: (PermissionType | string)[];
|
|
@@ -1622,18 +1834,22 @@ export interface GetTemporaryGluePartitionCredentialsRequest {
|
|
|
1622
1834
|
*/
|
|
1623
1835
|
export interface GetTemporaryGluePartitionCredentialsResponse {
|
|
1624
1836
|
/**
|
|
1837
|
+
* @public
|
|
1625
1838
|
* <p>The access key ID for the temporary credentials.</p>
|
|
1626
1839
|
*/
|
|
1627
1840
|
AccessKeyId?: string;
|
|
1628
1841
|
/**
|
|
1842
|
+
* @public
|
|
1629
1843
|
* <p>The secret key for the temporary credentials.</p>
|
|
1630
1844
|
*/
|
|
1631
1845
|
SecretAccessKey?: string;
|
|
1632
1846
|
/**
|
|
1847
|
+
* @public
|
|
1633
1848
|
* <p>The session token for the temporary credentials.</p>
|
|
1634
1849
|
*/
|
|
1635
1850
|
SessionToken?: string;
|
|
1636
1851
|
/**
|
|
1852
|
+
* @public
|
|
1637
1853
|
* <p>The date and time when the temporary credentials expire.</p>
|
|
1638
1854
|
*/
|
|
1639
1855
|
Expiration?: Date;
|
|
@@ -1646,6 +1862,7 @@ export declare class PermissionTypeMismatchException extends __BaseException {
|
|
|
1646
1862
|
readonly name: "PermissionTypeMismatchException";
|
|
1647
1863
|
readonly $fault: "client";
|
|
1648
1864
|
/**
|
|
1865
|
+
* @public
|
|
1649
1866
|
* <p>A message describing the problem.</p>
|
|
1650
1867
|
*/
|
|
1651
1868
|
Message?: string;
|
|
@@ -1659,22 +1876,27 @@ export declare class PermissionTypeMismatchException extends __BaseException {
|
|
|
1659
1876
|
*/
|
|
1660
1877
|
export interface GetTemporaryGlueTableCredentialsRequest {
|
|
1661
1878
|
/**
|
|
1879
|
+
* @public
|
|
1662
1880
|
* <p>The ARN identifying a table in the Data Catalog for the temporary credentials request.</p>
|
|
1663
1881
|
*/
|
|
1664
1882
|
TableArn: string | undefined;
|
|
1665
1883
|
/**
|
|
1884
|
+
* @public
|
|
1666
1885
|
* <p>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</p>
|
|
1667
1886
|
*/
|
|
1668
1887
|
Permissions?: (Permission | string)[];
|
|
1669
1888
|
/**
|
|
1889
|
+
* @public
|
|
1670
1890
|
* <p>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</p>
|
|
1671
1891
|
*/
|
|
1672
1892
|
DurationSeconds?: number;
|
|
1673
1893
|
/**
|
|
1894
|
+
* @public
|
|
1674
1895
|
* <p>A structure representing context to access a resource (column names, query ID, etc).</p>
|
|
1675
1896
|
*/
|
|
1676
1897
|
AuditContext?: AuditContext;
|
|
1677
1898
|
/**
|
|
1899
|
+
* @public
|
|
1678
1900
|
* <p>A list of supported permission types for the table. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</p>
|
|
1679
1901
|
*/
|
|
1680
1902
|
SupportedPermissionTypes?: (PermissionType | string)[];
|
|
@@ -1684,18 +1906,22 @@ export interface GetTemporaryGlueTableCredentialsRequest {
|
|
|
1684
1906
|
*/
|
|
1685
1907
|
export interface GetTemporaryGlueTableCredentialsResponse {
|
|
1686
1908
|
/**
|
|
1909
|
+
* @public
|
|
1687
1910
|
* <p>The access key ID for the temporary credentials.</p>
|
|
1688
1911
|
*/
|
|
1689
1912
|
AccessKeyId?: string;
|
|
1690
1913
|
/**
|
|
1914
|
+
* @public
|
|
1691
1915
|
* <p>The secret key for the temporary credentials.</p>
|
|
1692
1916
|
*/
|
|
1693
1917
|
SecretAccessKey?: string;
|
|
1694
1918
|
/**
|
|
1919
|
+
* @public
|
|
1695
1920
|
* <p>The session token for the temporary credentials.</p>
|
|
1696
1921
|
*/
|
|
1697
1922
|
SessionToken?: string;
|
|
1698
1923
|
/**
|
|
1924
|
+
* @public
|
|
1699
1925
|
* <p>The date and time when the temporary credentials expire.</p>
|
|
1700
1926
|
*/
|
|
1701
1927
|
Expiration?: Date;
|
|
@@ -1705,14 +1931,17 @@ export interface GetTemporaryGlueTableCredentialsResponse {
|
|
|
1705
1931
|
*/
|
|
1706
1932
|
export interface GetWorkUnitResultsRequest {
|
|
1707
1933
|
/**
|
|
1934
|
+
* @public
|
|
1708
1935
|
* <p>The ID of the plan query operation for which to get results.</p>
|
|
1709
1936
|
*/
|
|
1710
1937
|
QueryId: string | undefined;
|
|
1711
1938
|
/**
|
|
1939
|
+
* @public
|
|
1712
1940
|
* <p>The work unit ID for which to get results. Value generated by enumerating <code>WorkUnitIdMin</code> to <code>WorkUnitIdMax</code> (inclusive) from the <code>WorkUnitRange</code> in the output of <code>GetWorkUnits</code>.</p>
|
|
1713
1941
|
*/
|
|
1714
1942
|
WorkUnitId: number | undefined;
|
|
1715
1943
|
/**
|
|
1944
|
+
* @public
|
|
1716
1945
|
* <p>A work token used to query the execution service. Token output from <code>GetWorkUnits</code>.</p>
|
|
1717
1946
|
*/
|
|
1718
1947
|
WorkUnitToken: string | undefined;
|
|
@@ -1723,6 +1952,7 @@ export interface GetWorkUnitResultsRequest {
|
|
|
1723
1952
|
*/
|
|
1724
1953
|
export interface GetWorkUnitResultsResponse {
|
|
1725
1954
|
/**
|
|
1955
|
+
* @public
|
|
1726
1956
|
* <p>Rows returned from the <code>GetWorkUnitResults</code> operation as a stream of Apache Arrow v1.0 messages.</p>
|
|
1727
1957
|
*/
|
|
1728
1958
|
ResultStream?: StreamingBlobTypes;
|
|
@@ -1732,14 +1962,17 @@ export interface GetWorkUnitResultsResponse {
|
|
|
1732
1962
|
*/
|
|
1733
1963
|
export interface GetWorkUnitsRequest {
|
|
1734
1964
|
/**
|
|
1965
|
+
* @public
|
|
1735
1966
|
* <p>A continuation token, if this is a continuation call.</p>
|
|
1736
1967
|
*/
|
|
1737
1968
|
NextToken?: string;
|
|
1738
1969
|
/**
|
|
1970
|
+
* @public
|
|
1739
1971
|
* <p>The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.</p>
|
|
1740
1972
|
*/
|
|
1741
1973
|
PageSize?: number;
|
|
1742
1974
|
/**
|
|
1975
|
+
* @public
|
|
1743
1976
|
* <p>The ID of the plan query operation.</p>
|
|
1744
1977
|
*/
|
|
1745
1978
|
QueryId: string | undefined;
|
|
@@ -1750,14 +1983,17 @@ export interface GetWorkUnitsRequest {
|
|
|
1750
1983
|
*/
|
|
1751
1984
|
export interface WorkUnitRange {
|
|
1752
1985
|
/**
|
|
1986
|
+
* @public
|
|
1753
1987
|
* <p>Defines the maximum work unit ID in the range. The maximum value is inclusive.</p>
|
|
1754
1988
|
*/
|
|
1755
1989
|
WorkUnitIdMax: number | undefined;
|
|
1756
1990
|
/**
|
|
1991
|
+
* @public
|
|
1757
1992
|
* <p>Defines the minimum work unit ID in the range.</p>
|
|
1758
1993
|
*/
|
|
1759
1994
|
WorkUnitIdMin: number | undefined;
|
|
1760
1995
|
/**
|
|
1996
|
+
* @public
|
|
1761
1997
|
* <p>A work token used to query the execution service.</p>
|
|
1762
1998
|
*/
|
|
1763
1999
|
WorkUnitToken: string | undefined;
|
|
@@ -1768,14 +2004,17 @@ export interface WorkUnitRange {
|
|
|
1768
2004
|
*/
|
|
1769
2005
|
export interface GetWorkUnitsResponse {
|
|
1770
2006
|
/**
|
|
2007
|
+
* @public
|
|
1771
2008
|
* <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
|
|
1772
2009
|
*/
|
|
1773
2010
|
NextToken?: string;
|
|
1774
2011
|
/**
|
|
2012
|
+
* @public
|
|
1775
2013
|
* <p>The ID of the plan query operation.</p>
|
|
1776
2014
|
*/
|
|
1777
2015
|
QueryId: string | undefined;
|
|
1778
2016
|
/**
|
|
2017
|
+
* @public
|
|
1779
2018
|
* <p>A <code>WorkUnitRangeList</code> object that specifies the valid range of work unit IDs for querying the execution service.</p>
|
|
1780
2019
|
*/
|
|
1781
2020
|
WorkUnitRanges: WorkUnitRange[] | undefined;
|
|
@@ -1788,6 +2027,7 @@ export declare class WorkUnitsNotReadyYetException extends __BaseException {
|
|
|
1788
2027
|
readonly name: "WorkUnitsNotReadyYetException";
|
|
1789
2028
|
readonly $fault: "client";
|
|
1790
2029
|
/**
|
|
2030
|
+
* @public
|
|
1791
2031
|
* <p>A message describing the error.</p>
|
|
1792
2032
|
*/
|
|
1793
2033
|
Message?: string;
|
|
@@ -1801,23 +2041,28 @@ export declare class WorkUnitsNotReadyYetException extends __BaseException {
|
|
|
1801
2041
|
*/
|
|
1802
2042
|
export interface GrantPermissionsRequest {
|
|
1803
2043
|
/**
|
|
2044
|
+
* @public
|
|
1804
2045
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1805
2046
|
*/
|
|
1806
2047
|
CatalogId?: string;
|
|
1807
2048
|
/**
|
|
2049
|
+
* @public
|
|
1808
2050
|
* <p>The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.</p>
|
|
1809
2051
|
* <p>Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted. </p>
|
|
1810
2052
|
*/
|
|
1811
2053
|
Principal: DataLakePrincipal | undefined;
|
|
1812
2054
|
/**
|
|
2055
|
+
* @public
|
|
1813
2056
|
* <p>The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.</p>
|
|
1814
2057
|
*/
|
|
1815
2058
|
Resource: Resource | undefined;
|
|
1816
2059
|
/**
|
|
2060
|
+
* @public
|
|
1817
2061
|
* <p>The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources. </p>
|
|
1818
2062
|
*/
|
|
1819
2063
|
Permissions: (Permission | string)[] | undefined;
|
|
1820
2064
|
/**
|
|
2065
|
+
* @public
|
|
1821
2066
|
* <p>Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the <code>Privileges</code>.</p>
|
|
1822
2067
|
*/
|
|
1823
2068
|
PermissionsWithGrantOption?: (Permission | string)[];
|
|
@@ -1832,14 +2077,17 @@ export interface GrantPermissionsResponse {
|
|
|
1832
2077
|
*/
|
|
1833
2078
|
export interface ListDataCellsFilterRequest {
|
|
1834
2079
|
/**
|
|
2080
|
+
* @public
|
|
1835
2081
|
* <p>A table in the Glue Data Catalog.</p>
|
|
1836
2082
|
*/
|
|
1837
2083
|
Table?: TableResource;
|
|
1838
2084
|
/**
|
|
2085
|
+
* @public
|
|
1839
2086
|
* <p>A continuation token, if this is a continuation call.</p>
|
|
1840
2087
|
*/
|
|
1841
2088
|
NextToken?: string;
|
|
1842
2089
|
/**
|
|
2090
|
+
* @public
|
|
1843
2091
|
* <p>The maximum size of the response.</p>
|
|
1844
2092
|
*/
|
|
1845
2093
|
MaxResults?: number;
|
|
@@ -1849,10 +2097,12 @@ export interface ListDataCellsFilterRequest {
|
|
|
1849
2097
|
*/
|
|
1850
2098
|
export interface ListDataCellsFilterResponse {
|
|
1851
2099
|
/**
|
|
2100
|
+
* @public
|
|
1852
2101
|
* <p>A list of <code>DataCellFilter</code> structures.</p>
|
|
1853
2102
|
*/
|
|
1854
2103
|
DataCellsFilters?: DataCellsFilter[];
|
|
1855
2104
|
/**
|
|
2105
|
+
* @public
|
|
1856
2106
|
* <p>A continuation token, if not all requested data cell filters have been returned.</p>
|
|
1857
2107
|
*/
|
|
1858
2108
|
NextToken?: string;
|
|
@@ -1874,18 +2124,22 @@ export type ResourceShareType = (typeof ResourceShareType)[keyof typeof Resource
|
|
|
1874
2124
|
*/
|
|
1875
2125
|
export interface ListLFTagsRequest {
|
|
1876
2126
|
/**
|
|
2127
|
+
* @public
|
|
1877
2128
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1878
2129
|
*/
|
|
1879
2130
|
CatalogId?: string;
|
|
1880
2131
|
/**
|
|
2132
|
+
* @public
|
|
1881
2133
|
* <p>If resource share type is <code>ALL</code>, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is <code>FOREIGN</code>, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.</p>
|
|
1882
2134
|
*/
|
|
1883
2135
|
ResourceShareType?: ResourceShareType | string;
|
|
1884
2136
|
/**
|
|
2137
|
+
* @public
|
|
1885
2138
|
* <p>The maximum number of results to return.</p>
|
|
1886
2139
|
*/
|
|
1887
2140
|
MaxResults?: number;
|
|
1888
2141
|
/**
|
|
2142
|
+
* @public
|
|
1889
2143
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
1890
2144
|
*/
|
|
1891
2145
|
NextToken?: string;
|
|
@@ -1895,10 +2149,12 @@ export interface ListLFTagsRequest {
|
|
|
1895
2149
|
*/
|
|
1896
2150
|
export interface ListLFTagsResponse {
|
|
1897
2151
|
/**
|
|
2152
|
+
* @public
|
|
1898
2153
|
* <p>A list of LF-tags that the requested has permission to view.</p>
|
|
1899
2154
|
*/
|
|
1900
2155
|
LFTags?: LFTagPair[];
|
|
1901
2156
|
/**
|
|
2157
|
+
* @public
|
|
1902
2158
|
* <p>A continuation token, present if the current list segment is not the last.</p>
|
|
1903
2159
|
*/
|
|
1904
2160
|
NextToken?: string;
|
|
@@ -1926,31 +2182,38 @@ export type DataLakeResourceType = (typeof DataLakeResourceType)[keyof typeof Da
|
|
|
1926
2182
|
*/
|
|
1927
2183
|
export interface ListPermissionsRequest {
|
|
1928
2184
|
/**
|
|
2185
|
+
* @public
|
|
1929
2186
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
1930
2187
|
*/
|
|
1931
2188
|
CatalogId?: string;
|
|
1932
2189
|
/**
|
|
2190
|
+
* @public
|
|
1933
2191
|
* <p>Specifies a principal to filter the permissions returned.</p>
|
|
1934
2192
|
*/
|
|
1935
2193
|
Principal?: DataLakePrincipal;
|
|
1936
2194
|
/**
|
|
2195
|
+
* @public
|
|
1937
2196
|
* <p>Specifies a resource type to filter the permissions returned.</p>
|
|
1938
2197
|
*/
|
|
1939
2198
|
ResourceType?: DataLakeResourceType | string;
|
|
1940
2199
|
/**
|
|
2200
|
+
* @public
|
|
1941
2201
|
* <p>A resource where you will get a list of the principal permissions.</p>
|
|
1942
2202
|
* <p>This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.</p>
|
|
1943
2203
|
*/
|
|
1944
2204
|
Resource?: Resource;
|
|
1945
2205
|
/**
|
|
2206
|
+
* @public
|
|
1946
2207
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
1947
2208
|
*/
|
|
1948
2209
|
NextToken?: string;
|
|
1949
2210
|
/**
|
|
2211
|
+
* @public
|
|
1950
2212
|
* <p>The maximum number of results to return.</p>
|
|
1951
2213
|
*/
|
|
1952
2214
|
MaxResults?: number;
|
|
1953
2215
|
/**
|
|
2216
|
+
* @public
|
|
1954
2217
|
* <p>Indicates that related permissions should be included in the results.</p>
|
|
1955
2218
|
*/
|
|
1956
2219
|
IncludeRelated?: string;
|
|
@@ -1960,10 +2223,12 @@ export interface ListPermissionsRequest {
|
|
|
1960
2223
|
*/
|
|
1961
2224
|
export interface ListPermissionsResponse {
|
|
1962
2225
|
/**
|
|
2226
|
+
* @public
|
|
1963
2227
|
* <p>A list of principals and their permissions on the resource for the specified principal and resource types.</p>
|
|
1964
2228
|
*/
|
|
1965
2229
|
PrincipalResourcePermissions?: PrincipalResourcePermissions[];
|
|
1966
2230
|
/**
|
|
2231
|
+
* @public
|
|
1967
2232
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
1968
2233
|
*/
|
|
1969
2234
|
NextToken?: string;
|
|
@@ -2008,14 +2273,17 @@ export type FieldNameString = (typeof FieldNameString)[keyof typeof FieldNameStr
|
|
|
2008
2273
|
*/
|
|
2009
2274
|
export interface FilterCondition {
|
|
2010
2275
|
/**
|
|
2276
|
+
* @public
|
|
2011
2277
|
* <p>The field to filter in the filter condition.</p>
|
|
2012
2278
|
*/
|
|
2013
2279
|
Field?: FieldNameString | string;
|
|
2014
2280
|
/**
|
|
2281
|
+
* @public
|
|
2015
2282
|
* <p>The comparison operator used in the filter condition.</p>
|
|
2016
2283
|
*/
|
|
2017
2284
|
ComparisonOperator?: ComparisonOperator | string;
|
|
2018
2285
|
/**
|
|
2286
|
+
* @public
|
|
2019
2287
|
* <p>A string with values used in evaluating the filter condition.</p>
|
|
2020
2288
|
*/
|
|
2021
2289
|
StringValueList?: string[];
|
|
@@ -2025,14 +2293,17 @@ export interface FilterCondition {
|
|
|
2025
2293
|
*/
|
|
2026
2294
|
export interface ListResourcesRequest {
|
|
2027
2295
|
/**
|
|
2296
|
+
* @public
|
|
2028
2297
|
* <p>Any applicable row-level and/or column-level filtering conditions for the resources.</p>
|
|
2029
2298
|
*/
|
|
2030
2299
|
FilterConditionList?: FilterCondition[];
|
|
2031
2300
|
/**
|
|
2301
|
+
* @public
|
|
2032
2302
|
* <p>The maximum number of resource results.</p>
|
|
2033
2303
|
*/
|
|
2034
2304
|
MaxResults?: number;
|
|
2035
2305
|
/**
|
|
2306
|
+
* @public
|
|
2036
2307
|
* <p>A continuation token, if this is not the first call to retrieve these resources.</p>
|
|
2037
2308
|
*/
|
|
2038
2309
|
NextToken?: string;
|
|
@@ -2042,10 +2313,12 @@ export interface ListResourcesRequest {
|
|
|
2042
2313
|
*/
|
|
2043
2314
|
export interface ListResourcesResponse {
|
|
2044
2315
|
/**
|
|
2316
|
+
* @public
|
|
2045
2317
|
* <p>A summary of the data lake resources.</p>
|
|
2046
2318
|
*/
|
|
2047
2319
|
ResourceInfoList?: ResourceInfo[];
|
|
2048
2320
|
/**
|
|
2321
|
+
* @public
|
|
2049
2322
|
* <p>A continuation token, if this is not the first call to retrieve these resources.</p>
|
|
2050
2323
|
*/
|
|
2051
2324
|
NextToken?: string;
|
|
@@ -2068,26 +2341,32 @@ export type OptimizerType = (typeof OptimizerType)[keyof typeof OptimizerType];
|
|
|
2068
2341
|
*/
|
|
2069
2342
|
export interface ListTableStorageOptimizersRequest {
|
|
2070
2343
|
/**
|
|
2344
|
+
* @public
|
|
2071
2345
|
* <p>The Catalog ID of the table.</p>
|
|
2072
2346
|
*/
|
|
2073
2347
|
CatalogId?: string;
|
|
2074
2348
|
/**
|
|
2349
|
+
* @public
|
|
2075
2350
|
* <p>Name of the database where the table is present.</p>
|
|
2076
2351
|
*/
|
|
2077
2352
|
DatabaseName: string | undefined;
|
|
2078
2353
|
/**
|
|
2354
|
+
* @public
|
|
2079
2355
|
* <p>Name of the table.</p>
|
|
2080
2356
|
*/
|
|
2081
2357
|
TableName: string | undefined;
|
|
2082
2358
|
/**
|
|
2359
|
+
* @public
|
|
2083
2360
|
* <p>The specific type of storage optimizers to list. The supported value is <code>compaction</code>.</p>
|
|
2084
2361
|
*/
|
|
2085
2362
|
StorageOptimizerType?: OptimizerType | string;
|
|
2086
2363
|
/**
|
|
2364
|
+
* @public
|
|
2087
2365
|
* <p>The number of storage optimizers to return on each call.</p>
|
|
2088
2366
|
*/
|
|
2089
2367
|
MaxResults?: number;
|
|
2090
2368
|
/**
|
|
2369
|
+
* @public
|
|
2091
2370
|
* <p>A continuation token, if this is a continuation call.</p>
|
|
2092
2371
|
*/
|
|
2093
2372
|
NextToken?: string;
|
|
@@ -2098,24 +2377,29 @@ export interface ListTableStorageOptimizersRequest {
|
|
|
2098
2377
|
*/
|
|
2099
2378
|
export interface StorageOptimizer {
|
|
2100
2379
|
/**
|
|
2380
|
+
* @public
|
|
2101
2381
|
* <p>The specific type of storage optimizer. The supported value is <code>compaction</code>.</p>
|
|
2102
2382
|
*/
|
|
2103
2383
|
StorageOptimizerType?: OptimizerType | string;
|
|
2104
2384
|
/**
|
|
2385
|
+
* @public
|
|
2105
2386
|
* <p>A map of the storage optimizer configuration. Currently contains only one key-value pair: <code>is_enabled</code> indicates true or false for acceleration.</p>
|
|
2106
2387
|
*/
|
|
2107
2388
|
Config?: Record<string, string>;
|
|
2108
2389
|
/**
|
|
2390
|
+
* @public
|
|
2109
2391
|
* <p>A message that contains information about any error (if present).</p>
|
|
2110
2392
|
* <p>When an acceleration result has an enabled status, the error message is empty.</p>
|
|
2111
2393
|
* <p>When an acceleration result has a disabled status, the message describes an error or simply indicates "disabled by the user".</p>
|
|
2112
2394
|
*/
|
|
2113
2395
|
ErrorMessage?: string;
|
|
2114
2396
|
/**
|
|
2397
|
+
* @public
|
|
2115
2398
|
* <p>A message that contains information about any warnings (if present).</p>
|
|
2116
2399
|
*/
|
|
2117
2400
|
Warnings?: string;
|
|
2118
2401
|
/**
|
|
2402
|
+
* @public
|
|
2119
2403
|
* <p>When an acceleration result has an enabled status, contains the details of the last job run.</p>
|
|
2120
2404
|
*/
|
|
2121
2405
|
LastRunDetails?: string;
|
|
@@ -2125,10 +2409,12 @@ export interface StorageOptimizer {
|
|
|
2125
2409
|
*/
|
|
2126
2410
|
export interface ListTableStorageOptimizersResponse {
|
|
2127
2411
|
/**
|
|
2412
|
+
* @public
|
|
2128
2413
|
* <p>A list of the storage optimizers associated with a table.</p>
|
|
2129
2414
|
*/
|
|
2130
2415
|
StorageOptimizerList?: StorageOptimizer[];
|
|
2131
2416
|
/**
|
|
2417
|
+
* @public
|
|
2132
2418
|
* <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
|
|
2133
2419
|
*/
|
|
2134
2420
|
NextToken?: string;
|
|
@@ -2153,18 +2439,22 @@ export type TransactionStatusFilter = (typeof TransactionStatusFilter)[keyof typ
|
|
|
2153
2439
|
*/
|
|
2154
2440
|
export interface ListTransactionsRequest {
|
|
2155
2441
|
/**
|
|
2442
|
+
* @public
|
|
2156
2443
|
* <p>The catalog for which to list transactions. Defaults to the account ID of the caller.</p>
|
|
2157
2444
|
*/
|
|
2158
2445
|
CatalogId?: string;
|
|
2159
2446
|
/**
|
|
2447
|
+
* @public
|
|
2160
2448
|
* <p> A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is <code>ALL</code>.</p>
|
|
2161
2449
|
*/
|
|
2162
2450
|
StatusFilter?: TransactionStatusFilter | string;
|
|
2163
2451
|
/**
|
|
2452
|
+
* @public
|
|
2164
2453
|
* <p>The maximum number of transactions to return in a single call.</p>
|
|
2165
2454
|
*/
|
|
2166
2455
|
MaxResults?: number;
|
|
2167
2456
|
/**
|
|
2457
|
+
* @public
|
|
2168
2458
|
* <p>A continuation token if this is not the first call to retrieve transactions.</p>
|
|
2169
2459
|
*/
|
|
2170
2460
|
NextToken?: string;
|
|
@@ -2174,10 +2464,12 @@ export interface ListTransactionsRequest {
|
|
|
2174
2464
|
*/
|
|
2175
2465
|
export interface ListTransactionsResponse {
|
|
2176
2466
|
/**
|
|
2467
|
+
* @public
|
|
2177
2468
|
* <p>A list of transactions. The record for each transaction is a <code>TransactionDescription</code> object.</p>
|
|
2178
2469
|
*/
|
|
2179
2470
|
Transactions?: TransactionDescription[];
|
|
2180
2471
|
/**
|
|
2472
|
+
* @public
|
|
2181
2473
|
* <p>A continuation token indicating whether additional data is available.</p>
|
|
2182
2474
|
*/
|
|
2183
2475
|
NextToken?: string;
|
|
@@ -2187,10 +2479,12 @@ export interface ListTransactionsResponse {
|
|
|
2187
2479
|
*/
|
|
2188
2480
|
export interface PutDataLakeSettingsRequest {
|
|
2189
2481
|
/**
|
|
2482
|
+
* @public
|
|
2190
2483
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2191
2484
|
*/
|
|
2192
2485
|
CatalogId?: string;
|
|
2193
2486
|
/**
|
|
2487
|
+
* @public
|
|
2194
2488
|
* <p>A structure representing a list of Lake Formation principals designated as data lake administrators.</p>
|
|
2195
2489
|
*/
|
|
2196
2490
|
DataLakeSettings: DataLakeSettings | undefined;
|
|
@@ -2205,19 +2499,23 @@ export interface PutDataLakeSettingsResponse {
|
|
|
2205
2499
|
*/
|
|
2206
2500
|
export interface RegisterResourceRequest {
|
|
2207
2501
|
/**
|
|
2502
|
+
* @public
|
|
2208
2503
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to register.</p>
|
|
2209
2504
|
*/
|
|
2210
2505
|
ResourceArn: string | undefined;
|
|
2211
2506
|
/**
|
|
2507
|
+
* @public
|
|
2212
2508
|
* <p>Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.</p>
|
|
2213
2509
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.</p>
|
|
2214
2510
|
*/
|
|
2215
2511
|
UseServiceLinkedRole?: boolean;
|
|
2216
2512
|
/**
|
|
2513
|
+
* @public
|
|
2217
2514
|
* <p>The identifier for the role that registers the resource.</p>
|
|
2218
2515
|
*/
|
|
2219
2516
|
RoleArn?: string;
|
|
2220
2517
|
/**
|
|
2518
|
+
* @public
|
|
2221
2519
|
* <p>Whether or not the resource is a federated resource.</p>
|
|
2222
2520
|
*/
|
|
2223
2521
|
WithFederation?: boolean;
|
|
@@ -2232,14 +2530,17 @@ export interface RegisterResourceResponse {
|
|
|
2232
2530
|
*/
|
|
2233
2531
|
export interface RemoveLFTagsFromResourceRequest {
|
|
2234
2532
|
/**
|
|
2533
|
+
* @public
|
|
2235
2534
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2236
2535
|
*/
|
|
2237
2536
|
CatalogId?: string;
|
|
2238
2537
|
/**
|
|
2538
|
+
* @public
|
|
2239
2539
|
* <p>The database, table, or column resource where you want to remove an LF-tag.</p>
|
|
2240
2540
|
*/
|
|
2241
2541
|
Resource: Resource | undefined;
|
|
2242
2542
|
/**
|
|
2543
|
+
* @public
|
|
2243
2544
|
* <p>The LF-tags to be removed from the resource.</p>
|
|
2244
2545
|
*/
|
|
2245
2546
|
LFTags: LFTagPair[] | undefined;
|
|
@@ -2249,6 +2550,7 @@ export interface RemoveLFTagsFromResourceRequest {
|
|
|
2249
2550
|
*/
|
|
2250
2551
|
export interface RemoveLFTagsFromResourceResponse {
|
|
2251
2552
|
/**
|
|
2553
|
+
* @public
|
|
2252
2554
|
* <p>A list of failures to untag a resource.</p>
|
|
2253
2555
|
*/
|
|
2254
2556
|
Failures?: LFTagError[];
|
|
@@ -2258,23 +2560,28 @@ export interface RemoveLFTagsFromResourceResponse {
|
|
|
2258
2560
|
*/
|
|
2259
2561
|
export interface RevokePermissionsRequest {
|
|
2260
2562
|
/**
|
|
2563
|
+
* @public
|
|
2261
2564
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2262
2565
|
*/
|
|
2263
2566
|
CatalogId?: string;
|
|
2264
2567
|
/**
|
|
2568
|
+
* @public
|
|
2265
2569
|
* <p>The principal to be revoked permissions on the resource.</p>
|
|
2266
2570
|
*/
|
|
2267
2571
|
Principal: DataLakePrincipal | undefined;
|
|
2268
2572
|
/**
|
|
2573
|
+
* @public
|
|
2269
2574
|
* <p>The resource to which permissions are to be revoked.</p>
|
|
2270
2575
|
*/
|
|
2271
2576
|
Resource: Resource | undefined;
|
|
2272
2577
|
/**
|
|
2578
|
+
* @public
|
|
2273
2579
|
* <p>The permissions revoked to the principal on the resource. For information about permissions, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security
|
|
2274
2580
|
* and Access Control to Metadata and Data</a>.</p>
|
|
2275
2581
|
*/
|
|
2276
2582
|
Permissions: (Permission | string)[] | undefined;
|
|
2277
2583
|
/**
|
|
2584
|
+
* @public
|
|
2278
2585
|
* <p>Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.</p>
|
|
2279
2586
|
*/
|
|
2280
2587
|
PermissionsWithGrantOption?: (Permission | string)[];
|
|
@@ -2289,18 +2596,22 @@ export interface RevokePermissionsResponse {
|
|
|
2289
2596
|
*/
|
|
2290
2597
|
export interface SearchDatabasesByLFTagsRequest {
|
|
2291
2598
|
/**
|
|
2599
|
+
* @public
|
|
2292
2600
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
2293
2601
|
*/
|
|
2294
2602
|
NextToken?: string;
|
|
2295
2603
|
/**
|
|
2604
|
+
* @public
|
|
2296
2605
|
* <p>The maximum number of results to return.</p>
|
|
2297
2606
|
*/
|
|
2298
2607
|
MaxResults?: number;
|
|
2299
2608
|
/**
|
|
2609
|
+
* @public
|
|
2300
2610
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2301
2611
|
*/
|
|
2302
2612
|
CatalogId?: string;
|
|
2303
2613
|
/**
|
|
2614
|
+
* @public
|
|
2304
2615
|
* <p>A list of conditions (<code>LFTag</code> structures) to search for in database resources.</p>
|
|
2305
2616
|
*/
|
|
2306
2617
|
Expression: LFTag[] | undefined;
|
|
@@ -2311,10 +2622,12 @@ export interface SearchDatabasesByLFTagsRequest {
|
|
|
2311
2622
|
*/
|
|
2312
2623
|
export interface TaggedDatabase {
|
|
2313
2624
|
/**
|
|
2625
|
+
* @public
|
|
2314
2626
|
* <p>A database that has LF-tags attached to it.</p>
|
|
2315
2627
|
*/
|
|
2316
2628
|
Database?: DatabaseResource;
|
|
2317
2629
|
/**
|
|
2630
|
+
* @public
|
|
2318
2631
|
* <p>A list of LF-tags attached to the database.</p>
|
|
2319
2632
|
*/
|
|
2320
2633
|
LFTags?: LFTagPair[];
|
|
@@ -2324,10 +2637,12 @@ export interface TaggedDatabase {
|
|
|
2324
2637
|
*/
|
|
2325
2638
|
export interface SearchDatabasesByLFTagsResponse {
|
|
2326
2639
|
/**
|
|
2640
|
+
* @public
|
|
2327
2641
|
* <p>A continuation token, present if the current list segment is not the last.</p>
|
|
2328
2642
|
*/
|
|
2329
2643
|
NextToken?: string;
|
|
2330
2644
|
/**
|
|
2645
|
+
* @public
|
|
2331
2646
|
* <p>A list of databases that meet the LF-tag conditions.</p>
|
|
2332
2647
|
*/
|
|
2333
2648
|
DatabaseList?: TaggedDatabase[];
|
|
@@ -2337,18 +2652,22 @@ export interface SearchDatabasesByLFTagsResponse {
|
|
|
2337
2652
|
*/
|
|
2338
2653
|
export interface SearchTablesByLFTagsRequest {
|
|
2339
2654
|
/**
|
|
2655
|
+
* @public
|
|
2340
2656
|
* <p>A continuation token, if this is not the first call to retrieve this list.</p>
|
|
2341
2657
|
*/
|
|
2342
2658
|
NextToken?: string;
|
|
2343
2659
|
/**
|
|
2660
|
+
* @public
|
|
2344
2661
|
* <p>The maximum number of results to return.</p>
|
|
2345
2662
|
*/
|
|
2346
2663
|
MaxResults?: number;
|
|
2347
2664
|
/**
|
|
2665
|
+
* @public
|
|
2348
2666
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2349
2667
|
*/
|
|
2350
2668
|
CatalogId?: string;
|
|
2351
2669
|
/**
|
|
2670
|
+
* @public
|
|
2352
2671
|
* <p>A list of conditions (<code>LFTag</code> structures) to search for in table resources.</p>
|
|
2353
2672
|
*/
|
|
2354
2673
|
Expression: LFTag[] | undefined;
|
|
@@ -2359,18 +2678,22 @@ export interface SearchTablesByLFTagsRequest {
|
|
|
2359
2678
|
*/
|
|
2360
2679
|
export interface TaggedTable {
|
|
2361
2680
|
/**
|
|
2681
|
+
* @public
|
|
2362
2682
|
* <p>A table that has LF-tags attached to it.</p>
|
|
2363
2683
|
*/
|
|
2364
2684
|
Table?: TableResource;
|
|
2365
2685
|
/**
|
|
2686
|
+
* @public
|
|
2366
2687
|
* <p>A list of LF-tags attached to the database where the table resides.</p>
|
|
2367
2688
|
*/
|
|
2368
2689
|
LFTagOnDatabase?: LFTagPair[];
|
|
2369
2690
|
/**
|
|
2691
|
+
* @public
|
|
2370
2692
|
* <p>A list of LF-tags attached to the table.</p>
|
|
2371
2693
|
*/
|
|
2372
2694
|
LFTagsOnTable?: LFTagPair[];
|
|
2373
2695
|
/**
|
|
2696
|
+
* @public
|
|
2374
2697
|
* <p>A list of LF-tags attached to columns in the table.</p>
|
|
2375
2698
|
*/
|
|
2376
2699
|
LFTagsOnColumns?: ColumnLFTag[];
|
|
@@ -2380,10 +2703,12 @@ export interface TaggedTable {
|
|
|
2380
2703
|
*/
|
|
2381
2704
|
export interface SearchTablesByLFTagsResponse {
|
|
2382
2705
|
/**
|
|
2706
|
+
* @public
|
|
2383
2707
|
* <p>A continuation token, present if the current list segment is not the last.</p>
|
|
2384
2708
|
*/
|
|
2385
2709
|
NextToken?: string;
|
|
2386
2710
|
/**
|
|
2711
|
+
* @public
|
|
2387
2712
|
* <p>A list of tables that meet the LF-tag conditions.</p>
|
|
2388
2713
|
*/
|
|
2389
2714
|
TableList?: TaggedTable[];
|
|
@@ -2394,22 +2719,27 @@ export interface SearchTablesByLFTagsResponse {
|
|
|
2394
2719
|
*/
|
|
2395
2720
|
export interface QueryPlanningContext {
|
|
2396
2721
|
/**
|
|
2722
|
+
* @public
|
|
2397
2723
|
* <p>The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.</p>
|
|
2398
2724
|
*/
|
|
2399
2725
|
CatalogId?: string;
|
|
2400
2726
|
/**
|
|
2727
|
+
* @public
|
|
2401
2728
|
* <p>The database containing the table.</p>
|
|
2402
2729
|
*/
|
|
2403
2730
|
DatabaseName: string | undefined;
|
|
2404
2731
|
/**
|
|
2732
|
+
* @public
|
|
2405
2733
|
* <p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>
|
|
2406
2734
|
*/
|
|
2407
2735
|
QueryAsOfTime?: Date;
|
|
2408
2736
|
/**
|
|
2737
|
+
* @public
|
|
2409
2738
|
* <p>A map consisting of key-value pairs.</p>
|
|
2410
2739
|
*/
|
|
2411
2740
|
QueryParameters?: Record<string, string>;
|
|
2412
2741
|
/**
|
|
2742
|
+
* @public
|
|
2413
2743
|
* <p>The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</p>
|
|
2414
2744
|
*/
|
|
2415
2745
|
TransactionId?: string;
|
|
@@ -2419,10 +2749,12 @@ export interface QueryPlanningContext {
|
|
|
2419
2749
|
*/
|
|
2420
2750
|
export interface StartQueryPlanningRequest {
|
|
2421
2751
|
/**
|
|
2752
|
+
* @public
|
|
2422
2753
|
* <p>A structure containing information about the query plan.</p>
|
|
2423
2754
|
*/
|
|
2424
2755
|
QueryPlanningContext: QueryPlanningContext | undefined;
|
|
2425
2756
|
/**
|
|
2757
|
+
* @public
|
|
2426
2758
|
* <p>A PartiQL query statement used as an input to the planner service.</p>
|
|
2427
2759
|
*/
|
|
2428
2760
|
QueryString: string | undefined;
|
|
@@ -2433,6 +2765,7 @@ export interface StartQueryPlanningRequest {
|
|
|
2433
2765
|
*/
|
|
2434
2766
|
export interface StartQueryPlanningResponse {
|
|
2435
2767
|
/**
|
|
2768
|
+
* @public
|
|
2436
2769
|
* <p>The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the <code>Execute</code> operation.</p>
|
|
2437
2770
|
*/
|
|
2438
2771
|
QueryId: string | undefined;
|
|
@@ -2454,6 +2787,7 @@ export type TransactionType = (typeof TransactionType)[keyof typeof TransactionT
|
|
|
2454
2787
|
*/
|
|
2455
2788
|
export interface StartTransactionRequest {
|
|
2456
2789
|
/**
|
|
2790
|
+
* @public
|
|
2457
2791
|
* <p>Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed. </p>
|
|
2458
2792
|
*/
|
|
2459
2793
|
TransactionType?: TransactionType | string;
|
|
@@ -2463,6 +2797,7 @@ export interface StartTransactionRequest {
|
|
|
2463
2797
|
*/
|
|
2464
2798
|
export interface StartTransactionResponse {
|
|
2465
2799
|
/**
|
|
2800
|
+
* @public
|
|
2466
2801
|
* <p>An opaque identifier for the transaction.</p>
|
|
2467
2802
|
*/
|
|
2468
2803
|
TransactionId?: string;
|
|
@@ -2472,6 +2807,7 @@ export interface StartTransactionResponse {
|
|
|
2472
2807
|
*/
|
|
2473
2808
|
export interface UpdateDataCellsFilterRequest {
|
|
2474
2809
|
/**
|
|
2810
|
+
* @public
|
|
2475
2811
|
* <p>A <code>DataCellsFilter</code> structure containing information about the data cells filter.</p>
|
|
2476
2812
|
*/
|
|
2477
2813
|
TableData: DataCellsFilter | undefined;
|
|
@@ -2486,18 +2822,22 @@ export interface UpdateDataCellsFilterResponse {
|
|
|
2486
2822
|
*/
|
|
2487
2823
|
export interface UpdateLFTagRequest {
|
|
2488
2824
|
/**
|
|
2825
|
+
* @public
|
|
2489
2826
|
* <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
|
|
2490
2827
|
*/
|
|
2491
2828
|
CatalogId?: string;
|
|
2492
2829
|
/**
|
|
2830
|
+
* @public
|
|
2493
2831
|
* <p>The key-name for the LF-tag for which to add or delete values.</p>
|
|
2494
2832
|
*/
|
|
2495
2833
|
TagKey: string | undefined;
|
|
2496
2834
|
/**
|
|
2835
|
+
* @public
|
|
2497
2836
|
* <p>A list of LF-tag values to delete from the LF-tag.</p>
|
|
2498
2837
|
*/
|
|
2499
2838
|
TagValuesToDelete?: string[];
|
|
2500
2839
|
/**
|
|
2840
|
+
* @public
|
|
2501
2841
|
* <p>A list of LF-tag values to add from the LF-tag.</p>
|
|
2502
2842
|
*/
|
|
2503
2843
|
TagValuesToAdd?: string[];
|
|
@@ -2512,14 +2852,17 @@ export interface UpdateLFTagResponse {
|
|
|
2512
2852
|
*/
|
|
2513
2853
|
export interface UpdateResourceRequest {
|
|
2514
2854
|
/**
|
|
2855
|
+
* @public
|
|
2515
2856
|
* <p>The new role to use for the given resource registered in Lake Formation.</p>
|
|
2516
2857
|
*/
|
|
2517
2858
|
RoleArn: string | undefined;
|
|
2518
2859
|
/**
|
|
2860
|
+
* @public
|
|
2519
2861
|
* <p>The resource ARN.</p>
|
|
2520
2862
|
*/
|
|
2521
2863
|
ResourceArn: string | undefined;
|
|
2522
2864
|
/**
|
|
2865
|
+
* @public
|
|
2523
2866
|
* <p>Whether or not the resource is a federated resource.</p>
|
|
2524
2867
|
*/
|
|
2525
2868
|
WithFederation?: boolean;
|
|
@@ -2535,14 +2878,17 @@ export interface UpdateResourceResponse {
|
|
|
2535
2878
|
*/
|
|
2536
2879
|
export interface DeleteObjectInput {
|
|
2537
2880
|
/**
|
|
2881
|
+
* @public
|
|
2538
2882
|
* <p>The Amazon S3 location of the object to delete.</p>
|
|
2539
2883
|
*/
|
|
2540
2884
|
Uri: string | undefined;
|
|
2541
2885
|
/**
|
|
2886
|
+
* @public
|
|
2542
2887
|
* <p>The Amazon S3 ETag of the object. Returned by <code>GetTableObjects</code> for validation and used to identify changes to the underlying data.</p>
|
|
2543
2888
|
*/
|
|
2544
2889
|
ETag?: string;
|
|
2545
2890
|
/**
|
|
2891
|
+
* @public
|
|
2546
2892
|
* <p>A list of partition values for the object. A value must be specified for each partition key associated with the governed table.</p>
|
|
2547
2893
|
*/
|
|
2548
2894
|
PartitionValues?: string[];
|
|
@@ -2553,10 +2899,12 @@ export interface DeleteObjectInput {
|
|
|
2553
2899
|
*/
|
|
2554
2900
|
export interface WriteOperation {
|
|
2555
2901
|
/**
|
|
2902
|
+
* @public
|
|
2556
2903
|
* <p>A new object to add to the governed table.</p>
|
|
2557
2904
|
*/
|
|
2558
2905
|
AddObject?: AddObjectInput;
|
|
2559
2906
|
/**
|
|
2907
|
+
* @public
|
|
2560
2908
|
* <p>An object to delete from the governed table.</p>
|
|
2561
2909
|
*/
|
|
2562
2910
|
DeleteObject?: DeleteObjectInput;
|
|
@@ -2566,22 +2914,27 @@ export interface WriteOperation {
|
|
|
2566
2914
|
*/
|
|
2567
2915
|
export interface UpdateTableObjectsRequest {
|
|
2568
2916
|
/**
|
|
2917
|
+
* @public
|
|
2569
2918
|
* <p>The catalog containing the governed table to update. Defaults to the caller’s account ID.</p>
|
|
2570
2919
|
*/
|
|
2571
2920
|
CatalogId?: string;
|
|
2572
2921
|
/**
|
|
2922
|
+
* @public
|
|
2573
2923
|
* <p>The database containing the governed table to update.</p>
|
|
2574
2924
|
*/
|
|
2575
2925
|
DatabaseName: string | undefined;
|
|
2576
2926
|
/**
|
|
2927
|
+
* @public
|
|
2577
2928
|
* <p>The governed table to update.</p>
|
|
2578
2929
|
*/
|
|
2579
2930
|
TableName: string | undefined;
|
|
2580
2931
|
/**
|
|
2932
|
+
* @public
|
|
2581
2933
|
* <p>The transaction at which to do the write.</p>
|
|
2582
2934
|
*/
|
|
2583
2935
|
TransactionId?: string;
|
|
2584
2936
|
/**
|
|
2937
|
+
* @public
|
|
2585
2938
|
* <p>A list of <code>WriteOperation</code> objects that define an object to add to or delete from the manifest for a governed table.</p>
|
|
2586
2939
|
*/
|
|
2587
2940
|
WriteOperations: WriteOperation[] | undefined;
|
|
@@ -2596,18 +2949,22 @@ export interface UpdateTableObjectsResponse {
|
|
|
2596
2949
|
*/
|
|
2597
2950
|
export interface UpdateTableStorageOptimizerRequest {
|
|
2598
2951
|
/**
|
|
2952
|
+
* @public
|
|
2599
2953
|
* <p>The Catalog ID of the table.</p>
|
|
2600
2954
|
*/
|
|
2601
2955
|
CatalogId?: string;
|
|
2602
2956
|
/**
|
|
2957
|
+
* @public
|
|
2603
2958
|
* <p>Name of the database where the table is present.</p>
|
|
2604
2959
|
*/
|
|
2605
2960
|
DatabaseName: string | undefined;
|
|
2606
2961
|
/**
|
|
2962
|
+
* @public
|
|
2607
2963
|
* <p>Name of the table for which to enable the storage optimizer.</p>
|
|
2608
2964
|
*/
|
|
2609
2965
|
TableName: string | undefined;
|
|
2610
2966
|
/**
|
|
2967
|
+
* @public
|
|
2611
2968
|
* <p>Name of the table for which to enable the storage optimizer.</p>
|
|
2612
2969
|
*/
|
|
2613
2970
|
StorageOptimizerConfig: Record<string, Record<string, string>> | undefined;
|
|
@@ -2617,6 +2974,7 @@ export interface UpdateTableStorageOptimizerRequest {
|
|
|
2617
2974
|
*/
|
|
2618
2975
|
export interface UpdateTableStorageOptimizerResponse {
|
|
2619
2976
|
/**
|
|
2977
|
+
* @public
|
|
2620
2978
|
* <p>A response indicating the success of failure of the operation.</p>
|
|
2621
2979
|
*/
|
|
2622
2980
|
Result?: string;
|