@datafire/amazonaws_lakeformation

v5.0.0

Published

2 years ago

DataFire integration for AWS Lake Formation

Downloads

0High
0Medium
0Low

datafire

@datafire/amazonaws_lakeformation

Client library for AWS Lake Formation

Installation and Usage

npm install --save @datafire/amazonaws_lakeformation

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

BatchGrantPermissions

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

Input

input object
- CatalogId
- Entries required
  - items BatchPermissionsRequestEntry

Output

output BatchGrantPermissionsResponse

BatchRevokePermissions

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

Input

input object
- CatalogId
- Entries required
  - items BatchPermissionsRequestEntry

Output

output BatchRevokePermissionsResponse

DeregisterResource

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

Input

input object
- ResourceArn required

Output

output DeregisterResourceResponse

DescribeResource

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

Input

input object
- ResourceArn required

Output

output DescribeResourceResponse

GetDataLakeSettings

amazonaws_lakeformation.GetDataLakeSettings({}, context)

Input

input object
- CatalogId

Output

output GetDataLakeSettingsResponse

GetEffectivePermissionsForPath

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

Input

input object
- MaxResults string
- NextToken string
- CatalogId
- MaxResults
- NextToken
- ResourceArn required

Output

output GetEffectivePermissionsForPathResponse

GrantPermissions

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

ListPermissions

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

ListResources

amazonaws_lakeformation.ListResources({}, context)

Input

input object
- MaxResults string
- NextToken string
- FilterConditionList
  - items FilterCondition
- MaxResults
- NextToken

Output

output ListResourcesResponse

PutDataLakeSettings

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

RegisterResource

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

Input

input object
- ResourceArn required
- RoleArn
- UseServiceLinkedRole

Output

output RegisterResourceResponse

RevokePermissions

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

UpdateResource

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

Input

input object
- ResourceArn required
- RoleArn required

Output

output UpdateResourceResponse

Definitions

AlreadyExistsException

BatchGrantPermissionsRequest

BatchGrantPermissionsRequest object
- CatalogId
- Entries required
  - items BatchPermissionsRequestEntry

BatchGrantPermissionsResponse

BatchGrantPermissionsResponse object
- Failures
  - items BatchPermissionsFailureEntry

BatchPermissionsFailureEntry

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

BatchPermissionsFailureList

BatchPermissionsFailureList array
- items BatchPermissionsFailureEntry

BatchPermissionsRequestEntry

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

BatchPermissionsRequestEntryList

BatchPermissionsRequestEntryList array
- items BatchPermissionsRequestEntry

BatchRevokePermissionsRequest

BatchRevokePermissionsRequest object
- CatalogId
- Entries required
  - items BatchPermissionsRequestEntry

BatchRevokePermissionsResponse

BatchRevokePermissionsResponse object
- Failures
  - items BatchPermissionsFailureEntry

CatalogIdString

CatalogIdString string

CatalogResource

CatalogResource object: A structure for the catalog object.

ColumnNames

ColumnNames array
- items NameString

ColumnWildcard

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

ComparisonOperator

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

ConcurrentModificationException

DataLakePrincipal

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

DataLakePrincipalList

DataLakePrincipalList array
- items DataLakePrincipal

DataLakePrincipalString

DataLakePrincipalString string

DataLakeResourceType

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

DataLakeSettings

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

DataLocationResource

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

DatabaseResource

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

DeregisterResourceRequest

DeregisterResourceRequest object
- ResourceArn required

DeregisterResourceResponse

DeregisterResourceResponse object

DescribeResourceRequest

DescribeResourceRequest object
- ResourceArn required

DescribeResourceResponse

DescribeResourceResponse object
- ResourceInfo
  - LastModified
  - ResourceArn
  - RoleArn

DescriptionString

DescriptionString string

DetailsMap

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

EntityNotFoundException

ErrorDetail

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

FieldNameString

FieldNameString string (values: RESOURCE_ARN, ROLE_ARN, LAST_MODIFIED)

FilterCondition

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

FilterConditionList

FilterConditionList array
- items FilterCondition

GetDataLakeSettingsRequest

GetDataLakeSettingsRequest object
- CatalogId

GetDataLakeSettingsResponse

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

GetEffectivePermissionsForPathRequest

GetEffectivePermissionsForPathRequest object
- CatalogId
- MaxResults
- NextToken
- ResourceArn required

GetEffectivePermissionsForPathResponse

GetEffectivePermissionsForPathResponse object
- NextToken
- Permissions
  - items PrincipalResourcePermissions

GrantPermissionsRequest

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

GrantPermissionsResponse

GrantPermissionsResponse object

IAMRoleArn

IAMRoleArn string

Identifier

Identifier string

InternalServiceException

InvalidInputException

LastModifiedTimestamp

LastModifiedTimestamp string

ListPermissionsRequest

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

ListPermissionsResponse

ListPermissionsResponse object
- NextToken
- PrincipalResourcePermissions
  - items PrincipalResourcePermissions

ListResourcesRequest

ListResourcesRequest object
- FilterConditionList
  - items FilterCondition
- MaxResults
- NextToken

ListResourcesResponse

ListResourcesResponse object
- NextToken
- ResourceInfoList
  - items ResourceInfo

NameString

NameString string

NullableBoolean

NullableBoolean boolean

OperationTimeoutException

PageSize

PageSize integer

Permission

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

PermissionList

PermissionList array
- items Permission

PrincipalPermissions

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

PrincipalPermissionsList

PrincipalPermissionsList array
- items PrincipalPermissions

PrincipalResourcePermissions

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

PrincipalResourcePermissionsList

PrincipalResourcePermissionsList array
- items PrincipalResourcePermissions

PutDataLakeSettingsRequest

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

PutDataLakeSettingsResponse

PutDataLakeSettingsResponse object

RAMResourceShareArn

RAMResourceShareArn string

RegisterResourceRequest

RegisterResourceRequest object
- ResourceArn required
- RoleArn
- UseServiceLinkedRole

RegisterResourceResponse

RegisterResourceResponse object

Resource

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

ResourceArnString

ResourceArnString string

ResourceInfo

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

ResourceInfoList

ResourceInfoList array
- items ResourceInfo

ResourceShareList

ResourceShareList array
- items RAMResourceShareArn

RevokePermissionsRequest

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

RevokePermissionsResponse

RevokePermissionsResponse object

StringValue

StringValue string

StringValueList

StringValueList array
- items StringValue

TableResource

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

TableWildcard

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

TableWithColumnsResource

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

Token

Token string

TrustedResourceOwners

TrustedResourceOwners array
- items CatalogIdString

UpdateResourceRequest

UpdateResourceRequest object
- ResourceArn required
- RoleArn required

UpdateResourceResponse

UpdateResourceResponse object

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/amazonaws_lakeformation

Installation and Usage

Description

Actions

BatchGrantPermissions

Input

Output

BatchRevokePermissions

Input

Output

DeregisterResource

Input

Output

DescribeResource

Input

Output

GetDataLakeSettings

Input

Output

GetEffectivePermissionsForPath

Input

Output

GrantPermissions

Input

Output

ListPermissions

Input

Output

ListResources

Input

Output

PutDataLakeSettings

Input

Output

RegisterResource

Input

Output

RevokePermissions

Input

Output

UpdateResource

Input

Output

Definitions

AlreadyExistsException

BatchGrantPermissionsRequest

BatchGrantPermissionsResponse

BatchPermissionsFailureEntry

BatchPermissionsFailureList

BatchPermissionsRequestEntry

BatchPermissionsRequestEntryList

BatchRevokePermissionsRequest

BatchRevokePermissionsResponse

CatalogIdString

CatalogResource

ColumnNames

ColumnWildcard

ComparisonOperator

ConcurrentModificationException

DataLakePrincipal

DataLakePrincipalList

DataLakePrincipalString

DataLakeResourceType

DataLakeSettings

DataLocationResource

DatabaseResource

DeregisterResourceRequest

DeregisterResourceResponse

DescribeResourceRequest

DescribeResourceResponse

DescriptionString

DetailsMap

EntityNotFoundException

ErrorDetail