@datafire/amazonaws_lakeformation

Client library for AWS Lake Formation

Installation and Usage

``bash
npm install --save @datafire/amazonaws_lakeformation
`
`js
let amazonaws_lakeformation = require('@datafire/amazonaws_lakeformation').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

.then(data => {
console.log(data);
});
`

Description

AWS Lake Formation

Defines the public endpoint for the AWS Lake Formation service.

Actions

$3

`js
amazonaws_lakeformation.BatchGrantPermissions({
"Entries": null
}, context)
`

#### Input
* input object
* CatalogId
* Entries required
* items BatchPermissionsRequestEntry

#### Output
* output BatchGrantPermissionsResponse

$3

`js
amazonaws_lakeformation.BatchRevokePermissions({
"Entries": null
}, context)
`

#### Input
* input object
* CatalogId
* Entries required
* items BatchPermissionsRequestEntry

#### Output
* output BatchRevokePermissionsResponse

$3

`js
amazonaws_lakeformation.DeregisterResource({
"ResourceArn": null
}, context)
`

#### Input
* input object
* ResourceArn required

#### Output
* output DeregisterResourceResponse

$3

`js
amazonaws_lakeformation.DescribeResource({
"ResourceArn": null
}, context)
`

#### Input
* input object
* ResourceArn required

#### Output
* output DescribeResourceResponse

$3

`js
amazonaws_lakeformation.GetDataLakeSettings({}, context)
`

#### Input
* input object
* CatalogId

#### Output
* output GetDataLakeSettingsResponse

$3

`js
amazonaws_lakeformation.GetEffectivePermissionsForPath({
"ResourceArn": null
}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* CatalogId
* MaxResults
* NextToken
* ResourceArn required

#### Output
* output GetEffectivePermissionsForPathResponse

$3

`js
amazonaws_lakeformation.GrantPermissions({
"Principal": null,
"Resource": null,
"Permissions": null
}, context)
`

#### Input
* input object
* CatalogId
* Permissions required
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal required
* DataLakePrincipalIdentifier
* Resource required
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

#### Output
* output GrantPermissionsResponse

$3

`js
amazonaws_lakeformation.ListPermissions({}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* CatalogId
* MaxResults
* NextToken
* Principal
* DataLakePrincipalIdentifier
* Resource
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required
* ResourceType

#### Output
* output ListPermissionsResponse

$3

`js
amazonaws_lakeformation.ListResources({}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* FilterConditionList
* items FilterCondition
* MaxResults
* NextToken

#### Output
* output ListResourcesResponse

$3

`js
amazonaws_lakeformation.PutDataLakeSettings({
"DataLakeSettings": null
}, context)
`

#### Input
* input object
* CatalogId
* DataLakeSettings required
* CreateDatabaseDefaultPermissions
* items PrincipalPermissions
* CreateTableDefaultPermissions
* items PrincipalPermissions
* DataLakeAdmins
* items DataLakePrincipal
* TrustedResourceOwners
* items CatalogIdString

#### Output
* output PutDataLakeSettingsResponse

$3

`js
amazonaws_lakeformation.RegisterResource({
"ResourceArn": null
}, context)
`

#### Input
* input object
* ResourceArn required
* RoleArn
* UseServiceLinkedRole

#### Output
* output RegisterResourceResponse

$3

`js
amazonaws_lakeformation.RevokePermissions({
"Principal": null,
"Resource": null,
"Permissions": null
}, context)
`

#### Input
* input object
* CatalogId
* Permissions required
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal required
* DataLakePrincipalIdentifier
* Resource required
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

#### Output
* output RevokePermissionsResponse

$3

`js
amazonaws_lakeformation.UpdateResource({
"RoleArn": null,
"ResourceArn": null
}, context)
`

#### Input
* input object
* ResourceArn required
* RoleArn required

#### Output
* output UpdateResourceResponse

Definitions

$3




$3


* BatchGrantPermissionsRequest object
* CatalogId
* Entries required
* items BatchPermissionsRequestEntry

$3

* BatchGrantPermissionsResponse object
* Failures
* items BatchPermissionsFailureEntry

$3

* BatchPermissionsFailureEntry object: A list of failures when performing a batch grant or batch revoke operation.
* Error
* ErrorCode
* ErrorMessage
* RequestEntry
* Id required
* Permissions
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal
* DataLakePrincipalIdentifier
* Resource
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* DatabaseName required
* Name required

$3

* BatchPermissionsFailureList array
* items BatchPermissionsFailureEntry

$3

* BatchPermissionsRequestEntry object: A permission to a resource granted by batch operation to the principal.
* Id required
* Permissions
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal
* DataLakePrincipalIdentifier
* Resource
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* BatchPermissionsRequestEntryList array
* items BatchPermissionsRequestEntry

$3

* BatchRevokePermissionsRequest object
* CatalogId
* Entries required
* items BatchPermissionsRequestEntry

$3

* BatchRevokePermissionsResponse object
* Failures
* items BatchPermissionsFailureEntry

$3

* CatalogIdString string

$3

* CatalogResource object: A structure for the catalog object.

$3

* ColumnNames array
* items NameString

$3

* ColumnWildcard object: A wildcard object, consisting of an optional list of excluded column names or indexes.
* ExcludedColumnNames
* items NameString

$3

* ComparisonOperator string (values: EQ, NE, LE, LT, GE, GT, CONTAINS, NOT_CONTAINS, BEGINS_WITH, IN, BETWEEN)

$3

$3

* DataLakePrincipal object: The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.
* DataLakePrincipalIdentifier

$3

* DataLakePrincipalList array
* items DataLakePrincipal

$3

* DataLakePrincipalString string

$3

* DataLakeResourceType string (values: CATALOG, DATABASE, TABLE, DATA_LOCATION)

$3

* DataLakeSettings object: A structure representing a list of AWS Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.
* CreateDatabaseDefaultPermissions
* items PrincipalPermissions
* CreateTableDefaultPermissions
* items PrincipalPermissions
* DataLakeAdmins
* items DataLakePrincipal
* TrustedResourceOwners
* items CatalogIdString

$3

* DataLocationResource object: A structure for a data location object where permissions are granted or revoked.
* CatalogId
* ResourceArn required

$3

* DatabaseResource object: A structure for the database object.
* CatalogId
* Name required

$3

* DeregisterResourceRequest object
* ResourceArn required

$3

* DeregisterResourceResponse object

$3

* DescribeResourceRequest object
* ResourceArn required

$3

* DescribeResourceResponse object
* ResourceInfo
* LastModified
* ResourceArn
* RoleArn

$3

* DescriptionString string

$3

* DetailsMap object:

A structure containing the additional details to be returned in the AdditionalDetails attribute of PrincipalResourcePermissions.

If a catalog resource is shared through AWS Resource Access Manager (AWS RAM), then there will exist a corresponding RAM share resource ARN.

* ResourceShare
* items RAMResourceShareArn

$3

$3

* ErrorDetail object: Contains details about an error.
* ErrorCode
* ErrorMessage

$3

* FieldNameString string (values: RESOURCE_ARN, ROLE_ARN, LAST_MODIFIED)

$3

* FilterCondition object: This structure describes the filtering of columns in a table based on a filter condition.
* ComparisonOperator
* Field
* StringValueList
* items StringValue

$3

* FilterConditionList array
* items FilterCondition

$3

* GetDataLakeSettingsRequest object
* CatalogId

$3

* GetDataLakeSettingsResponse object
* DataLakeSettings
* CreateDatabaseDefaultPermissions
* items PrincipalPermissions
* CreateTableDefaultPermissions
* items PrincipalPermissions
* DataLakeAdmins
* items DataLakePrincipal
* TrustedResourceOwners
* items CatalogIdString

$3

* GetEffectivePermissionsForPathRequest object
* CatalogId
* MaxResults
* NextToken
* ResourceArn required

$3

* GetEffectivePermissionsForPathResponse object
* NextToken
* Permissions
* items PrincipalResourcePermissions

$3

* GrantPermissionsRequest object
* CatalogId
* Permissions required
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal required
* DataLakePrincipalIdentifier
* Resource required
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* GrantPermissionsResponse object

$3

* IAMRoleArn string

$3

* Identifier string

$3

$3

$3

* LastModifiedTimestamp string

$3

* ListPermissionsRequest object
* CatalogId
* MaxResults
* NextToken
* Principal
* DataLakePrincipalIdentifier
* Resource
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required
* ResourceType

$3

* ListPermissionsResponse object
* NextToken
* PrincipalResourcePermissions
* items PrincipalResourcePermissions

$3

* ListResourcesRequest object
* FilterConditionList
* items FilterCondition
* MaxResults
* NextToken

$3

* ListResourcesResponse object
* NextToken
* ResourceInfoList
* items ResourceInfo

$3

* NameString string

$3

* NullableBoolean boolean

$3

$3

* PageSize integer

$3

* Permission string (values: ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS)

$3

* PermissionList array
* items Permission

$3

* PrincipalPermissions object: Permissions granted to a principal.
* Permissions
* items Permission
* Principal
* DataLakePrincipalIdentifier

$3

* PrincipalPermissionsList array
* items PrincipalPermissions

$3

* PrincipalResourcePermissions object: The permissions granted or revoked on a resource.
* AdditionalDetails
* ResourceShare
* items RAMResourceShareArn
* Permissions
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal
* DataLakePrincipalIdentifier
* Resource
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* PrincipalResourcePermissionsList array
* items PrincipalResourcePermissions

$3

* PutDataLakeSettingsRequest object
* CatalogId
* DataLakeSettings required
* CreateDatabaseDefaultPermissions
* items PrincipalPermissions
* CreateTableDefaultPermissions
* items PrincipalPermissions
* DataLakeAdmins
* items DataLakePrincipal
* TrustedResourceOwners
* items CatalogIdString

$3

* PutDataLakeSettingsResponse object

$3

* RAMResourceShareArn string

$3

* RegisterResourceRequest object
* ResourceArn required
* RoleArn
* UseServiceLinkedRole

$3

* RegisterResourceResponse object

$3

* Resource object: A structure for the resource.
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* ResourceArnString string

$3

* ResourceInfo object: A structure containing information about an AWS Lake Formation resource.
* LastModified
* ResourceArn
* RoleArn

$3

* ResourceInfoList array
* items ResourceInfo

$3

* ResourceShareList array
* items RAMResourceShareArn

$3

* RevokePermissionsRequest object
* CatalogId
* Permissions required
* items Permission
* PermissionsWithGrantOption
* items Permission
* Principal required
* DataLakePrincipalIdentifier
* Resource required
* Catalog
* DataLocation
* CatalogId
* ResourceArn required
* Database
* CatalogId
* Name required
* Table
* CatalogId
* DatabaseName required
* Name
* TableWildcard
* TableWithColumns
* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* RevokePermissionsResponse object

$3

* StringValue string

$3

* StringValueList array
* items StringValue

$3

* TableResource object: A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
* CatalogId
* DatabaseName required
* Name
* TableWildcard

$3

* TableWildcard object: A wildcard object representing every table under a database.

$3

* TableWithColumnsResource object:

A structure for a table with columns object. This object is only used when granting a SELECT permission.

This object must take a value for at least one of ColumnsNames, ColumnsIndexes, or ColumnsWildcard.

* CatalogId
* ColumnNames
* items NameString
* ColumnWildcard
* ExcludedColumnNames
* items NameString
* DatabaseName required
* Name required

$3

* Token string

$3

* TrustedResourceOwners array
* items CatalogIdString

$3

* UpdateResourceRequest object
* ResourceArn required
* RoleArn required

$3

* UpdateResourceResponse object`