@aws-sdk/client-lakeformation 3.315.0 → 3.319.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.
@@ -47,370 +47,294 @@ import { UpdateResourceCommandInput, UpdateResourceCommandOutput } from "./comma
47
47
  import { UpdateTableObjectsCommandInput, UpdateTableObjectsCommandOutput } from "./commands/UpdateTableObjectsCommand";
48
48
  import { UpdateTableStorageOptimizerCommandInput, UpdateTableStorageOptimizerCommandOutput } from "./commands/UpdateTableStorageOptimizerCommand";
49
49
  import { LakeFormationClient } from "./LakeFormationClient";
50
- /**
51
- * @public
52
- * <fullname>Lake Formation</fullname>
53
- * <p>Defines the public endpoint for the Lake Formation service.</p>
54
- */
55
- export declare class LakeFormation extends LakeFormationClient {
50
+ export interface LakeFormation {
56
51
  /**
57
- * @public
58
- * <p>Attaches one or more LF-tags to an existing resource.</p>
52
+ * @see {@link AddLFTagsToResourceCommand}
59
53
  */
60
54
  addLFTagsToResource(args: AddLFTagsToResourceCommandInput, options?: __HttpHandlerOptions): Promise<AddLFTagsToResourceCommandOutput>;
61
55
  addLFTagsToResource(args: AddLFTagsToResourceCommandInput, cb: (err: any, data?: AddLFTagsToResourceCommandOutput) => void): void;
62
56
  addLFTagsToResource(args: AddLFTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddLFTagsToResourceCommandOutput) => void): void;
63
57
  /**
64
- * @public
65
- * <p>Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions.
66
- * Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
67
- * </p>
68
- * <p>
69
- * This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API <code>GetDataAccess</code>. Therefore, all SAML roles that can be assumed via <code>AssumeDecoratedRoleWithSAML</code> must at a minimum include <code>lakeformation:GetDataAccess</code> in their role policies. A typical IAM policy attached to such a role would look as follows:
70
- * </p>
58
+ * @see {@link AssumeDecoratedRoleWithSAMLCommand}
71
59
  */
72
60
  assumeDecoratedRoleWithSAML(args: AssumeDecoratedRoleWithSAMLCommandInput, options?: __HttpHandlerOptions): Promise<AssumeDecoratedRoleWithSAMLCommandOutput>;
73
61
  assumeDecoratedRoleWithSAML(args: AssumeDecoratedRoleWithSAMLCommandInput, cb: (err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void): void;
74
62
  assumeDecoratedRoleWithSAML(args: AssumeDecoratedRoleWithSAMLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void): void;
75
63
  /**
76
- * @public
77
- * <p>Batch operation to grant permissions to the principal.</p>
64
+ * @see {@link BatchGrantPermissionsCommand}
78
65
  */
79
66
  batchGrantPermissions(args: BatchGrantPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<BatchGrantPermissionsCommandOutput>;
80
67
  batchGrantPermissions(args: BatchGrantPermissionsCommandInput, cb: (err: any, data?: BatchGrantPermissionsCommandOutput) => void): void;
81
68
  batchGrantPermissions(args: BatchGrantPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGrantPermissionsCommandOutput) => void): void;
82
69
  /**
83
- * @public
84
- * <p>Batch operation to revoke permissions from the principal.</p>
70
+ * @see {@link BatchRevokePermissionsCommand}
85
71
  */
86
72
  batchRevokePermissions(args: BatchRevokePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<BatchRevokePermissionsCommandOutput>;
87
73
  batchRevokePermissions(args: BatchRevokePermissionsCommandInput, cb: (err: any, data?: BatchRevokePermissionsCommandOutput) => void): void;
88
74
  batchRevokePermissions(args: BatchRevokePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchRevokePermissionsCommandOutput) => void): void;
89
75
  /**
90
- * @public
91
- * <p>Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.</p>
76
+ * @see {@link CancelTransactionCommand}
92
77
  */
93
78
  cancelTransaction(args: CancelTransactionCommandInput, options?: __HttpHandlerOptions): Promise<CancelTransactionCommandOutput>;
94
79
  cancelTransaction(args: CancelTransactionCommandInput, cb: (err: any, data?: CancelTransactionCommandOutput) => void): void;
95
80
  cancelTransaction(args: CancelTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelTransactionCommandOutput) => void): void;
96
81
  /**
97
- * @public
98
- * <p>Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.</p>
82
+ * @see {@link CommitTransactionCommand}
99
83
  */
100
84
  commitTransaction(args: CommitTransactionCommandInput, options?: __HttpHandlerOptions): Promise<CommitTransactionCommandOutput>;
101
85
  commitTransaction(args: CommitTransactionCommandInput, cb: (err: any, data?: CommitTransactionCommandOutput) => void): void;
102
86
  commitTransaction(args: CommitTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CommitTransactionCommandOutput) => void): void;
103
87
  /**
104
- * @public
105
- * <p>Creates a data cell filter to allow one to grant access to certain columns on certain rows.</p>
88
+ * @see {@link CreateDataCellsFilterCommand}
106
89
  */
107
90
  createDataCellsFilter(args: CreateDataCellsFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataCellsFilterCommandOutput>;
108
91
  createDataCellsFilter(args: CreateDataCellsFilterCommandInput, cb: (err: any, data?: CreateDataCellsFilterCommandOutput) => void): void;
109
92
  createDataCellsFilter(args: CreateDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataCellsFilterCommandOutput) => void): void;
110
93
  /**
111
- * @public
112
- * <p>Creates an LF-tag with the specified name and values.</p>
94
+ * @see {@link CreateLFTagCommand}
113
95
  */
114
96
  createLFTag(args: CreateLFTagCommandInput, options?: __HttpHandlerOptions): Promise<CreateLFTagCommandOutput>;
115
97
  createLFTag(args: CreateLFTagCommandInput, cb: (err: any, data?: CreateLFTagCommandOutput) => void): void;
116
98
  createLFTag(args: CreateLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLFTagCommandOutput) => void): void;
117
99
  /**
118
- * @public
119
- * <p>Deletes a data cell filter.</p>
100
+ * @see {@link DeleteDataCellsFilterCommand}
120
101
  */
121
102
  deleteDataCellsFilter(args: DeleteDataCellsFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataCellsFilterCommandOutput>;
122
103
  deleteDataCellsFilter(args: DeleteDataCellsFilterCommandInput, cb: (err: any, data?: DeleteDataCellsFilterCommandOutput) => void): void;
123
104
  deleteDataCellsFilter(args: DeleteDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataCellsFilterCommandOutput) => void): void;
124
105
  /**
125
- * @public
126
- * <p>Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the <code>LFTagPolicy</code> attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.</p>
106
+ * @see {@link DeleteLFTagCommand}
127
107
  */
128
108
  deleteLFTag(args: DeleteLFTagCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLFTagCommandOutput>;
129
109
  deleteLFTag(args: DeleteLFTagCommandInput, cb: (err: any, data?: DeleteLFTagCommandOutput) => void): void;
130
110
  deleteLFTag(args: DeleteLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLFTagCommandOutput) => void): void;
131
111
  /**
132
- * @public
133
- * <p>For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted
134
- * if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
135
- * </p>
136
- * <p>
137
- * The Glue ETL library function <code>write_dynamic_frame.from_catalog()</code> includes an option to automatically
138
- * call <code>DeleteObjectsOnCancel</code> before writes. For more information, see
139
- * <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes">Rolling Back Amazon S3 Writes</a>.
140
- * </p>
112
+ * @see {@link DeleteObjectsOnCancelCommand}
141
113
  */
142
114
  deleteObjectsOnCancel(args: DeleteObjectsOnCancelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteObjectsOnCancelCommandOutput>;
143
115
  deleteObjectsOnCancel(args: DeleteObjectsOnCancelCommandInput, cb: (err: any, data?: DeleteObjectsOnCancelCommandOutput) => void): void;
144
116
  deleteObjectsOnCancel(args: DeleteObjectsOnCancelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectsOnCancelCommandOutput) => void): void;
145
117
  /**
146
- * @public
147
- * <p>Deregisters the resource as managed by the Data Catalog.</p>
148
- * <p>When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.</p>
118
+ * @see {@link DeregisterResourceCommand}
149
119
  */
150
120
  deregisterResource(args: DeregisterResourceCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterResourceCommandOutput>;
151
121
  deregisterResource(args: DeregisterResourceCommandInput, cb: (err: any, data?: DeregisterResourceCommandOutput) => void): void;
152
122
  deregisterResource(args: DeregisterResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterResourceCommandOutput) => void): void;
153
123
  /**
154
- * @public
155
- * <p>Retrieves the current data access role for the given resource registered in Lake Formation.</p>
124
+ * @see {@link DescribeResourceCommand}
156
125
  */
157
126
  describeResource(args: DescribeResourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourceCommandOutput>;
158
127
  describeResource(args: DescribeResourceCommandInput, cb: (err: any, data?: DescribeResourceCommandOutput) => void): void;
159
128
  describeResource(args: DescribeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceCommandOutput) => void): void;
160
129
  /**
161
- * @public
162
- * <p>Returns the details of a single transaction.</p>
130
+ * @see {@link DescribeTransactionCommand}
163
131
  */
164
132
  describeTransaction(args: DescribeTransactionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTransactionCommandOutput>;
165
133
  describeTransaction(args: DescribeTransactionCommandInput, cb: (err: any, data?: DescribeTransactionCommandOutput) => void): void;
166
134
  describeTransaction(args: DescribeTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransactionCommandOutput) => void): void;
167
135
  /**
168
- * @public
169
- * <p>Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.</p>
170
- * <p>Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.</p>
136
+ * @see {@link ExtendTransactionCommand}
171
137
  */
172
138
  extendTransaction(args: ExtendTransactionCommandInput, options?: __HttpHandlerOptions): Promise<ExtendTransactionCommandOutput>;
173
139
  extendTransaction(args: ExtendTransactionCommandInput, cb: (err: any, data?: ExtendTransactionCommandOutput) => void): void;
174
140
  extendTransaction(args: ExtendTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExtendTransactionCommandOutput) => void): void;
175
141
  /**
176
- * @public
177
- * <p>Returns a data cells filter.</p>
142
+ * @see {@link GetDataCellsFilterCommand}
178
143
  */
179
144
  getDataCellsFilter(args: GetDataCellsFilterCommandInput, options?: __HttpHandlerOptions): Promise<GetDataCellsFilterCommandOutput>;
180
145
  getDataCellsFilter(args: GetDataCellsFilterCommandInput, cb: (err: any, data?: GetDataCellsFilterCommandOutput) => void): void;
181
146
  getDataCellsFilter(args: GetDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCellsFilterCommandOutput) => void): void;
182
147
  /**
183
- * @public
184
- * <p>Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. </p>
148
+ * @see {@link GetDataLakeSettingsCommand}
185
149
  */
186
150
  getDataLakeSettings(args: GetDataLakeSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetDataLakeSettingsCommandOutput>;
187
151
  getDataLakeSettings(args: GetDataLakeSettingsCommandInput, cb: (err: any, data?: GetDataLakeSettingsCommandOutput) => void): void;
188
152
  getDataLakeSettings(args: GetDataLakeSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataLakeSettingsCommandOutput) => void): void;
189
153
  /**
190
- * @public
191
- * <p>Returns the Lake Formation permissions for a specified table or database resource located
192
- * at a path in Amazon S3. <code>GetEffectivePermissionsForPath</code> will not return databases and tables if the catalog is encrypted.</p>
154
+ * @see {@link GetEffectivePermissionsForPathCommand}
193
155
  */
194
156
  getEffectivePermissionsForPath(args: GetEffectivePermissionsForPathCommandInput, options?: __HttpHandlerOptions): Promise<GetEffectivePermissionsForPathCommandOutput>;
195
157
  getEffectivePermissionsForPath(args: GetEffectivePermissionsForPathCommandInput, cb: (err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void): void;
196
158
  getEffectivePermissionsForPath(args: GetEffectivePermissionsForPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void): void;
197
159
  /**
198
- * @public
199
- * <p>Returns an LF-tag definition.</p>
160
+ * @see {@link GetLFTagCommand}
200
161
  */
201
162
  getLFTag(args: GetLFTagCommandInput, options?: __HttpHandlerOptions): Promise<GetLFTagCommandOutput>;
202
163
  getLFTag(args: GetLFTagCommandInput, cb: (err: any, data?: GetLFTagCommandOutput) => void): void;
203
164
  getLFTag(args: GetLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLFTagCommandOutput) => void): void;
204
165
  /**
205
- * @public
206
- * <p>Returns the state of a query previously submitted. Clients are expected to poll <code>GetQueryState</code> to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to <code>StartQueryPlanning</code>.</p>
166
+ * @see {@link GetQueryStateCommand}
207
167
  */
208
168
  getQueryState(args: GetQueryStateCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryStateCommandOutput>;
209
169
  getQueryState(args: GetQueryStateCommandInput, cb: (err: any, data?: GetQueryStateCommandOutput) => void): void;
210
170
  getQueryState(args: GetQueryStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryStateCommandOutput) => void): void;
211
171
  /**
212
- * @public
213
- * <p>Retrieves statistics on the planning and execution of a query.</p>
172
+ * @see {@link GetQueryStatisticsCommand}
214
173
  */
215
174
  getQueryStatistics(args: GetQueryStatisticsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryStatisticsCommandOutput>;
216
175
  getQueryStatistics(args: GetQueryStatisticsCommandInput, cb: (err: any, data?: GetQueryStatisticsCommandOutput) => void): void;
217
176
  getQueryStatistics(args: GetQueryStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryStatisticsCommandOutput) => void): void;
218
177
  /**
219
- * @public
220
- * <p>Returns the LF-tags applied to a resource.</p>
178
+ * @see {@link GetResourceLFTagsCommand}
221
179
  */
222
180
  getResourceLFTags(args: GetResourceLFTagsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceLFTagsCommandOutput>;
223
181
  getResourceLFTags(args: GetResourceLFTagsCommandInput, cb: (err: any, data?: GetResourceLFTagsCommandOutput) => void): void;
224
182
  getResourceLFTags(args: GetResourceLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceLFTagsCommandOutput) => void): void;
225
183
  /**
226
- * @public
227
- * <p>Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.</p>
184
+ * @see {@link GetTableObjectsCommand}
228
185
  */
229
186
  getTableObjects(args: GetTableObjectsCommandInput, options?: __HttpHandlerOptions): Promise<GetTableObjectsCommandOutput>;
230
187
  getTableObjects(args: GetTableObjectsCommandInput, cb: (err: any, data?: GetTableObjectsCommandOutput) => void): void;
231
188
  getTableObjects(args: GetTableObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableObjectsCommandOutput) => void): void;
232
189
  /**
233
- * @public
234
- * <p>This API is identical to <code>GetTemporaryTableCredentials</code> except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.</p>
190
+ * @see {@link GetTemporaryGluePartitionCredentialsCommand}
235
191
  */
236
192
  getTemporaryGluePartitionCredentials(args: GetTemporaryGluePartitionCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetTemporaryGluePartitionCredentialsCommandOutput>;
237
193
  getTemporaryGluePartitionCredentials(args: GetTemporaryGluePartitionCredentialsCommandInput, cb: (err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void): void;
238
194
  getTemporaryGluePartitionCredentials(args: GetTemporaryGluePartitionCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void): void;
239
195
  /**
240
- * @public
241
- * <p>Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.</p>
196
+ * @see {@link GetTemporaryGlueTableCredentialsCommand}
242
197
  */
243
198
  getTemporaryGlueTableCredentials(args: GetTemporaryGlueTableCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetTemporaryGlueTableCredentialsCommandOutput>;
244
199
  getTemporaryGlueTableCredentials(args: GetTemporaryGlueTableCredentialsCommandInput, cb: (err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void): void;
245
200
  getTemporaryGlueTableCredentials(args: GetTemporaryGlueTableCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void): void;
246
201
  /**
247
- * @public
248
- * <p>Returns the work units resulting from the query. Work units can be executed in any order and in parallel. </p>
202
+ * @see {@link GetWorkUnitResultsCommand}
249
203
  */
250
204
  getWorkUnitResults(args: GetWorkUnitResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkUnitResultsCommandOutput>;
251
205
  getWorkUnitResults(args: GetWorkUnitResultsCommandInput, cb: (err: any, data?: GetWorkUnitResultsCommandOutput) => void): void;
252
206
  getWorkUnitResults(args: GetWorkUnitResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkUnitResultsCommandOutput) => void): void;
253
207
  /**
254
- * @public
255
- * <p>Retrieves the work units generated by the <code>StartQueryPlanning</code> operation.</p>
208
+ * @see {@link GetWorkUnitsCommand}
256
209
  */
257
210
  getWorkUnits(args: GetWorkUnitsCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkUnitsCommandOutput>;
258
211
  getWorkUnits(args: GetWorkUnitsCommandInput, cb: (err: any, data?: GetWorkUnitsCommandOutput) => void): void;
259
212
  getWorkUnits(args: GetWorkUnitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkUnitsCommandOutput) => void): void;
260
213
  /**
261
- * @public
262
- * <p>Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p>
263
- * <p>For information about permissions, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>.</p>
214
+ * @see {@link GrantPermissionsCommand}
264
215
  */
265
216
  grantPermissions(args: GrantPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<GrantPermissionsCommandOutput>;
266
217
  grantPermissions(args: GrantPermissionsCommandInput, cb: (err: any, data?: GrantPermissionsCommandOutput) => void): void;
267
218
  grantPermissions(args: GrantPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GrantPermissionsCommandOutput) => void): void;
268
219
  /**
269
- * @public
270
- * <p>Lists all the data cell filters on a table.</p>
220
+ * @see {@link ListDataCellsFilterCommand}
271
221
  */
272
222
  listDataCellsFilter(args: ListDataCellsFilterCommandInput, options?: __HttpHandlerOptions): Promise<ListDataCellsFilterCommandOutput>;
273
223
  listDataCellsFilter(args: ListDataCellsFilterCommandInput, cb: (err: any, data?: ListDataCellsFilterCommandOutput) => void): void;
274
224
  listDataCellsFilter(args: ListDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataCellsFilterCommandOutput) => void): void;
275
225
  /**
276
- * @public
277
- * <p>Lists LF-tags that the requester has permission to view. </p>
226
+ * @see {@link ListLFTagsCommand}
278
227
  */
279
228
  listLFTags(args: ListLFTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListLFTagsCommandOutput>;
280
229
  listLFTags(args: ListLFTagsCommandInput, cb: (err: any, data?: ListLFTagsCommandOutput) => void): void;
281
230
  listLFTags(args: ListLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLFTagsCommandOutput) => void): void;
282
231
  /**
283
- * @public
284
- * <p>Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.</p>
285
- * <p>This operation returns only those permissions that have been explicitly granted.</p>
286
- * <p>For information about permissions, see <a href="https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>.</p>
232
+ * @see {@link ListPermissionsCommand}
287
233
  */
288
234
  listPermissions(args: ListPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionsCommandOutput>;
289
235
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
290
236
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
291
237
  /**
292
- * @public
293
- * <p>Lists the resources registered to be managed by the Data Catalog.</p>
238
+ * @see {@link ListResourcesCommand}
294
239
  */
295
240
  listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcesCommandOutput>;
296
241
  listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
297
242
  listResources(args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
298
243
  /**
299
- * @public
300
- * <p>Returns the configuration of all storage optimizers associated with a specified table.</p>
244
+ * @see {@link ListTableStorageOptimizersCommand}
301
245
  */
302
246
  listTableStorageOptimizers(args: ListTableStorageOptimizersCommandInput, options?: __HttpHandlerOptions): Promise<ListTableStorageOptimizersCommandOutput>;
303
247
  listTableStorageOptimizers(args: ListTableStorageOptimizersCommandInput, cb: (err: any, data?: ListTableStorageOptimizersCommandOutput) => void): void;
304
248
  listTableStorageOptimizers(args: ListTableStorageOptimizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableStorageOptimizersCommandOutput) => void): void;
305
249
  /**
306
- * @public
307
- * <p>Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.</p>
308
- * <p>This operation can help you identify uncommitted transactions or to get information about transactions.</p>
250
+ * @see {@link ListTransactionsCommand}
309
251
  */
310
252
  listTransactions(args: ListTransactionsCommandInput, options?: __HttpHandlerOptions): Promise<ListTransactionsCommandOutput>;
311
253
  listTransactions(args: ListTransactionsCommandInput, cb: (err: any, data?: ListTransactionsCommandOutput) => void): void;
312
254
  listTransactions(args: ListTransactionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTransactionsCommandOutput) => void): void;
313
255
  /**
314
- * @public
315
- * <p>Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html">Granting Lake Formation Permissions</a>.</p>
316
- * <p>This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.</p>
256
+ * @see {@link PutDataLakeSettingsCommand}
317
257
  */
318
258
  putDataLakeSettings(args: PutDataLakeSettingsCommandInput, options?: __HttpHandlerOptions): Promise<PutDataLakeSettingsCommandOutput>;
319
259
  putDataLakeSettings(args: PutDataLakeSettingsCommandInput, cb: (err: any, data?: PutDataLakeSettingsCommandOutput) => void): void;
320
260
  putDataLakeSettings(args: PutDataLakeSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataLakeSettingsCommandOutput) => void): void;
321
261
  /**
322
- * @public
323
- * <p>Registers the resource as managed by the Data Catalog.</p>
324
- * <p>To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.</p>
325
- * <p>The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.</p>
326
- * <p>
327
- * <code>ResourceArn = arn:aws:s3:::my-bucket
328
- * UseServiceLinkedRole = true</code>
329
- * </p>
330
- * <p>If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>:</p>
331
- * <p>
332
- * <code>arn:aws:iam::12345:role/my-data-access-role</code>
333
- * </p>
262
+ * @see {@link RegisterResourceCommand}
334
263
  */
335
264
  registerResource(args: RegisterResourceCommandInput, options?: __HttpHandlerOptions): Promise<RegisterResourceCommandOutput>;
336
265
  registerResource(args: RegisterResourceCommandInput, cb: (err: any, data?: RegisterResourceCommandOutput) => void): void;
337
266
  registerResource(args: RegisterResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterResourceCommandOutput) => void): void;
338
267
  /**
339
- * @public
340
- * <p>Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in <code>tableWithColumns</code> to specify column input.</p>
268
+ * @see {@link RemoveLFTagsFromResourceCommand}
341
269
  */
342
270
  removeLFTagsFromResource(args: RemoveLFTagsFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<RemoveLFTagsFromResourceCommandOutput>;
343
271
  removeLFTagsFromResource(args: RemoveLFTagsFromResourceCommandInput, cb: (err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void): void;
344
272
  removeLFTagsFromResource(args: RemoveLFTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void): void;
345
273
  /**
346
- * @public
347
- * <p>Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p>
274
+ * @see {@link RevokePermissionsCommand}
348
275
  */
349
276
  revokePermissions(args: RevokePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<RevokePermissionsCommandOutput>;
350
277
  revokePermissions(args: RevokePermissionsCommandInput, cb: (err: any, data?: RevokePermissionsCommandOutput) => void): void;
351
278
  revokePermissions(args: RevokePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokePermissionsCommandOutput) => void): void;
352
279
  /**
353
- * @public
354
- * <p>This operation allows a search on <code>DATABASE</code> resources by <code>TagCondition</code>. This operation is used by admins who want to grant user permissions on certain <code>TagConditions</code>. Before making a grant, the admin can use <code>SearchDatabasesByTags</code> to find all resources where the given <code>TagConditions</code> are valid to verify whether the returned resources can be shared.</p>
280
+ * @see {@link SearchDatabasesByLFTagsCommand}
355
281
  */
356
282
  searchDatabasesByLFTags(args: SearchDatabasesByLFTagsCommandInput, options?: __HttpHandlerOptions): Promise<SearchDatabasesByLFTagsCommandOutput>;
357
283
  searchDatabasesByLFTags(args: SearchDatabasesByLFTagsCommandInput, cb: (err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void): void;
358
284
  searchDatabasesByLFTags(args: SearchDatabasesByLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void): void;
359
285
  /**
360
- * @public
361
- * <p>This operation allows a search on <code>TABLE</code> resources by <code>LFTag</code>s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use <code>SearchTablesByLFTags</code> to find all resources where the given <code>LFTag</code>s are valid to verify whether the returned resources can be shared.</p>
286
+ * @see {@link SearchTablesByLFTagsCommand}
362
287
  */
363
288
  searchTablesByLFTags(args: SearchTablesByLFTagsCommandInput, options?: __HttpHandlerOptions): Promise<SearchTablesByLFTagsCommandOutput>;
364
289
  searchTablesByLFTags(args: SearchTablesByLFTagsCommandInput, cb: (err: any, data?: SearchTablesByLFTagsCommandOutput) => void): void;
365
290
  searchTablesByLFTags(args: SearchTablesByLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchTablesByLFTagsCommandOutput) => void): void;
366
291
  /**
367
- * @public
368
- * <p>Submits a request to process a query statement.</p>
369
- * <p>This operation generates work units that can be retrieved with the <code>GetWorkUnits</code> operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.</p>
292
+ * @see {@link StartQueryPlanningCommand}
370
293
  */
371
294
  startQueryPlanning(args: StartQueryPlanningCommandInput, options?: __HttpHandlerOptions): Promise<StartQueryPlanningCommandOutput>;
372
295
  startQueryPlanning(args: StartQueryPlanningCommandInput, cb: (err: any, data?: StartQueryPlanningCommandOutput) => void): void;
373
296
  startQueryPlanning(args: StartQueryPlanningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryPlanningCommandOutput) => void): void;
374
297
  /**
375
- * @public
376
- * <p>Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.</p>
298
+ * @see {@link StartTransactionCommand}
377
299
  */
378
300
  startTransaction(args: StartTransactionCommandInput, options?: __HttpHandlerOptions): Promise<StartTransactionCommandOutput>;
379
301
  startTransaction(args: StartTransactionCommandInput, cb: (err: any, data?: StartTransactionCommandOutput) => void): void;
380
302
  startTransaction(args: StartTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTransactionCommandOutput) => void): void;
381
303
  /**
382
- * @public
383
- * <p>Updates a data cell filter.</p>
304
+ * @see {@link UpdateDataCellsFilterCommand}
384
305
  */
385
306
  updateDataCellsFilter(args: UpdateDataCellsFilterCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataCellsFilterCommandOutput>;
386
307
  updateDataCellsFilter(args: UpdateDataCellsFilterCommandInput, cb: (err: any, data?: UpdateDataCellsFilterCommandOutput) => void): void;
387
308
  updateDataCellsFilter(args: UpdateDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataCellsFilterCommandOutput) => void): void;
388
309
  /**
389
- * @public
390
- * <p>Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value. </p>
310
+ * @see {@link UpdateLFTagCommand}
391
311
  */
392
312
  updateLFTag(args: UpdateLFTagCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLFTagCommandOutput>;
393
313
  updateLFTag(args: UpdateLFTagCommandInput, cb: (err: any, data?: UpdateLFTagCommandOutput) => void): void;
394
314
  updateLFTag(args: UpdateLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLFTagCommandOutput) => void): void;
395
315
  /**
396
- * @public
397
- * <p>Updates the data access role used for vending access to the given (registered) resource in Lake Formation. </p>
316
+ * @see {@link UpdateResourceCommand}
398
317
  */
399
318
  updateResource(args: UpdateResourceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceCommandOutput>;
400
319
  updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void;
401
320
  updateResource(args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void;
402
321
  /**
403
- * @public
404
- * <p>Updates the manifest of Amazon S3 objects that make up the specified governed table.</p>
322
+ * @see {@link UpdateTableObjectsCommand}
405
323
  */
406
324
  updateTableObjects(args: UpdateTableObjectsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTableObjectsCommandOutput>;
407
325
  updateTableObjects(args: UpdateTableObjectsCommandInput, cb: (err: any, data?: UpdateTableObjectsCommandOutput) => void): void;
408
326
  updateTableObjects(args: UpdateTableObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableObjectsCommandOutput) => void): void;
409
327
  /**
410
- * @public
411
- * <p>Updates the configuration of the storage optimizers for a table.</p>
328
+ * @see {@link UpdateTableStorageOptimizerCommand}
412
329
  */
413
330
  updateTableStorageOptimizer(args: UpdateTableStorageOptimizerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTableStorageOptimizerCommandOutput>;
414
331
  updateTableStorageOptimizer(args: UpdateTableStorageOptimizerCommandInput, cb: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void): void;
415
332
  updateTableStorageOptimizer(args: UpdateTableStorageOptimizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void): void;
416
333
  }
334
+ /**
335
+ * @public
336
+ * <fullname>Lake Formation</fullname>
337
+ * <p>Defines the public endpoint for the Lake Formation service.</p>
338
+ */
339
+ export declare class LakeFormation extends LakeFormationClient implements LakeFormation {
340
+ }
@@ -188,7 +188,7 @@ import {
188
188
  UpdateTableStorageOptimizerCommandOutput,
189
189
  } from "./commands/UpdateTableStorageOptimizerCommand";
190
190
  import { LakeFormationClient } from "./LakeFormationClient";
191
- export declare class LakeFormation extends LakeFormationClient {
191
+ export interface LakeFormation {
192
192
  addLFTagsToResource(
193
193
  args: AddLFTagsToResourceCommandInput,
194
194
  options?: __HttpHandlerOptions
@@ -807,3 +807,6 @@ export declare class LakeFormation extends LakeFormationClient {
807
807
  cb: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void
808
808
  ): void;
809
809
  }
810
+ export declare class LakeFormation
811
+ extends LakeFormationClient
812
+ implements LakeFormation {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-lakeformation",
3
3
  "description": "AWS SDK for JavaScript Lakeformation Client for Node.js, Browser and React Native",
4
- "version": "3.315.0",
4
+ "version": "3.319.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.319.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.319.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,19 +36,19 @@
36
36
  "@aws-sdk/middleware-serde": "3.310.0",
37
37
  "@aws-sdk/middleware-signing": "3.310.0",
38
38
  "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.310.0",
39
+ "@aws-sdk/middleware-user-agent": "3.319.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
51
- "@aws-sdk/util-endpoints": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
+ "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-stream-browser": "3.310.0",
54
54
  "@aws-sdk/util-stream-node": "3.310.0",