@aws-sdk/client-lakeformation 3.295.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 +31 -31
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { ListLFTagsRequest, ListLFTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListLFTagsCommand}.
8
10
  */
9
11
  export interface ListLFTagsCommandInput extends ListLFTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListLFTagsCommand}.
13
17
  */
14
18
  export interface ListLFTagsCommandOutput extends ListLFTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists LF-tags that the requester has permission to view. </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 ListLFTagsCommandOutput extends ListLFTagsResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListLFTagsCommandInput - {@link ListLFTagsCommandInput}
34
+ * @returns {@link ListLFTagsCommandOutput}
28
35
  * @see {@link ListLFTagsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListLFTagsCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListLFTagsCommandOutput extends ListLFTagsResponse, __MetadataB
49
56
  export declare class ListLFTagsCommand extends $Command<ListLFTagsCommandInput, ListLFTagsCommandOutput, LakeFormationClientResolvedConfig> {
50
57
  readonly input: ListLFTagsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ListLFTagsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListLFTagsCommandInput, ListLFTagsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { ListPermissionsRequest, ListPermissionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPermissionsCommand}.
8
10
  */
9
11
  export interface ListPermissionsCommandInput extends ListPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPermissionsCommand}.
13
17
  */
14
18
  export interface ListPermissionsCommandOutput extends ListPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <p>This operation returns only those permissions that have been explicitly granted.</p>
19
24
  * <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>
@@ -27,6 +32,8 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListPermissionsCommandInput - {@link ListPermissionsCommandInput}
36
+ * @returns {@link ListPermissionsCommandOutput}
30
37
  * @see {@link ListPermissionsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListPermissionsCommandOutput} for command's `response` shape.
32
39
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
45
52
  export declare class ListPermissionsCommand extends $Command<ListPermissionsCommandInput, ListPermissionsCommandOutput, LakeFormationClientResolvedConfig> {
46
53
  readonly input: ListPermissionsCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ListPermissionsCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPermissionsCommandInput, ListPermissionsCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { ListResourcesRequest, ListResourcesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListResourcesCommand}.
8
10
  */
9
11
  export interface ListResourcesCommandInput extends ListResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListResourcesCommand}.
13
17
  */
14
18
  export interface ListResourcesCommandOutput extends ListResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the resources registered to be managed by the Data Catalog.</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 ListResourcesCommandOutput extends ListResourcesResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListResourcesCommandInput - {@link ListResourcesCommandInput}
34
+ * @returns {@link ListResourcesCommandOutput}
28
35
  * @see {@link ListResourcesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListResourcesCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
43
50
  export declare class ListResourcesCommand extends $Command<ListResourcesCommandInput, ListResourcesCommandOutput, LakeFormationClientResolvedConfig> {
44
51
  readonly input: ListResourcesCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListResourcesCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListResourcesCommandInput, ListResourcesCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { ListTableStorageOptimizersRequest, ListTableStorageOptimizersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTableStorageOptimizersCommand}.
8
10
  */
9
11
  export interface ListTableStorageOptimizersCommandInput extends ListTableStorageOptimizersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTableStorageOptimizersCommand}.
13
17
  */
14
18
  export interface ListTableStorageOptimizersCommandOutput extends ListTableStorageOptimizersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the configuration of all storage optimizers associated with a specified 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 ListTableStorageOptimizersCommandOutput extends ListTableStorag
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTableStorageOptimizersCommandInput - {@link ListTableStorageOptimizersCommandInput}
34
+ * @returns {@link ListTableStorageOptimizersCommandOutput}
28
35
  * @see {@link ListTableStorageOptimizersCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTableStorageOptimizersCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTableStorageOptimizersCommandOutput extends ListTableStorag
46
53
  export declare class ListTableStorageOptimizersCommand extends $Command<ListTableStorageOptimizersCommandInput, ListTableStorageOptimizersCommandOutput, LakeFormationClientResolvedConfig> {
47
54
  readonly input: ListTableStorageOptimizersCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTableStorageOptimizersCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTableStorageOptimizersCommandInput, ListTableStorageOptimizersCommandOutput>;
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 { ListTransactionsRequest, ListTransactionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTransactionsCommand}.
8
10
  */
9
11
  export interface ListTransactionsCommandInput extends ListTransactionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTransactionsCommand}.
13
17
  */
14
18
  export interface ListTransactionsCommandOutput extends ListTransactionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <p>This operation can help you identify uncommitted transactions or to get information about transactions.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTransactionsCommandOutput extends ListTransactionsResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTransactionsCommandInput - {@link ListTransactionsCommandInput}
35
+ * @returns {@link ListTransactionsCommandOutput}
29
36
  * @see {@link ListTransactionsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTransactionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListTransactionsCommandOutput extends ListTransactionsResponse,
44
51
  export declare class ListTransactionsCommand extends $Command<ListTransactionsCommandInput, ListTransactionsCommandOutput, LakeFormationClientResolvedConfig> {
45
52
  readonly input: ListTransactionsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListTransactionsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTransactionsCommandInput, ListTransactionsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { PutDataLakeSettingsRequest, PutDataLakeSettingsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutDataLakeSettingsCommand}.
8
10
  */
9
11
  export interface PutDataLakeSettingsCommandInput extends PutDataLakeSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutDataLakeSettingsCommand}.
13
17
  */
14
18
  export interface PutDataLakeSettingsCommandOutput extends PutDataLakeSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface PutDataLakeSettingsCommandOutput extends PutDataLakeSettingsRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param PutDataLakeSettingsCommandInput - {@link PutDataLakeSettingsCommandInput}
35
+ * @returns {@link PutDataLakeSettingsCommandOutput}
29
36
  * @see {@link PutDataLakeSettingsCommandInput} for command's `input` shape.
30
37
  * @see {@link PutDataLakeSettingsCommandOutput} for command's `response` shape.
31
38
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -41,11 +48,20 @@ export interface PutDataLakeSettingsCommandOutput extends PutDataLakeSettingsRes
41
48
  export declare class PutDataLakeSettingsCommand extends $Command<PutDataLakeSettingsCommandInput, PutDataLakeSettingsCommandOutput, LakeFormationClientResolvedConfig> {
42
49
  readonly input: PutDataLakeSettingsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: PutDataLakeSettingsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutDataLakeSettingsCommandInput, PutDataLakeSettingsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { RegisterResourceRequest, RegisterResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RegisterResourceCommand}.
8
10
  */
9
11
  export interface RegisterResourceCommandInput extends RegisterResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RegisterResourceCommand}.
13
17
  */
14
18
  export interface RegisterResourceCommandOutput extends RegisterResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Registers the resource as managed by the Data Catalog.</p>
18
23
  * <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>
19
24
  * <p>The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.</p>
@@ -35,6 +40,8 @@ export interface RegisterResourceCommandOutput extends RegisterResourceResponse,
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param RegisterResourceCommandInput - {@link RegisterResourceCommandInput}
44
+ * @returns {@link RegisterResourceCommandOutput}
38
45
  * @see {@link RegisterResourceCommandInput} for command's `input` shape.
39
46
  * @see {@link RegisterResourceCommandOutput} for command's `response` shape.
40
47
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -65,11 +72,20 @@ export interface RegisterResourceCommandOutput extends RegisterResourceResponse,
65
72
  export declare class RegisterResourceCommand extends $Command<RegisterResourceCommandInput, RegisterResourceCommandOutput, LakeFormationClientResolvedConfig> {
66
73
  readonly input: RegisterResourceCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: RegisterResourceCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterResourceCommandInput, RegisterResourceCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { RemoveLFTagsFromResourceRequest, RemoveLFTagsFromResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveLFTagsFromResourceCommand}.
8
10
  */
9
11
  export interface RemoveLFTagsFromResourceCommandInput extends RemoveLFTagsFromResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveLFTagsFromResourceCommand}.
13
17
  */
14
18
  export interface RemoveLFTagsFromResourceCommandOutput extends RemoveLFTagsFromResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 RemoveLFTagsFromResourceCommandOutput extends RemoveLFTagsFromR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RemoveLFTagsFromResourceCommandInput - {@link RemoveLFTagsFromResourceCommandInput}
34
+ * @returns {@link RemoveLFTagsFromResourceCommandOutput}
28
35
  * @see {@link RemoveLFTagsFromResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link RemoveLFTagsFromResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -55,11 +62,20 @@ export interface RemoveLFTagsFromResourceCommandOutput extends RemoveLFTagsFromR
55
62
  export declare class RemoveLFTagsFromResourceCommand extends $Command<RemoveLFTagsFromResourceCommandInput, RemoveLFTagsFromResourceCommandOutput, LakeFormationClientResolvedConfig> {
56
63
  readonly input: RemoveLFTagsFromResourceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: RemoveLFTagsFromResourceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveLFTagsFromResourceCommandInput, RemoveLFTagsFromResourceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { RevokePermissionsRequest, RevokePermissionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RevokePermissionsCommand}.
8
10
  */
9
11
  export interface RevokePermissionsCommandInput extends RevokePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RevokePermissionsCommand}.
13
17
  */
14
18
  export interface RevokePermissionsCommandOutput extends RevokePermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 RevokePermissionsCommandOutput extends RevokePermissionsRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RevokePermissionsCommandInput - {@link RevokePermissionsCommandInput}
34
+ * @returns {@link RevokePermissionsCommandOutput}
28
35
  * @see {@link RevokePermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link RevokePermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -43,11 +50,20 @@ export interface RevokePermissionsCommandOutput extends RevokePermissionsRespons
43
50
  export declare class RevokePermissionsCommand extends $Command<RevokePermissionsCommandInput, RevokePermissionsCommandOutput, LakeFormationClientResolvedConfig> {
44
51
  readonly input: RevokePermissionsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: RevokePermissionsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RevokePermissionsCommandInput, RevokePermissionsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LakeFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LakeFormationClient";
5
5
  import { SearchDatabasesByLFTagsRequest, SearchDatabasesByLFTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchDatabasesByLFTagsCommand}.
8
10
  */
9
11
  export interface SearchDatabasesByLFTagsCommandInput extends SearchDatabasesByLFTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchDatabasesByLFTagsCommand}.
13
17
  */
14
18
  export interface SearchDatabasesByLFTagsCommandOutput extends SearchDatabasesByLFTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 SearchDatabasesByLFTagsCommandOutput extends SearchDatabasesByL
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param SearchDatabasesByLFTagsCommandInput - {@link SearchDatabasesByLFTagsCommandInput}
34
+ * @returns {@link SearchDatabasesByLFTagsCommandOutput}
28
35
  * @see {@link SearchDatabasesByLFTagsCommandInput} for command's `input` shape.
29
36
  * @see {@link SearchDatabasesByLFTagsCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -52,11 +59,20 @@ export interface SearchDatabasesByLFTagsCommandOutput extends SearchDatabasesByL
52
59
  export declare class SearchDatabasesByLFTagsCommand extends $Command<SearchDatabasesByLFTagsCommandInput, SearchDatabasesByLFTagsCommandOutput, LakeFormationClientResolvedConfig> {
53
60
  readonly input: SearchDatabasesByLFTagsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: SearchDatabasesByLFTagsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchDatabasesByLFTagsCommandInput, SearchDatabasesByLFTagsCommandOutput>;
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 { SearchTablesByLFTagsRequest, SearchTablesByLFTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchTablesByLFTagsCommand}.
8
10
  */
9
11
  export interface SearchTablesByLFTagsCommandInput extends SearchTablesByLFTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchTablesByLFTagsCommand}.
13
17
  */
14
18
  export interface SearchTablesByLFTagsCommandOutput extends SearchTablesByLFTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 SearchTablesByLFTagsCommandOutput extends SearchTablesByLFTagsR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param SearchTablesByLFTagsCommandInput - {@link SearchTablesByLFTagsCommandInput}
34
+ * @returns {@link SearchTablesByLFTagsCommandOutput}
28
35
  * @see {@link SearchTablesByLFTagsCommandInput} for command's `input` shape.
29
36
  * @see {@link SearchTablesByLFTagsCommandOutput} for command's `response` shape.
30
37
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -52,11 +59,20 @@ export interface SearchTablesByLFTagsCommandOutput extends SearchTablesByLFTagsR
52
59
  export declare class SearchTablesByLFTagsCommand extends $Command<SearchTablesByLFTagsCommandInput, SearchTablesByLFTagsCommandOutput, LakeFormationClientResolvedConfig> {
53
60
  readonly input: SearchTablesByLFTagsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: SearchTablesByLFTagsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchTablesByLFTagsCommandInput, SearchTablesByLFTagsCommandOutput>;
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 { StartQueryPlanningRequest, StartQueryPlanningResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartQueryPlanningCommand}.
8
10
  */
9
11
  export interface StartQueryPlanningCommandInput extends StartQueryPlanningRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartQueryPlanningCommand}.
13
17
  */
14
18
  export interface StartQueryPlanningCommandOutput extends StartQueryPlanningResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Submits a request to process a query statement.</p>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartQueryPlanningCommandOutput extends StartQueryPlanningRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartQueryPlanningCommandInput - {@link StartQueryPlanningCommandInput}
35
+ * @returns {@link StartQueryPlanningCommandOutput}
29
36
  * @see {@link StartQueryPlanningCommandInput} for command's `input` shape.
30
37
  * @see {@link StartQueryPlanningCommandOutput} for command's `response` shape.
31
38
  * @see {@link LakeFormationClientResolvedConfig | config} for LakeFormationClient's `config` shape.
@@ -47,11 +54,20 @@ export interface StartQueryPlanningCommandOutput extends StartQueryPlanningRespo
47
54
  export declare class StartQueryPlanningCommand extends $Command<StartQueryPlanningCommandInput, StartQueryPlanningCommandOutput, LakeFormationClientResolvedConfig> {
48
55
  readonly input: StartQueryPlanningCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: StartQueryPlanningCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LakeFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartQueryPlanningCommandInput, StartQueryPlanningCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }