import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class LakeFormation extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: LakeFormation.Types.ClientConfiguration) config: Config & LakeFormation.Types.ClientConfiguration; /** * Attaches one or more tags to an existing resource. */ addLFTagsToResource(params: LakeFormation.Types.AddLFTagsToResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.AddLFTagsToResourceResponse) => void): Request; /** * Attaches one or more tags to an existing resource. */ addLFTagsToResource(callback?: (err: AWSError, data: LakeFormation.Types.AddLFTagsToResourceResponse) => void): Request; /** * Batch operation to grant permissions to the principal. */ batchGrantPermissions(params: LakeFormation.Types.BatchGrantPermissionsRequest, callback?: (err: AWSError, data: LakeFormation.Types.BatchGrantPermissionsResponse) => void): Request; /** * Batch operation to grant permissions to the principal. */ batchGrantPermissions(callback?: (err: AWSError, data: LakeFormation.Types.BatchGrantPermissionsResponse) => void): Request; /** * Batch operation to revoke permissions from the principal. */ batchRevokePermissions(params: LakeFormation.Types.BatchRevokePermissionsRequest, callback?: (err: AWSError, data: LakeFormation.Types.BatchRevokePermissionsResponse) => void): Request; /** * Batch operation to revoke permissions from the principal. */ batchRevokePermissions(callback?: (err: AWSError, data: LakeFormation.Types.BatchRevokePermissionsResponse) => void): Request; /** * Creates a tag with the specified name and values. */ createLFTag(params: LakeFormation.Types.CreateLFTagRequest, callback?: (err: AWSError, data: LakeFormation.Types.CreateLFTagResponse) => void): Request; /** * Creates a tag with the specified name and values. */ createLFTag(callback?: (err: AWSError, data: LakeFormation.Types.CreateLFTagResponse) => void): Request; /** * Deletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the tag key is still attached with resources. You can consider untagging resources with this tag key. */ deleteLFTag(params: LakeFormation.Types.DeleteLFTagRequest, callback?: (err: AWSError, data: LakeFormation.Types.DeleteLFTagResponse) => void): Request; /** * Deletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the tag key is still attached with resources. You can consider untagging resources with this tag key. */ deleteLFTag(callback?: (err: AWSError, data: LakeFormation.Types.DeleteLFTagResponse) => void): Request; /** * Deregisters the resource as managed by the Data Catalog. When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role. */ deregisterResource(params: LakeFormation.Types.DeregisterResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.DeregisterResourceResponse) => void): Request; /** * Deregisters the resource as managed by the Data Catalog. When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role. */ deregisterResource(callback?: (err: AWSError, data: LakeFormation.Types.DeregisterResourceResponse) => void): Request; /** * Retrieves the current data access role for the given resource registered in AWS Lake Formation. */ describeResource(params: LakeFormation.Types.DescribeResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.DescribeResourceResponse) => void): Request; /** * Retrieves the current data access role for the given resource registered in AWS Lake Formation. */ describeResource(callback?: (err: AWSError, data: LakeFormation.Types.DescribeResourceResponse) => void): Request; /** * Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. */ getDataLakeSettings(params: LakeFormation.Types.GetDataLakeSettingsRequest, callback?: (err: AWSError, data: LakeFormation.Types.GetDataLakeSettingsResponse) => void): Request; /** * Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. */ getDataLakeSettings(callback?: (err: AWSError, data: LakeFormation.Types.GetDataLakeSettingsResponse) => void): Request; /** * Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted. */ getEffectivePermissionsForPath(params: LakeFormation.Types.GetEffectivePermissionsForPathRequest, callback?: (err: AWSError, data: LakeFormation.Types.GetEffectivePermissionsForPathResponse) => void): Request; /** * Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted. */ getEffectivePermissionsForPath(callback?: (err: AWSError, data: LakeFormation.Types.GetEffectivePermissionsForPathResponse) => void): Request; /** * Returns a tag definition. */ getLFTag(params: LakeFormation.Types.GetLFTagRequest, callback?: (err: AWSError, data: LakeFormation.Types.GetLFTagResponse) => void): Request; /** * Returns a tag definition. */ getLFTag(callback?: (err: AWSError, data: LakeFormation.Types.GetLFTagResponse) => void): Request; /** * Returns the tags applied to a resource. */ getResourceLFTags(params: LakeFormation.Types.GetResourceLFTagsRequest, callback?: (err: AWSError, data: LakeFormation.Types.GetResourceLFTagsResponse) => void): Request; /** * Returns the tags applied to a resource. */ getResourceLFTags(callback?: (err: AWSError, data: LakeFormation.Types.GetResourceLFTagsResponse) => void): Request; /** * Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. For information about permissions, see Security and Access Control to Metadata and Data. */ grantPermissions(params: LakeFormation.Types.GrantPermissionsRequest, callback?: (err: AWSError, data: LakeFormation.Types.GrantPermissionsResponse) => void): Request; /** * Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. For information about permissions, see Security and Access Control to Metadata and Data. */ grantPermissions(callback?: (err: AWSError, data: LakeFormation.Types.GrantPermissionsResponse) => void): Request; /** * Lists tags that the requester has permission to view. */ listLFTags(params: LakeFormation.Types.ListLFTagsRequest, callback?: (err: AWSError, data: LakeFormation.Types.ListLFTagsResponse) => void): Request; /** * Lists tags that the requester has permission to view. */ listLFTags(callback?: (err: AWSError, data: LakeFormation.Types.ListLFTagsResponse) => void): Request; /** * 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. This operation returns only those permissions that have been explicitly granted. For information about permissions, see Security and Access Control to Metadata and Data. */ listPermissions(params: LakeFormation.Types.ListPermissionsRequest, callback?: (err: AWSError, data: LakeFormation.Types.ListPermissionsResponse) => void): Request; /** * 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. This operation returns only those permissions that have been explicitly granted. For information about permissions, see Security and Access Control to Metadata and Data. */ listPermissions(callback?: (err: AWSError, data: LakeFormation.Types.ListPermissionsResponse) => void): Request; /** * Lists the resources registered to be managed by the Data Catalog. */ listResources(params: LakeFormation.Types.ListResourcesRequest, callback?: (err: AWSError, data: LakeFormation.Types.ListResourcesResponse) => void): Request; /** * Lists the resources registered to be managed by the Data Catalog. */ listResources(callback?: (err: AWSError, data: LakeFormation.Types.ListResourcesResponse) => void): Request; /** * 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 Granting Lake Formation Permissions. 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. */ putDataLakeSettings(params: LakeFormation.Types.PutDataLakeSettingsRequest, callback?: (err: AWSError, data: LakeFormation.Types.PutDataLakeSettingsResponse) => void): Request; /** * 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 Granting Lake Formation Permissions. 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. */ putDataLakeSettings(callback?: (err: AWSError, data: LakeFormation.Types.PutDataLakeSettingsResponse) => void): Request; /** * Registers the resource as managed by the Data Catalog. 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. The following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location. ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn: arn:aws:iam::12345:role/my-data-access-role */ registerResource(params: LakeFormation.Types.RegisterResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.RegisterResourceResponse) => void): Request; /** * Registers the resource as managed by the Data Catalog. 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. The following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location. ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn: arn:aws:iam::12345:role/my-data-access-role */ registerResource(callback?: (err: AWSError, data: LakeFormation.Types.RegisterResourceResponse) => void): Request; /** * Removes a tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input. */ removeLFTagsFromResource(params: LakeFormation.Types.RemoveLFTagsFromResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.RemoveLFTagsFromResourceResponse) => void): Request; /** * Removes a tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input. */ removeLFTagsFromResource(callback?: (err: AWSError, data: LakeFormation.Types.RemoveLFTagsFromResourceResponse) => void): Request; /** * Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. */ revokePermissions(params: LakeFormation.Types.RevokePermissionsRequest, callback?: (err: AWSError, data: LakeFormation.Types.RevokePermissionsResponse) => void): Request; /** * Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. */ revokePermissions(callback?: (err: AWSError, data: LakeFormation.Types.RevokePermissionsResponse) => void): Request; /** * This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared. */ searchDatabasesByLFTags(params: LakeFormation.Types.SearchDatabasesByLFTagsRequest, callback?: (err: AWSError, data: LakeFormation.Types.SearchDatabasesByLFTagsResponse) => void): Request; /** * This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared. */ searchDatabasesByLFTags(callback?: (err: AWSError, data: LakeFormation.Types.SearchDatabasesByLFTagsResponse) => void): Request; /** * This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LFTags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared. */ searchTablesByLFTags(params: LakeFormation.Types.SearchTablesByLFTagsRequest, callback?: (err: AWSError, data: LakeFormation.Types.SearchTablesByLFTagsResponse) => void): Request; /** * This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LFTags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared. */ searchTablesByLFTags(callback?: (err: AWSError, data: LakeFormation.Types.SearchTablesByLFTagsResponse) => void): Request; /** * Updates the list of possible values for the specified tag key. If the 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 tag key's value. */ updateLFTag(params: LakeFormation.Types.UpdateLFTagRequest, callback?: (err: AWSError, data: LakeFormation.Types.UpdateLFTagResponse) => void): Request; /** * Updates the list of possible values for the specified tag key. If the 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 tag key's value. */ updateLFTag(callback?: (err: AWSError, data: LakeFormation.Types.UpdateLFTagResponse) => void): Request; /** * Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation. */ updateResource(params: LakeFormation.Types.UpdateResourceRequest, callback?: (err: AWSError, data: LakeFormation.Types.UpdateResourceResponse) => void): Request; /** * Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation. */ updateResource(callback?: (err: AWSError, data: LakeFormation.Types.UpdateResourceResponse) => void): Request; } declare namespace LakeFormation { export interface AddLFTagsToResourceRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The resource to which to attach a tag. */ Resource: Resource; /** * The tags to attach to the resource. */ LFTags: LFTagsList; } export interface AddLFTagsToResourceResponse { /** * A list of failures to tag the resource. */ Failures?: LFTagErrors; } export interface BatchGrantPermissionsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * A list of up to 20 entries for resource permissions to be granted by batch operation to the principal. */ Entries: BatchPermissionsRequestEntryList; } export interface BatchGrantPermissionsResponse { /** * A list of failures to grant permissions to the resources. */ Failures?: BatchPermissionsFailureList; } export interface BatchPermissionsFailureEntry { /** * An identifier for an entry of the batch request. */ RequestEntry?: BatchPermissionsRequestEntry; /** * An error message that applies to the failure of the entry. */ Error?: ErrorDetail; } export type BatchPermissionsFailureList = BatchPermissionsFailureEntry[]; export interface BatchPermissionsRequestEntry { /** * A unique identifier for the batch permissions request entry. */ Id: Identifier; /** * The principal to be granted a permission. */ Principal?: DataLakePrincipal; /** * The resource to which the principal is to be granted a permission. */ Resource?: Resource; /** * The permissions to be granted. */ Permissions?: PermissionList; /** * Indicates if the option to pass permissions is granted. */ PermissionsWithGrantOption?: PermissionList; } export type BatchPermissionsRequestEntryList = BatchPermissionsRequestEntry[]; export interface BatchRevokePermissionsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal. */ Entries: BatchPermissionsRequestEntryList; } export interface BatchRevokePermissionsResponse { /** * A list of failures to revoke permissions to the resources. */ Failures?: BatchPermissionsFailureList; } export type BooleanNullable = boolean; export type CatalogIdString = string; export interface CatalogResource { } export interface ColumnLFTag { /** * The name of a column resource. */ Name?: NameString; /** * The tags attached to a column resource. */ LFTags?: LFTagsList; } export type ColumnLFTagsList = ColumnLFTag[]; export type ColumnNames = NameString[]; export interface ColumnWildcard { /** * Excludes column names. Any column with this name will be excluded. */ ExcludedColumnNames?: ColumnNames; } export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|"CONTAINS"|"NOT_CONTAINS"|"BEGINS_WITH"|"IN"|"BETWEEN"|string; export interface CreateLFTagRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag. */ TagKey: LFTagKey; /** * A list of possible values an attribute can take. */ TagValues: TagValueList; } export interface CreateLFTagResponse { } export interface DataLakePrincipal { /** * An identifier for the AWS Lake Formation principal. */ DataLakePrincipalIdentifier?: DataLakePrincipalString; } export type DataLakePrincipalList = DataLakePrincipal[]; export type DataLakePrincipalString = string; export type DataLakeResourceType = "CATALOG"|"DATABASE"|"TABLE"|"DATA_LOCATION"|"LF_TAG"|"LF_TAG_POLICY"|"LF_TAG_POLICY_DATABASE"|"LF_TAG_POLICY_TABLE"|string; export interface DataLakeSettings { /** * A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles. */ DataLakeAdmins?: DataLakePrincipalList; /** * A structure representing a list of up to three principal permissions entries for default create database permissions. */ CreateDatabaseDefaultPermissions?: PrincipalPermissionsList; /** * A structure representing a list of up to three principal permissions entries for default create table permissions. */ CreateTableDefaultPermissions?: PrincipalPermissionsList; /** * A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's AWS CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company. */ TrustedResourceOwners?: TrustedResourceOwners; } export interface DataLocationResource { /** * The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller. */ CatalogId?: CatalogIdString; /** * The Amazon Resource Name (ARN) that uniquely identifies the data location resource. */ ResourceArn: ResourceArnString; } export type DatabaseLFTagsList = TaggedDatabase[]; export interface DatabaseResource { /** * The identifier for the Data Catalog. By default, it is the account ID of the caller. */ CatalogId?: CatalogIdString; /** * The name of the database resource. Unique to the Data Catalog. */ Name: NameString; } export interface DeleteLFTagRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag to delete. */ TagKey: LFTagKey; } export interface DeleteLFTagResponse { } export interface DeregisterResourceRequest { /** * The Amazon Resource Name (ARN) of the resource that you want to deregister. */ ResourceArn: ResourceArnString; } export interface DeregisterResourceResponse { } export interface DescribeResourceRequest { /** * The resource ARN. */ ResourceArn: ResourceArnString; } export interface DescribeResourceResponse { /** * A structure containing information about an AWS Lake Formation resource. */ ResourceInfo?: ResourceInfo; } export type DescriptionString = string; export interface DetailsMap { /** * A resource share ARN for a catalog resource shared through AWS Resource Access Manager (AWS RAM). */ ResourceShare?: ResourceShareList; } export interface ErrorDetail { /** * The code associated with this error. */ ErrorCode?: NameString; /** * A message describing the error. */ ErrorMessage?: DescriptionString; } export type Expression = LFTag[]; export type FieldNameString = "RESOURCE_ARN"|"ROLE_ARN"|"LAST_MODIFIED"|string; export interface FilterCondition { /** * The field to filter in the filter condition. */ Field?: FieldNameString; /** * The comparison operator used in the filter condition. */ ComparisonOperator?: ComparisonOperator; /** * A string with values used in evaluating the filter condition. */ StringValueList?: StringValueList; } export type FilterConditionList = FilterCondition[]; export interface GetDataLakeSettingsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; } export interface GetDataLakeSettingsResponse { /** * A structure representing a list of AWS Lake Formation principals designated as data lake administrators. */ DataLakeSettings?: DataLakeSettings; } export interface GetEffectivePermissionsForPathRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The Amazon Resource Name (ARN) of the resource for which you want to get permissions. */ ResourceArn: ResourceArnString; /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; /** * The maximum number of results to return. */ MaxResults?: PageSize; } export interface GetEffectivePermissionsForPathResponse { /** * A list of the permissions for the specified table or database resource located at the path in Amazon S3. */ Permissions?: PrincipalResourcePermissionsList; /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; } export interface GetLFTagRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag. */ TagKey: LFTagKey; } export interface GetLFTagResponse { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag. */ TagKey?: LFTagKey; /** * A list of possible values an attribute can take. */ TagValues?: TagValueList; } export interface GetResourceLFTagsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The resource for which you want to return tags. */ Resource: Resource; /** * Indicates whether to show the assigned tags. */ ShowAssignedLFTags?: BooleanNullable; } export interface GetResourceLFTagsResponse { /** * A list of tags applied to a database resource. */ LFTagOnDatabase?: LFTagsList; /** * A list of tags applied to a table resource. */ LFTagsOnTable?: LFTagsList; /** * A list of tags applied to a column resource. */ LFTagsOnColumns?: ColumnLFTagsList; } export interface GrantPermissionsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN. Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted. */ Principal: DataLakePrincipal; /** * The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables. */ Resource: Resource; /** * The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation resources. */ Permissions: PermissionList; /** * Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges. */ PermissionsWithGrantOption?: PermissionList; } export interface GrantPermissionsResponse { } export type IAMRoleArn = string; export type Identifier = string; export interface LFTag { /** * The key-name for the tag. */ TagKey: LFTagKey; /** * A list of possible values an attribute can take. */ TagValues: TagValueList; } export interface LFTagError { /** * The key-name of the tag. */ LFTag?: LFTagPair; /** * An error that occurred with the attachment or detachment of the tag. */ Error?: ErrorDetail; } export type LFTagErrors = LFTagError[]; export type LFTagKey = string; export interface LFTagKeyResource { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag. */ TagKey: NameString; /** * A list of possible values an attribute can take. */ TagValues: TagValueList; } export interface LFTagPair { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag. */ TagKey: LFTagKey; /** * A list of possible values an attribute can take. */ TagValues: TagValueList; } export interface LFTagPolicyResource { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The resource type for which the tag policy applies. */ ResourceType: ResourceType; /** * A list of tag conditions that apply to the resource's tag policy. */ Expression: Expression; } export type LFTagValue = string; export type LFTagsList = LFTagPair[]; export type LastModifiedTimestamp = Date; export interface ListLFTagsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * If resource share type is ALL, returns both in-account tags and shared tags that the requester has permission to view. If resource share type is FOREIGN, returns all share tags that the requester can view. If no resource share type is passed, lists tags in the given catalog ID that the requester has permission to view. */ ResourceShareType?: ResourceShareType; /** * The maximum number of results to return. */ MaxResults?: PageSize; /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; } export interface ListLFTagsResponse { /** * A list of tags that the requested has permission to view. */ LFTags?: LFTagsList; /** * A continuation token, present if the current list segment is not the last. */ NextToken?: Token; } export interface ListPermissionsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * Specifies a principal to filter the permissions returned. */ Principal?: DataLakePrincipal; /** * Specifies a resource type to filter the permissions returned. */ ResourceType?: DataLakeResourceType; /** * A resource where you will get a list of the principal permissions. This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns. */ Resource?: Resource; /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; /** * The maximum number of results to return. */ MaxResults?: PageSize; } export interface ListPermissionsResponse { /** * A list of principals and their permissions on the resource for the specified principal and resource types. */ PrincipalResourcePermissions?: PrincipalResourcePermissionsList; /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; } export interface ListResourcesRequest { /** * Any applicable row-level and/or column-level filtering conditions for the resources. */ FilterConditionList?: FilterConditionList; /** * The maximum number of resource results. */ MaxResults?: PageSize; /** * A continuation token, if this is not the first call to retrieve these resources. */ NextToken?: Token; } export interface ListResourcesResponse { /** * A summary of the data lake resources. */ ResourceInfoList?: ResourceInfoList; /** * A continuation token, if this is not the first call to retrieve these resources. */ NextToken?: Token; } export type NameString = string; export type NullableBoolean = boolean; export type PageSize = number; export type Permission = "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"DESCRIBE"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"|"CREATE_TAG"|"ALTER_TAG"|"DELETE_TAG"|"DESCRIBE_TAG"|"ASSOCIATE_TAG"|string; export type PermissionList = Permission[]; export interface PrincipalPermissions { /** * The principal who is granted permissions. */ Principal?: DataLakePrincipal; /** * The permissions that are granted to the principal. */ Permissions?: PermissionList; } export type PrincipalPermissionsList = PrincipalPermissions[]; export interface PrincipalResourcePermissions { /** * The Data Lake principal to be granted or revoked permissions. */ Principal?: DataLakePrincipal; /** * The resource where permissions are to be granted or revoked. */ Resource?: Resource; /** * The permissions to be granted or revoked on the resource. */ Permissions?: PermissionList; /** * Indicates whether to grant the ability to grant permissions (as a subset of permissions granted). */ PermissionsWithGrantOption?: PermissionList; /** * This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM resource share ARN. */ AdditionalDetails?: DetailsMap; } export type PrincipalResourcePermissionsList = PrincipalResourcePermissions[]; export interface PutDataLakeSettingsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * A structure representing a list of AWS Lake Formation principals designated as data lake administrators. */ DataLakeSettings: DataLakeSettings; } export interface PutDataLakeSettingsResponse { } export type RAMResourceShareArn = string; export interface RegisterResourceRequest { /** * The Amazon Resource Name (ARN) of the resource that you want to register. */ ResourceArn: ResourceArnString; /** * Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation. For more information, see Using Service-Linked Roles for Lake Formation. */ UseServiceLinkedRole?: NullableBoolean; /** * The identifier for the role that registers the resource. */ RoleArn?: IAMRoleArn; } export interface RegisterResourceResponse { } export interface RemoveLFTagsFromResourceRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The resource where you want to remove a tag. */ Resource: Resource; /** * The tags to be removed from the resource. */ LFTags: LFTagsList; } export interface RemoveLFTagsFromResourceResponse { /** * A list of failures to untag a resource. */ Failures?: LFTagErrors; } export interface Resource { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ Catalog?: CatalogResource; /** * The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. */ Database?: DatabaseResource; /** * The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. */ Table?: TableResource; /** * The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. */ TableWithColumns?: TableWithColumnsResource; /** * The location of an Amazon S3 path where permissions are granted or revoked. */ DataLocation?: DataLocationResource; /** * The tag key and values attached to a resource. */ LFTag?: LFTagKeyResource; /** * A list of tag conditions that define a resource's tag policy. */ LFTagPolicy?: LFTagPolicyResource; } export type ResourceArnString = string; export interface ResourceInfo { /** * The Amazon Resource Name (ARN) of the resource. */ ResourceArn?: ResourceArnString; /** * The IAM role that registered a resource. */ RoleArn?: IAMRoleArn; /** * The date and time the resource was last modified. */ LastModified?: LastModifiedTimestamp; } export type ResourceInfoList = ResourceInfo[]; export type ResourceShareList = RAMResourceShareArn[]; export type ResourceShareType = "FOREIGN"|"ALL"|string; export type ResourceType = "DATABASE"|"TABLE"|string; export interface RevokePermissionsRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The principal to be revoked permissions on the resource. */ Principal: DataLakePrincipal; /** * The resource to which permissions are to be revoked. */ Resource: Resource; /** * The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data. */ Permissions: PermissionList; /** * Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals. */ PermissionsWithGrantOption?: PermissionList; } export interface RevokePermissionsResponse { } export interface SearchDatabasesByLFTagsRequest { /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; /** * The maximum number of results to return. */ MaxResults?: PageSize; /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * A list of conditions (LFTag structures) to search for in database resources. */ Expression: Expression; } export interface SearchDatabasesByLFTagsResponse { /** * A continuation token, present if the current list segment is not the last. */ NextToken?: Token; /** * A list of databases that meet the tag conditions. */ DatabaseList?: DatabaseLFTagsList; } export interface SearchTablesByLFTagsRequest { /** * A continuation token, if this is not the first call to retrieve this list. */ NextToken?: Token; /** * The maximum number of results to return. */ MaxResults?: PageSize; /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * A list of conditions (LFTag structures) to search for in table resources. */ Expression: Expression; } export interface SearchTablesByLFTagsResponse { /** * A continuation token, present if the current list segment is not the last. */ NextToken?: Token; /** * A list of tables that meet the tag conditions. */ TableList?: TableLFTagsList; } export type StringValue = string; export type StringValueList = StringValue[]; export type TableLFTagsList = TaggedTable[]; export interface TableResource { /** * The identifier for the Data Catalog. By default, it is the account ID of the caller. */ CatalogId?: CatalogIdString; /** * The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. */ DatabaseName: NameString; /** * The name of the table. */ Name?: NameString; /** * A wildcard object representing every table under a database. At least one of TableResource$Name or TableResource$TableWildcard is required. */ TableWildcard?: TableWildcard; } export interface TableWildcard { } export interface TableWithColumnsResource { /** * The identifier for the Data Catalog. By default, it is the account ID of the caller. */ CatalogId?: CatalogIdString; /** * The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. */ DatabaseName: NameString; /** * The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. */ Name: NameString; /** * The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required. */ ColumnNames?: ColumnNames; /** * A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required. */ ColumnWildcard?: ColumnWildcard; } export type TagValueList = LFTagValue[]; export interface TaggedDatabase { /** * A database that has tags attached to it. */ Database?: DatabaseResource; /** * A list of tags attached to the database. */ LFTags?: LFTagsList; } export interface TaggedTable { /** * A table that has tags attached to it. */ Table?: TableResource; /** * A list of tags attached to the database where the table resides. */ LFTagOnDatabase?: LFTagsList; /** * A list of tags attached to the table. */ LFTagsOnTable?: LFTagsList; /** * A list of tags attached to columns in the table. */ LFTagsOnColumns?: ColumnLFTagsList; } export type Token = string; export type TrustedResourceOwners = CatalogIdString[]; export interface UpdateLFTagRequest { /** * The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. */ CatalogId?: CatalogIdString; /** * The key-name for the tag for which to add or delete values. */ TagKey: LFTagKey; /** * A list of tag values to delete from the tag. */ TagValuesToDelete?: TagValueList; /** * A list of tag values to add from the tag. */ TagValuesToAdd?: TagValueList; } export interface UpdateLFTagResponse { } export interface UpdateResourceRequest { /** * The new role to use for the given resource registered in AWS Lake Formation. */ RoleArn: IAMRoleArn; /** * The resource ARN. */ ResourceArn: ResourceArnString; } export interface UpdateResourceResponse { } /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2017-03-31"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the LakeFormation client. */ export import Types = LakeFormation; } export = LakeFormation;