You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.LakeFormation

Inherits:
AWS.Service show all
Identifier:
lakeformation
API Version:
2017-03-31
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Defines the public endpoint for the AWS Lake Formation service.

Sending a Request Using LakeFormation

var lakeformation = new AWS.LakeFormation();
lakeformation.addLFTagsToResource(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the LakeFormation object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lakeformation = new AWS.LakeFormation({apiVersion: '2017-03-31'});

You can also set the API version globally in AWS.config.apiVersions using the lakeformation service identifier:

AWS.config.apiVersions = {
  lakeformation: '2017-03-31',
  // other service API versions
};

var lakeformation = new AWS.LakeFormation();

Version:

  • 2017-03-31

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.LakeFormation(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a LakeFormation object

var lakeformation = new AWS.LakeFormation({apiVersion: '2017-03-31'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.LakeFormation.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.LakeFormation.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.LakeFormation.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addLFTagsToResource(params = {}, callback) ⇒ AWS.Request

Attaches one or more tags to an existing resource.

Service Reference:

Examples:

Calling the addLFTagsToResource operation

var params = {
  LFTags: [ /* required */
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    /* more items */
  ],
  Resource: { /* required */
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  CatalogId: 'STRING_VALUE'
};
lakeformation.addLFTagsToResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Resource — (map)

      The resource to which to attach a tag.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • LFTags — (Array<map>)

      The tags to attach to the resource.

      • CatalogId — (String)

        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.

      • TagKeyrequired — (String)

        The key-name for the tag.

      • TagValuesrequired — (Array<String>)

        A list of possible values an attribute can take.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Failures — (Array<map>)

        A list of failures to tag the resource.

        • LFTag — (map)

          The key-name of the tag.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • Error — (map)

          An error that occurred with the attachment or detachment of the tag.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchGrantPermissions(params = {}, callback) ⇒ AWS.Request

Batch operation to grant permissions to the principal.

Service Reference:

Examples:

Calling the batchGrantPermissions operation

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Permissions: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
        /* more items */
      ],
      PermissionsWithGrantOption: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
        /* more items */
      ],
      Principal: {
        DataLakePrincipalIdentifier: 'STRING_VALUE'
      },
      Resource: {
        Catalog: {
        },
        DataLocation: {
          ResourceArn: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE'
        },
        Database: {
          Name: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE'
        },
        LFTag: {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          CatalogId: 'STRING_VALUE'
        },
        LFTagPolicy: {
          Expression: [ /* required */
            {
              TagKey: 'STRING_VALUE', /* required */
              TagValues: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ],
          ResourceType: DATABASE | TABLE, /* required */
          CatalogId: 'STRING_VALUE'
        },
        Table: {
          DatabaseName: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE',
          Name: 'STRING_VALUE',
          TableWildcard: {
          }
        },
        TableWithColumns: {
          DatabaseName: 'STRING_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE',
          ColumnNames: [
            'STRING_VALUE',
            /* more items */
          ],
          ColumnWildcard: {
            ExcludedColumnNames: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        }
      }
    },
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
lakeformation.batchGrantPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Entries — (Array<map>)

      A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.

      • Idrequired — (String)

        A unique identifier for the batch permissions request entry.

      • Principal — (map)

        The principal to be granted a permission.

        • DataLakePrincipalIdentifier — (String)

          An identifier for the AWS Lake Formation principal.

      • Resource — (map)

        The resource to which the principal is to be granted a permission.

        • Catalog — (map)

          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.

        • Database — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • Namerequired — (String)

            The name of the database resource. Unique to the Data Catalog.

        • Table — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • DatabaseNamerequired — (String)

            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.

          • Name — (String)

            The name of the table.

          • TableWildcard — (map)

            A wildcard object representing every table under a database.

            At least one of TableResource$Name or TableResource$TableWildcard is required.

        • TableWithColumns — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • DatabaseNamerequired — (String)

            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.

          • Namerequired — (String)

            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.

          • ColumnNames — (Array<String>)

            The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

          • ColumnWildcard — (map)

            A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

            • ExcludedColumnNames — (Array<String>)

              Excludes column names. Any column with this name will be excluded.

        • DataLocation — (map)

          The location of an Amazon S3 path where permissions are granted or revoked.

          • CatalogId — (String)

            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.

          • ResourceArnrequired — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

        • LFTag — (map)

          The tag key and values attached to a resource.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagPolicy — (map)

          A list of tag conditions that define a resource's tag policy.

          • CatalogId — (String)

            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.

          • ResourceTyperequired — (String)

            The resource type for which the tag policy applies.

            Possible values include:
            • "DATABASE"
            • "TABLE"
          • Expressionrequired — (Array<map>)

            A list of tag conditions that apply to the resource's tag policy.

            • TagKeyrequired — (String)

              The key-name for the tag.

            • TagValuesrequired — (Array<String>)

              A list of possible values an attribute can take.

      • Permissions — (Array<String>)

        The permissions to be granted.

      • PermissionsWithGrantOption — (Array<String>)

        Indicates if the option to pass permissions is granted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Failures — (Array<map>)

        A list of failures to grant permissions to the resources.

        • RequestEntry — (map)

          An identifier for an entry of the batch request.

          • Idrequired — (String)

            A unique identifier for the batch permissions request entry.

          • Principal — (map)

            The principal to be granted a permission.

            • DataLakePrincipalIdentifier — (String)

              An identifier for the AWS Lake Formation principal.

          • Resource — (map)

            The resource to which the principal is to be granted a permission.

            • Catalog — (map)

              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.

            • Database — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • Namerequired — (String)

                The name of the database resource. Unique to the Data Catalog.

            • Table — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • DatabaseNamerequired — (String)

                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.

              • Name — (String)

                The name of the table.

              • TableWildcard — (map)

                A wildcard object representing every table under a database.

                At least one of TableResource$Name or TableResource$TableWildcard is required.

            • TableWithColumns — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • DatabaseNamerequired — (String)

                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.

              • Namerequired — (String)

                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.

              • ColumnNames — (Array<String>)

                The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

              • ColumnWildcard — (map)

                A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

                • ExcludedColumnNames — (Array<String>)

                  Excludes column names. Any column with this name will be excluded.

            • DataLocation — (map)

              The location of an Amazon S3 path where permissions are granted or revoked.

              • CatalogId — (String)

                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.

              • ResourceArnrequired — (String)

                The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

            • LFTag — (map)

              The tag key and values attached to a resource.

              • CatalogId — (String)

                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.

              • TagKeyrequired — (String)

                The key-name for the tag.

              • TagValuesrequired — (Array<String>)

                A list of possible values an attribute can take.

            • LFTagPolicy — (map)

              A list of tag conditions that define a resource's tag policy.

              • CatalogId — (String)

                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.

              • ResourceTyperequired — (String)

                The resource type for which the tag policy applies.

                Possible values include:
                • "DATABASE"
                • "TABLE"
              • Expressionrequired — (Array<map>)

                A list of tag conditions that apply to the resource's tag policy.

                • TagKeyrequired — (String)

                  The key-name for the tag.

                • TagValuesrequired — (Array<String>)

                  A list of possible values an attribute can take.

          • Permissions — (Array<String>)

            The permissions to be granted.

          • PermissionsWithGrantOption — (Array<String>)

            Indicates if the option to pass permissions is granted.

        • Error — (map)

          An error message that applies to the failure of the entry.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchRevokePermissions(params = {}, callback) ⇒ AWS.Request

Batch operation to revoke permissions from the principal.

Service Reference:

Examples:

Calling the batchRevokePermissions operation

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Permissions: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
        /* more items */
      ],
      PermissionsWithGrantOption: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
        /* more items */
      ],
      Principal: {
        DataLakePrincipalIdentifier: 'STRING_VALUE'
      },
      Resource: {
        Catalog: {
        },
        DataLocation: {
          ResourceArn: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE'
        },
        Database: {
          Name: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE'
        },
        LFTag: {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          CatalogId: 'STRING_VALUE'
        },
        LFTagPolicy: {
          Expression: [ /* required */
            {
              TagKey: 'STRING_VALUE', /* required */
              TagValues: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ],
          ResourceType: DATABASE | TABLE, /* required */
          CatalogId: 'STRING_VALUE'
        },
        Table: {
          DatabaseName: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE',
          Name: 'STRING_VALUE',
          TableWildcard: {
          }
        },
        TableWithColumns: {
          DatabaseName: 'STRING_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          CatalogId: 'STRING_VALUE',
          ColumnNames: [
            'STRING_VALUE',
            /* more items */
          ],
          ColumnWildcard: {
            ExcludedColumnNames: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        }
      }
    },
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
lakeformation.batchRevokePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Entries — (Array<map>)

      A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.

      • Idrequired — (String)

        A unique identifier for the batch permissions request entry.

      • Principal — (map)

        The principal to be granted a permission.

        • DataLakePrincipalIdentifier — (String)

          An identifier for the AWS Lake Formation principal.

      • Resource — (map)

        The resource to which the principal is to be granted a permission.

        • Catalog — (map)

          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.

        • Database — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • Namerequired — (String)

            The name of the database resource. Unique to the Data Catalog.

        • Table — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • DatabaseNamerequired — (String)

            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.

          • Name — (String)

            The name of the table.

          • TableWildcard — (map)

            A wildcard object representing every table under a database.

            At least one of TableResource$Name or TableResource$TableWildcard is required.

        • TableWithColumns — (map)

          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.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • DatabaseNamerequired — (String)

            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.

          • Namerequired — (String)

            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.

          • ColumnNames — (Array<String>)

            The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

          • ColumnWildcard — (map)

            A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

            • ExcludedColumnNames — (Array<String>)

              Excludes column names. Any column with this name will be excluded.

        • DataLocation — (map)

          The location of an Amazon S3 path where permissions are granted or revoked.

          • CatalogId — (String)

            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.

          • ResourceArnrequired — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

        • LFTag — (map)

          The tag key and values attached to a resource.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagPolicy — (map)

          A list of tag conditions that define a resource's tag policy.

          • CatalogId — (String)

            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.

          • ResourceTyperequired — (String)

            The resource type for which the tag policy applies.

            Possible values include:
            • "DATABASE"
            • "TABLE"
          • Expressionrequired — (Array<map>)

            A list of tag conditions that apply to the resource's tag policy.

            • TagKeyrequired — (String)

              The key-name for the tag.

            • TagValuesrequired — (Array<String>)

              A list of possible values an attribute can take.

      • Permissions — (Array<String>)

        The permissions to be granted.

      • PermissionsWithGrantOption — (Array<String>)

        Indicates if the option to pass permissions is granted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Failures — (Array<map>)

        A list of failures to revoke permissions to the resources.

        • RequestEntry — (map)

          An identifier for an entry of the batch request.

          • Idrequired — (String)

            A unique identifier for the batch permissions request entry.

          • Principal — (map)

            The principal to be granted a permission.

            • DataLakePrincipalIdentifier — (String)

              An identifier for the AWS Lake Formation principal.

          • Resource — (map)

            The resource to which the principal is to be granted a permission.

            • Catalog — (map)

              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.

            • Database — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • Namerequired — (String)

                The name of the database resource. Unique to the Data Catalog.

            • Table — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • DatabaseNamerequired — (String)

                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.

              • Name — (String)

                The name of the table.

              • TableWildcard — (map)

                A wildcard object representing every table under a database.

                At least one of TableResource$Name or TableResource$TableWildcard is required.

            • TableWithColumns — (map)

              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.

              • CatalogId — (String)

                The identifier for the Data Catalog. By default, it is the account ID of the caller.

              • DatabaseNamerequired — (String)

                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.

              • Namerequired — (String)

                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.

              • ColumnNames — (Array<String>)

                The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

              • ColumnWildcard — (map)

                A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

                • ExcludedColumnNames — (Array<String>)

                  Excludes column names. Any column with this name will be excluded.

            • DataLocation — (map)

              The location of an Amazon S3 path where permissions are granted or revoked.

              • CatalogId — (String)

                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.

              • ResourceArnrequired — (String)

                The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

            • LFTag — (map)

              The tag key and values attached to a resource.

              • CatalogId — (String)

                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.

              • TagKeyrequired — (String)

                The key-name for the tag.

              • TagValuesrequired — (Array<String>)

                A list of possible values an attribute can take.

            • LFTagPolicy — (map)

              A list of tag conditions that define a resource's tag policy.

              • CatalogId — (String)

                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.

              • ResourceTyperequired — (String)

                The resource type for which the tag policy applies.

                Possible values include:
                • "DATABASE"
                • "TABLE"
              • Expressionrequired — (Array<map>)

                A list of tag conditions that apply to the resource's tag policy.

                • TagKeyrequired — (String)

                  The key-name for the tag.

                • TagValuesrequired — (Array<String>)

                  A list of possible values an attribute can take.

          • Permissions — (Array<String>)

            The permissions to be granted.

          • PermissionsWithGrantOption — (Array<String>)

            Indicates if the option to pass permissions is granted.

        • Error — (map)

          An error message that applies to the failure of the entry.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLFTag(params = {}, callback) ⇒ AWS.Request

Creates a tag with the specified name and values.

Service Reference:

Examples:

Calling the createLFTag operation

var params = {
  TagKey: 'STRING_VALUE', /* required */
  TagValues: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
lakeformation.createLFTag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • TagKey — (String)

      The key-name for the tag.

    • TagValues — (Array<String>)

      A list of possible values an attribute can take.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLFTag(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the deleteLFTag operation

var params = {
  TagKey: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
lakeformation.deleteLFTag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • TagKey — (String)

      The key-name for the tag to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterResource(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the deregisterResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lakeformation.deregisterResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that you want to deregister.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeResource(params = {}, callback) ⇒ AWS.Request

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

Service Reference:

Examples:

Calling the describeResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
lakeformation.describeResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The resource ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceInfo — (map)

        A structure containing information about an AWS Lake Formation resource.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • RoleArn — (String)

          The IAM role that registered a resource.

        • LastModified — (Date)

          The date and time the resource was last modified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataLakeSettings(params = {}, callback) ⇒ AWS.Request

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Service Reference:

Examples:

Calling the getDataLakeSettings operation

var params = {
  CatalogId: 'STRING_VALUE'
};
lakeformation.getDataLakeSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataLakeSettings — (map)

        A structure representing a list of AWS Lake Formation principals designated as data lake administrators.

        • DataLakeAdmins — (Array<map>)

          A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the AWS Lake Formation principal.

        • CreateDatabaseDefaultPermissions — (Array<map>)

          A structure representing a list of up to three principal permissions entries for default create database permissions.

          • Principal — (map)

            The principal who is granted permissions.

            • DataLakePrincipalIdentifier — (String)

              An identifier for the AWS Lake Formation principal.

          • Permissions — (Array<String>)

            The permissions that are granted to the principal.

        • CreateTableDefaultPermissions — (Array<map>)

          A structure representing a list of up to three principal permissions entries for default create table permissions.

          • Principal — (map)

            The principal who is granted permissions.

            • DataLakePrincipalIdentifier — (String)

              An identifier for the AWS Lake Formation principal.

          • Permissions — (Array<String>)

            The permissions that are granted to the principal.

        • TrustedResourceOwners — (Array<String>)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEffectivePermissionsForPath(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the getEffectivePermissionsForPath operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lakeformation.getEffectivePermissionsForPath(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve this list.

    • MaxResults — (Integer)

      The maximum number of results to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Permissions — (Array<map>)

        A list of the permissions for the specified table or database resource located at the path in Amazon S3.

        • Principal — (map)

          The Data Lake principal to be granted or revoked permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the AWS Lake Formation principal.

        • Resource — (map)

          The resource where permissions are to be granted or revoked.

          • Catalog — (map)

            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.

          • Database — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • Namerequired — (String)

              The name of the database resource. Unique to the Data Catalog.

          • Table — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • DatabaseNamerequired — (String)

              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.

            • Name — (String)

              The name of the table.

            • TableWildcard — (map)

              A wildcard object representing every table under a database.

              At least one of TableResource$Name or TableResource$TableWildcard is required.

          • TableWithColumns — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • DatabaseNamerequired — (String)

              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.

            • Namerequired — (String)

              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.

            • ColumnNames — (Array<String>)

              The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

            • ColumnWildcard — (map)

              A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

              • ExcludedColumnNames — (Array<String>)

                Excludes column names. Any column with this name will be excluded.

          • DataLocation — (map)

            The location of an Amazon S3 path where permissions are granted or revoked.

            • CatalogId — (String)

              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.

            • ResourceArnrequired — (String)

              The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

          • LFTag — (map)

            The tag key and values attached to a resource.

            • CatalogId — (String)

              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.

            • TagKeyrequired — (String)

              The key-name for the tag.

            • TagValuesrequired — (Array<String>)

              A list of possible values an attribute can take.

          • LFTagPolicy — (map)

            A list of tag conditions that define a resource's tag policy.

            • CatalogId — (String)

              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.

            • ResourceTyperequired — (String)

              The resource type for which the tag policy applies.

              Possible values include:
              • "DATABASE"
              • "TABLE"
            • Expressionrequired — (Array<map>)

              A list of tag conditions that apply to the resource's tag policy.

              • TagKeyrequired — (String)

                The key-name for the tag.

              • TagValuesrequired — (Array<String>)

                A list of possible values an attribute can take.

        • Permissions — (Array<String>)

          The permissions to be granted or revoked on the resource.

        • PermissionsWithGrantOption — (Array<String>)

          Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

        • AdditionalDetails — (map)

          This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM resource share ARN.

          • ResourceShare — (Array<String>)

            A resource share ARN for a catalog resource shared through AWS Resource Access Manager (AWS RAM).

      • NextToken — (String)

        A continuation token, if this is not the first call to retrieve this list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLFTag(params = {}, callback) ⇒ AWS.Request

Returns a tag definition.

Service Reference:

Examples:

Calling the getLFTag operation

var params = {
  TagKey: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
lakeformation.getLFTag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • TagKey — (String)

      The key-name for the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CatalogId — (String)

        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.

      • TagKey — (String)

        The key-name for the tag.

      • TagValues — (Array<String>)

        A list of possible values an attribute can take.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourceLFTags(params = {}, callback) ⇒ AWS.Request

Returns the tags applied to a resource.

Service Reference:

Examples:

Calling the getResourceLFTags operation

var params = {
  Resource: { /* required */
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  CatalogId: 'STRING_VALUE',
  ShowAssignedLFTags: true || false
};
lakeformation.getResourceLFTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Resource — (map)

      The resource for which you want to return tags.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • ShowAssignedLFTags — (Boolean)

      Indicates whether to show the assigned tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LFTagOnDatabase — (Array<map>)

        A list of tags applied to a database resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagsOnTable — (Array<map>)

        A list of tags applied to a table resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagsOnColumns — (Array<map>)

        A list of tags applied to a column resource.

        • Name — (String)

          The name of a column resource.

        • LFTags — (Array<map>)

          The tags attached to a column resource.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

grantPermissions(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the grantPermissions operation

var params = {
  Permissions: [ /* required */
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
    /* more items */
  ],
  Principal: { /* required */
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: { /* required */
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  CatalogId: 'STRING_VALUE',
  PermissionsWithGrantOption: [
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
    /* more items */
  ]
};
lakeformation.grantPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Principal — (map)

      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.

      • DataLakePrincipalIdentifier — (String)

        An identifier for the AWS Lake Formation principal.

    • Resource — (map)

      The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • Permissions — (Array<String>)

      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.

    • PermissionsWithGrantOption — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLFTags(params = {}, callback) ⇒ AWS.Request

Lists tags that the requester has permission to view.

Service Reference:

Examples:

Calling the listLFTags operation

var params = {
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceShareType: FOREIGN | ALL
};
lakeformation.listLFTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • ResourceShareType — (String)

      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.

      Possible values include:
      • "FOREIGN"
      • "ALL"
    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve this list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LFTags — (Array<map>)

        A list of tags that the requested has permission to view.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • NextToken — (String)

        A continuation token, present if the current list segment is not the last.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPermissions(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the listPermissions operation

var params = {
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Principal: {
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: {
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  ResourceType: CATALOG | DATABASE | TABLE | DATA_LOCATION | LF_TAG | LF_TAG_POLICY | LF_TAG_POLICY_DATABASE | LF_TAG_POLICY_TABLE
};
lakeformation.listPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Principal — (map)

      Specifies a principal to filter the permissions returned.

      • DataLakePrincipalIdentifier — (String)

        An identifier for the AWS Lake Formation principal.

    • ResourceType — (String)

      Specifies a resource type to filter the permissions returned.

      Possible values include:
      • "CATALOG"
      • "DATABASE"
      • "TABLE"
      • "DATA_LOCATION"
      • "LF_TAG"
      • "LF_TAG_POLICY"
      • "LF_TAG_POLICY_DATABASE"
      • "LF_TAG_POLICY_TABLE"
    • Resource — (map)

      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.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve this list.

    • MaxResults — (Integer)

      The maximum number of results to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PrincipalResourcePermissions — (Array<map>)

        A list of principals and their permissions on the resource for the specified principal and resource types.

        • Principal — (map)

          The Data Lake principal to be granted or revoked permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the AWS Lake Formation principal.

        • Resource — (map)

          The resource where permissions are to be granted or revoked.

          • Catalog — (map)

            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.

          • Database — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • Namerequired — (String)

              The name of the database resource. Unique to the Data Catalog.

          • Table — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • DatabaseNamerequired — (String)

              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.

            • Name — (String)

              The name of the table.

            • TableWildcard — (map)

              A wildcard object representing every table under a database.

              At least one of TableResource$Name or TableResource$TableWildcard is required.

          • TableWithColumns — (map)

            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.

            • CatalogId — (String)

              The identifier for the Data Catalog. By default, it is the account ID of the caller.

            • DatabaseNamerequired — (String)

              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.

            • Namerequired — (String)

              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.

            • ColumnNames — (Array<String>)

              The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

            • ColumnWildcard — (map)

              A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

              • ExcludedColumnNames — (Array<String>)

                Excludes column names. Any column with this name will be excluded.

          • DataLocation — (map)

            The location of an Amazon S3 path where permissions are granted or revoked.

            • CatalogId — (String)

              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.

            • ResourceArnrequired — (String)

              The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

          • LFTag — (map)

            The tag key and values attached to a resource.

            • CatalogId — (String)

              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.

            • TagKeyrequired — (String)

              The key-name for the tag.

            • TagValuesrequired — (Array<String>)

              A list of possible values an attribute can take.

          • LFTagPolicy — (map)

            A list of tag conditions that define a resource's tag policy.

            • CatalogId — (String)

              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.

            • ResourceTyperequired — (String)

              The resource type for which the tag policy applies.

              Possible values include:
              • "DATABASE"
              • "TABLE"
            • Expressionrequired — (Array<map>)

              A list of tag conditions that apply to the resource's tag policy.

              • TagKeyrequired — (String)

                The key-name for the tag.

              • TagValuesrequired — (Array<String>)

                A list of possible values an attribute can take.

        • Permissions — (Array<String>)

          The permissions to be granted or revoked on the resource.

        • PermissionsWithGrantOption — (Array<String>)

          Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

        • AdditionalDetails — (map)

          This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM resource share ARN.

          • ResourceShare — (Array<String>)

            A resource share ARN for a catalog resource shared through AWS Resource Access Manager (AWS RAM).

      • NextToken — (String)

        A continuation token, if this is not the first call to retrieve this list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResources(params = {}, callback) ⇒ AWS.Request

Lists the resources registered to be managed by the Data Catalog.

Service Reference:

Examples:

Calling the listResources operation

var params = {
  FilterConditionList: [
    {
      ComparisonOperator: EQ | NE | LE | LT | GE | GT | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN,
      Field: RESOURCE_ARN | ROLE_ARN | LAST_MODIFIED,
      StringValueList: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lakeformation.listResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FilterConditionList — (Array<map>)

      Any applicable row-level and/or column-level filtering conditions for the resources.

      • Field — (String)

        The field to filter in the filter condition.

        Possible values include:
        • "RESOURCE_ARN"
        • "ROLE_ARN"
        • "LAST_MODIFIED"
      • ComparisonOperator — (String)

        The comparison operator used in the filter condition.

        Possible values include:
        • "EQ"
        • "NE"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
        • "IN"
        • "BETWEEN"
      • StringValueList — (Array<String>)

        A string with values used in evaluating the filter condition.

    • MaxResults — (Integer)

      The maximum number of resource results.

    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve these resources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceInfoList — (Array<map>)

        A summary of the data lake resources.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • RoleArn — (String)

          The IAM role that registered a resource.

        • LastModified — (Date)

          The date and time the resource was last modified.

      • NextToken — (String)

        A continuation token, if this is not the first call to retrieve these resources.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putDataLakeSettings(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the putDataLakeSettings operation

var params = {
  DataLakeSettings: { /* required */
    CreateDatabaseDefaultPermissions: [
      {
        Permissions: [
          ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
          /* more items */
        ],
        Principal: {
          DataLakePrincipalIdentifier: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    CreateTableDefaultPermissions: [
      {
        Permissions: [
          ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
          /* more items */
        ],
        Principal: {
          DataLakePrincipalIdentifier: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    DataLakeAdmins: [
      {
        DataLakePrincipalIdentifier: 'STRING_VALUE'
      },
      /* more items */
    ],
    TrustedResourceOwners: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CatalogId: 'STRING_VALUE'
};
lakeformation.putDataLakeSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • DataLakeSettings — (map)

      A structure representing a list of AWS Lake Formation principals designated as data lake administrators.

      • DataLakeAdmins — (Array<map>)

        A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

        • DataLakePrincipalIdentifier — (String)

          An identifier for the AWS Lake Formation principal.

      • CreateDatabaseDefaultPermissions — (Array<map>)

        A structure representing a list of up to three principal permissions entries for default create database permissions.

        • Principal — (map)

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the AWS Lake Formation principal.

        • Permissions — (Array<String>)

          The permissions that are granted to the principal.

      • CreateTableDefaultPermissions — (Array<map>)

        A structure representing a list of up to three principal permissions entries for default create table permissions.

        • Principal — (map)

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the AWS Lake Formation principal.

        • Permissions — (Array<String>)

          The permissions that are granted to the principal.

      • TrustedResourceOwners — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerResource(params = {}, callback) ⇒ AWS.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

Service Reference:

Examples:

Calling the registerResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE',
  UseServiceLinkedRole: true || false
};
lakeformation.registerResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that you want to register.

    • UseServiceLinkedRole — (Boolean)

      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.

    • RoleArn — (String)

      The identifier for the role that registers the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeLFTagsFromResource(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the removeLFTagsFromResource operation

var params = {
  LFTags: [ /* required */
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    /* more items */
  ],
  Resource: { /* required */
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  CatalogId: 'STRING_VALUE'
};
lakeformation.removeLFTagsFromResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Resource — (map)

      The resource where you want to remove a tag.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • LFTags — (Array<map>)

      The tags to be removed from the resource.

      • CatalogId — (String)

        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.

      • TagKeyrequired — (String)

        The key-name for the tag.

      • TagValuesrequired — (Array<String>)

        A list of possible values an attribute can take.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Failures — (Array<map>)

        A list of failures to untag a resource.

        • LFTag — (map)

          The key-name of the tag.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • Error — (map)

          An error that occurred with the attachment or detachment of the tag.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

revokePermissions(params = {}, callback) ⇒ AWS.Request

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Service Reference:

Examples:

Calling the revokePermissions operation

var params = {
  Permissions: [ /* required */
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
    /* more items */
  ],
  Principal: { /* required */
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: { /* required */
    Catalog: {
    },
    DataLocation: {
      ResourceArn: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    Database: {
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE'
    },
    LFTag: {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      CatalogId: 'STRING_VALUE'
    },
    LFTagPolicy: {
      Expression: [ /* required */
        {
          TagKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: DATABASE | TABLE, /* required */
      CatalogId: 'STRING_VALUE'
    },
    Table: {
      DatabaseName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableWildcard: {
      }
    },
    TableWithColumns: {
      DatabaseName: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ColumnWildcard: {
        ExcludedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  CatalogId: 'STRING_VALUE',
  PermissionsWithGrantOption: [
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_TAG | ALTER_TAG | DELETE_TAG | DESCRIBE_TAG | ASSOCIATE_TAG,
    /* more items */
  ]
};
lakeformation.revokePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • Principal — (map)

      The principal to be revoked permissions on the resource.

      • DataLakePrincipalIdentifier — (String)

        An identifier for the AWS Lake Formation principal.

    • Resource — (map)

      The resource to which permissions are to be revoked.

      • Catalog — (map)

        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.

      • Database — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • Namerequired — (String)

          The name of the database resource. Unique to the Data Catalog.

      • Table — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Name — (String)

          The name of the table.

        • TableWildcard — (map)

          A wildcard object representing every table under a database.

          At least one of TableResource$Name or TableResource$TableWildcard is required.

      • TableWithColumns — (map)

        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.

        • CatalogId — (String)

          The identifier for the Data Catalog. By default, it is the account ID of the caller.

        • DatabaseNamerequired — (String)

          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.

        • Namerequired — (String)

          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.

        • ColumnNames — (Array<String>)

          The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

        • ColumnWildcard — (map)

          A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

          • ExcludedColumnNames — (Array<String>)

            Excludes column names. Any column with this name will be excluded.

      • DataLocation — (map)

        The location of an Amazon S3 path where permissions are granted or revoked.

        • CatalogId — (String)

          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.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

      • LFTag — (map)

        The tag key and values attached to a resource.

        • CatalogId — (String)

          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.

        • TagKeyrequired — (String)

          The key-name for the tag.

        • TagValuesrequired — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of tag conditions that define a resource's tag policy.

        • CatalogId — (String)

          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.

        • ResourceTyperequired — (String)

          The resource type for which the tag policy applies.

          Possible values include:
          • "DATABASE"
          • "TABLE"
        • Expressionrequired — (Array<map>)

          A list of tag conditions that apply to the resource's tag policy.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

    • Permissions — (Array<String>)

      The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.

    • PermissionsWithGrantOption — (Array<String>)

      Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchDatabasesByLFTags(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the searchDatabasesByLFTags operation

var params = {
  Expression: [ /* required */
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lakeformation.searchDatabasesByLFTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve this list.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • CatalogId — (String)

      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.

    • Expression — (Array<map>)

      A list of conditions (LFTag structures) to search for in database resources.

      • TagKeyrequired — (String)

        The key-name for the tag.

      • TagValuesrequired — (Array<String>)

        A list of possible values an attribute can take.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        A continuation token, present if the current list segment is not the last.

      • DatabaseList — (Array<map>)

        A list of databases that meet the tag conditions.

        • Database — (map)

          A database that has tags attached to it.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • Namerequired — (String)

            The name of the database resource. Unique to the Data Catalog.

        • LFTags — (Array<map>)

          A list of tags attached to the database.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchTablesByLFTags(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the searchTablesByLFTags operation

var params = {
  Expression: [ /* required */
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValues: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
lakeformation.searchTablesByLFTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve this list.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • CatalogId — (String)

      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.

    • Expression — (Array<map>)

      A list of conditions (LFTag structures) to search for in table resources.

      • TagKeyrequired — (String)

        The key-name for the tag.

      • TagValuesrequired — (Array<String>)

        A list of possible values an attribute can take.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        A continuation token, present if the current list segment is not the last.

      • TableList — (Array<map>)

        A list of tables that meet the tag conditions.

        • Table — (map)

          A table that has tags attached to it.

          • CatalogId — (String)

            The identifier for the Data Catalog. By default, it is the account ID of the caller.

          • DatabaseNamerequired — (String)

            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.

          • Name — (String)

            The name of the table.

          • TableWildcard — (map)

            A wildcard object representing every table under a database.

            At least one of TableResource$Name or TableResource$TableWildcard is required.

        • LFTagOnDatabase — (Array<map>)

          A list of tags attached to the database where the table resides.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagsOnTable — (Array<map>)

          A list of tags attached to the table.

          • CatalogId — (String)

            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.

          • TagKeyrequired — (String)

            The key-name for the tag.

          • TagValuesrequired — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagsOnColumns — (Array<map>)

          A list of tags attached to columns in the table.

          • Name — (String)

            The name of a column resource.

          • LFTags — (Array<map>)

            The tags attached to a column resource.

            • CatalogId — (String)

              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.

            • TagKeyrequired — (String)

              The key-name for the tag.

            • TagValuesrequired — (Array<String>)

              A list of possible values an attribute can take.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLFTag(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the updateLFTag operation

var params = {
  TagKey: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  TagValuesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValuesToDelete: [
    'STRING_VALUE',
    /* more items */
  ]
};
lakeformation.updateLFTag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CatalogId — (String)

      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.

    • TagKey — (String)

      The key-name for the tag for which to add or delete values.

    • TagValuesToDelete — (Array<String>)

      A list of tag values to delete from the tag.

    • TagValuesToAdd — (Array<String>)

      A list of tag values to add from the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateResource(params = {}, callback) ⇒ AWS.Request

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

Service Reference:

Examples:

Calling the updateResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE' /* required */
};
lakeformation.updateResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoleArn — (String)

      The new role to use for the given resource registered in AWS Lake Formation.

    • ResourceArn — (String)

      The resource ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.