@aws-sdk/client-lakeformation 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/dist-types/LakeFormation.d.ts +48 -0
  2. package/dist-types/LakeFormationClient.d.ts +24 -4
  3. package/dist-types/commands/AddLFTagsToResourceCommand.d.ts +16 -0
  4. package/dist-types/commands/AssumeDecoratedRoleWithSAMLCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchGrantPermissionsCommand.d.ts +16 -0
  6. package/dist-types/commands/BatchRevokePermissionsCommand.d.ts +16 -0
  7. package/dist-types/commands/CancelTransactionCommand.d.ts +16 -0
  8. package/dist-types/commands/CommitTransactionCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateDataCellsFilterCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateLFTagCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDataCellsFilterCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteLFTagCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteObjectsOnCancelCommand.d.ts +16 -0
  14. package/dist-types/commands/DeregisterResourceCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeResourceCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeTransactionCommand.d.ts +16 -0
  17. package/dist-types/commands/ExtendTransactionCommand.d.ts +16 -0
  18. package/dist-types/commands/GetDataCellsFilterCommand.d.ts +16 -0
  19. package/dist-types/commands/GetDataLakeSettingsCommand.d.ts +16 -0
  20. package/dist-types/commands/GetEffectivePermissionsForPathCommand.d.ts +16 -0
  21. package/dist-types/commands/GetLFTagCommand.d.ts +16 -0
  22. package/dist-types/commands/GetQueryStateCommand.d.ts +16 -0
  23. package/dist-types/commands/GetQueryStatisticsCommand.d.ts +16 -0
  24. package/dist-types/commands/GetResourceLFTagsCommand.d.ts +16 -0
  25. package/dist-types/commands/GetTableObjectsCommand.d.ts +16 -0
  26. package/dist-types/commands/GetTemporaryGluePartitionCredentialsCommand.d.ts +16 -0
  27. package/dist-types/commands/GetTemporaryGlueTableCredentialsCommand.d.ts +16 -0
  28. package/dist-types/commands/GetWorkUnitResultsCommand.d.ts +16 -0
  29. package/dist-types/commands/GetWorkUnitsCommand.d.ts +16 -0
  30. package/dist-types/commands/GrantPermissionsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListDataCellsFilterCommand.d.ts +16 -0
  32. package/dist-types/commands/ListLFTagsCommand.d.ts +16 -0
  33. package/dist-types/commands/ListPermissionsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListResourcesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListTableStorageOptimizersCommand.d.ts +16 -0
  36. package/dist-types/commands/ListTransactionsCommand.d.ts +16 -0
  37. package/dist-types/commands/PutDataLakeSettingsCommand.d.ts +16 -0
  38. package/dist-types/commands/RegisterResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/RemoveLFTagsFromResourceCommand.d.ts +16 -0
  40. package/dist-types/commands/RevokePermissionsCommand.d.ts +16 -0
  41. package/dist-types/commands/SearchDatabasesByLFTagsCommand.d.ts +16 -0
  42. package/dist-types/commands/SearchTablesByLFTagsCommand.d.ts +16 -0
  43. package/dist-types/commands/StartQueryPlanningCommand.d.ts +16 -0
  44. package/dist-types/commands/StartTransactionCommand.d.ts +16 -0
  45. package/dist-types/commands/UpdateDataCellsFilterCommand.d.ts +16 -0
  46. package/dist-types/commands/UpdateLFTagCommand.d.ts +16 -0
  47. package/dist-types/commands/UpdateResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/UpdateTableObjectsCommand.d.ts +16 -0
  49. package/dist-types/commands/UpdateTableStorageOptimizerCommand.d.ts +16 -0
  50. package/dist-types/models/LakeFormationServiceException.d.ts +2 -0
  51. package/dist-types/models/models_0.d.ts +372 -0
  52. package/dist-types/pagination/GetEffectivePermissionsForPathPaginator.d.ts +3 -0
  53. package/dist-types/pagination/GetTableObjectsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/GetWorkUnitsPaginator.d.ts +3 -0
  55. package/dist-types/pagination/Interfaces.d.ts +3 -0
  56. package/dist-types/pagination/ListDataCellsFilterPaginator.d.ts +3 -0
  57. package/dist-types/pagination/ListLFTagsPaginator.d.ts +3 -0
  58. package/dist-types/pagination/ListPermissionsPaginator.d.ts +3 -0
  59. package/dist-types/pagination/ListResourcesPaginator.d.ts +3 -0
  60. package/dist-types/pagination/ListTableStorageOptimizersPaginator.d.ts +3 -0
  61. package/dist-types/pagination/ListTransactionsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/SearchDatabasesByLFTagsPaginator.d.ts +3 -0
  63. package/dist-types/pagination/SearchTablesByLFTagsPaginator.d.ts +3 -0
  64. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { StartTransactionRequest, StartTransactionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartTransactionCommand}.
8
10
  */
9
11
  export interface StartTransactionCommandInput extends StartTransactionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartTransactionCommand}.
13
17
  */
14
18
  export interface StartTransactionCommandOutput extends StartTransactionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartTransactionCommandOutput extends StartTransactionResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartTransactionCommandInput - {@link StartTransactionCommandInput}
34
+ * @returns {@link StartTransactionCommandOutput}
28
35
  * @see {@link StartTransactionCommandInput} for command's `input` shape.
29
36
  * @see {@link StartTransactionCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -40,11 +47,20 @@ export interface StartTransactionCommandOutput extends StartTransactionResponse,
40
47
  export declare class StartTransactionCommand extends $Command<StartTransactionCommandInput, StartTransactionCommandOutput, LakeFormationClientResolvedConfig> {
41
48
  readonly input: StartTransactionCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: StartTransactionCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartTransactionCommandInput, StartTransactionCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { UpdateDataCellsFilterRequest, UpdateDataCellsFilterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateDataCellsFilterCommand}.
8
10
  */
9
11
  export interface UpdateDataCellsFilterCommandInput extends UpdateDataCellsFilterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateDataCellsFilterCommand}.
13
17
  */
14
18
  export interface UpdateDataCellsFilterCommandOutput extends UpdateDataCellsFilterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a data cell filter.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateDataCellsFilterCommandOutput extends UpdateDataCellsFilte
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateDataCellsFilterCommandInput - {@link UpdateDataCellsFilterCommandInput}
34
+ * @returns {@link UpdateDataCellsFilterCommandOutput}
28
35
  * @see {@link UpdateDataCellsFilterCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateDataCellsFilterCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateDataCellsFilterCommandOutput extends UpdateDataCellsFilte
52
59
  export declare class UpdateDataCellsFilterCommand extends $Command<UpdateDataCellsFilterCommandInput, UpdateDataCellsFilterCommandOutput, LakeFormationClientResolvedConfig> {
53
60
  readonly input: UpdateDataCellsFilterCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: UpdateDataCellsFilterCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDataCellsFilterCommandInput, UpdateDataCellsFilterCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { UpdateLFTagRequest, UpdateLFTagResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateLFTagCommand}.
8
10
  */
9
11
  export interface UpdateLFTagCommandInput extends UpdateLFTagRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateLFTagCommand}.
13
17
  */
14
18
  export interface UpdateLFTagCommandOutput extends UpdateLFTagResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateLFTagCommandOutput extends UpdateLFTagResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateLFTagCommandInput - {@link UpdateLFTagCommandInput}
34
+ * @returns {@link UpdateLFTagCommandOutput}
28
35
  * @see {@link UpdateLFTagCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateLFTagCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateLFTagCommandOutput extends UpdateLFTagResponse, __Metadat
52
59
  export declare class UpdateLFTagCommand extends $Command<UpdateLFTagCommandInput, UpdateLFTagCommandOutput, LakeFormationClientResolvedConfig> {
53
60
  readonly input: UpdateLFTagCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: UpdateLFTagCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLFTagCommandInput, UpdateLFTagCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { UpdateResourceRequest, UpdateResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateResourceCommand}.
8
10
  */
9
11
  export interface UpdateResourceCommandInput extends UpdateResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateResourceCommand}.
13
17
  */
14
18
  export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the data access role used for vending access to the given (registered) resource in Lake Formation. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateResourceCommandInput - {@link UpdateResourceCommandInput}
34
+ * @returns {@link UpdateResourceCommandOutput}
28
35
  * @see {@link UpdateResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
46
53
  export declare class UpdateResourceCommand extends $Command<UpdateResourceCommandInput, UpdateResourceCommandOutput, LakeFormationClientResolvedConfig> {
47
54
  readonly input: UpdateResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UpdateResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateResourceCommandInput, UpdateResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { UpdateTableObjectsRequest, UpdateTableObjectsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateTableObjectsCommand}.
8
10
  */
9
11
  export interface UpdateTableObjectsCommandInput extends UpdateTableObjectsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateTableObjectsCommand}.
13
17
  */
14
18
  export interface UpdateTableObjectsCommandOutput extends UpdateTableObjectsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the manifest of Amazon S3 objects that make up the specified governed table.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateTableObjectsCommandOutput extends UpdateTableObjectsRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateTableObjectsCommandInput - {@link UpdateTableObjectsCommandInput}
34
+ * @returns {@link UpdateTableObjectsCommandOutput}
28
35
  * @see {@link UpdateTableObjectsCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateTableObjectsCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateTableObjectsCommandOutput extends UpdateTableObjectsRespo
61
68
  export declare class UpdateTableObjectsCommand extends $Command<UpdateTableObjectsCommandInput, UpdateTableObjectsCommandOutput, LakeFormationClientResolvedConfig> {
62
69
  readonly input: UpdateTableObjectsCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: UpdateTableObjectsCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTableObjectsCommandInput, UpdateTableObjectsCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { UpdateTableStorageOptimizerRequest, UpdateTableStorageOptimizerResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateTableStorageOptimizerCommand}.
8
10
  */
9
11
  export interface UpdateTableStorageOptimizerCommandInput extends UpdateTableStorageOptimizerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateTableStorageOptimizerCommand}.
13
17
  */
14
18
  export interface UpdateTableStorageOptimizerCommandOutput extends UpdateTableStorageOptimizerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the configuration of the storage optimizers for a table.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateTableStorageOptimizerCommandOutput extends UpdateTableSto
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateTableStorageOptimizerCommandInput - {@link UpdateTableStorageOptimizerCommandInput}
34
+ * @returns {@link UpdateTableStorageOptimizerCommandOutput}
28
35
  * @see {@link UpdateTableStorageOptimizerCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateTableStorageOptimizerCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UpdateTableStorageOptimizerCommandOutput extends UpdateTableSto
46
53
  export declare class UpdateTableStorageOptimizerCommand extends $Command<UpdateTableStorageOptimizerCommandInput, UpdateTableStorageOptimizerCommandOutput, LakeFormationClientResolvedConfig> {
47
54
  readonly input: UpdateTableStorageOptimizerCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UpdateTableStorageOptimizerCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTableStorageOptimizerCommandInput, UpdateTableStorageOptimizerCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from LakeFormation service.
4
6
  */
5
7
  export declare class LakeFormationServiceException extends __ServiceException {