Class: AWS.LakeFormation

var params = {
  PrincipalArn: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  SAMLAssertion: 'STRING_VALUE', /* required */
  DurationSeconds: 'NUMBER_VALUE'
};
lakeformation.assumeDecoratedRoleWithSAML(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: {}) —
  • SAMLAssertion — (String)

    A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded.

  • RoleArn — (String)

    The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as GetTemporaryTableCredentials. The caller must also have iam:PassRole permission on this role.

  • PrincipalArn — (String)

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

  • DurationSeconds — (Integer)

    The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.

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:

    • AccessKeyId — (String)

      The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key).

    • SecretAccessKey — (String)

      The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key).

    • SessionToken — (String)

      The session token for the temporary credentials.

    • Expiration — (Date)

      The date and time when the temporary credentials expire.

Returns:

• (AWS.Request) —

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

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Permissions: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
        /* more items */
      ],
      PermissionsWithGrantOption: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
        /* more items */
      ],
      Principal: {
        DataLakePrincipalIdentifier: 'STRING_VALUE'
      },
      Resource: {
        Catalog: {
        },
        DataCellsFilter: {
          DatabaseName: 'STRING_VALUE',
          Name: 'STRING_VALUE',
          TableCatalogId: 'STRING_VALUE',
          TableName: 'STRING_VALUE'
        },
        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 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.

    • Id — required — (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 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 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.

        • Name — required — (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.

        • DatabaseName — required — (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.

        • DatabaseName — required — (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.

        • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

        • ResourceArn — required — (String)

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

      • DataCellsFilter — (map)

        A data cell filter.

        • TableCatalogId — (String)

          The ID of the catalog to which the table belongs.

        • DatabaseName — (String)

          A database in the Glue Data Catalog.

        • TableName — (String)

          The name of the table.

        • Name — (String)

          The name of the data cells filter.

      • LFTag — (map)

        The LF-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 Lake Formation environment.

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

        • ResourceType — required — (String)

          The resource type for which the LF-tag policy applies.

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

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

          • TagKey — required — (String)

            The key-name for the LF-tag.

          • TagValues — required — (Array<String>)

            A list of possible values an attribute can take.

            The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

    • 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.

        • Id — required — (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 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 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.

            • Name — required — (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.

            • DatabaseName — required — (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.

            • DatabaseName — required — (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.

            • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

            • ResourceArn — required — (String)

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

          • DataCellsFilter — (map)

            A data cell filter.

            • TableCatalogId — (String)

              The ID of the catalog to which the table belongs.

            • DatabaseName — (String)

              A database in the Glue Data Catalog.

            • TableName — (String)

              The name of the table.

            • Name — (String)

              The name of the data cells filter.

          • LFTag — (map)

            The LF-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 Lake Formation environment.

            • TagKey — required — (String)

              The key-name for the LF-tag.

            • TagValues — required — (Array<String>)

              A list of possible values an attribute can take.

          • LFTagPolicy — (map)

            A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

            • ResourceType — required — (String)

              The resource type for which the LF-tag policy applies.

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

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

              • TagKey — required — (String)

                The key-name for the LF-tag.

              • TagValues — required — (Array<String>)

                A list of possible values an attribute can take.

                The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

        • 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.

var params = {
  Entries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Permissions: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
        /* more items */
      ],
      PermissionsWithGrantOption: [
        ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
        /* more items */
      ],
      Principal: {
        DataLakePrincipalIdentifier: 'STRING_VALUE'
      },
      Resource: {
        Catalog: {
        },
        DataCellsFilter: {
          DatabaseName: 'STRING_VALUE',
          Name: 'STRING_VALUE',
          TableCatalogId: 'STRING_VALUE',
          TableName: 'STRING_VALUE'
        },
        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 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.

    • Id — required — (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 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 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.

        • Name — required — (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.

        • DatabaseName — required — (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.

        • DatabaseName — required — (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.

        • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

        • ResourceArn — required — (String)

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

      • DataCellsFilter — (map)

        A data cell filter.

        • TableCatalogId — (String)

          The ID of the catalog to which the table belongs.

        • DatabaseName — (String)

          A database in the Glue Data Catalog.

        • TableName — (String)

          The name of the table.

        • Name — (String)

          The name of the data cells filter.

      • LFTag — (map)

        The LF-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 Lake Formation environment.

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

      • LFTagPolicy — (map)

        A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

        • ResourceType — required — (String)

          The resource type for which the LF-tag policy applies.

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

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

          • TagKey — required — (String)

            The key-name for the LF-tag.

          • TagValues — required — (Array<String>)

            A list of possible values an attribute can take.

            The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

    • 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.

        • Id — required — (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 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 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.

            • Name — required — (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.

            • DatabaseName — required — (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.

            • DatabaseName — required — (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.

            • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

            • ResourceArn — required — (String)

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

          • DataCellsFilter — (map)

            A data cell filter.

            • TableCatalogId — (String)

              The ID of the catalog to which the table belongs.

            • DatabaseName — (String)

              A database in the Glue Data Catalog.

            • TableName — (String)

              The name of the table.

            • Name — (String)

              The name of the data cells filter.

          • LFTag — (map)

            The LF-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 Lake Formation environment.

            • TagKey — required — (String)

              The key-name for the LF-tag.

            • TagValues — required — (Array<String>)

              A list of possible values an attribute can take.

          • LFTagPolicy — (map)

            A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

            • ResourceType — required — (String)

              The resource type for which the LF-tag policy applies.

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

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

              • TagKey — required — (String)

                The key-name for the LF-tag.

              • TagValues — required — (Array<String>)

                A list of possible values an attribute can take.

                The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

        • 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.

var params = {
  TransactionId: 'STRING_VALUE' /* required */
};
lakeformation.cancelTransaction(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: {}) —
  • TransactionId — (String)

    The transaction to cancel.

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.

var params = {
  TransactionId: 'STRING_VALUE' /* required */
};
lakeformation.commitTransaction(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: {}) —
  • TransactionId — (String)

    The transaction to commit.

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:

    • TransactionStatus — (String)

      The status of the transaction.

      Possible values include:
      • "ACTIVE"
      • "COMMITTED"
      • "ABORTED"
      • "COMMIT_IN_PROGRESS"

Returns:

• (AWS.Request) —

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

var params = {
  TableData: { /* required */
    DatabaseName: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    TableCatalogId: 'STRING_VALUE', /* required */
    TableName: 'STRING_VALUE', /* required */
    ColumnNames: [
      'STRING_VALUE',
      /* more items */
    ],
    ColumnWildcard: {
      ExcludedColumnNames: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    RowFilter: {
      AllRowsWildcard: {
      },
      FilterExpression: 'STRING_VALUE'
    },
    VersionId: 'STRING_VALUE'
  }
};
lakeformation.createDataCellsFilter(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: {}) —
  • TableData — (map)

    A DataCellsFilter structure containing information about the data cells filter.

    • TableCatalogId — required — (String)

      The ID of the catalog to which the table belongs.

    • DatabaseName — required — (String)

      A database in the Glue Data Catalog.

    • TableName — required — (String)

      A table in the database.

    • Name — required — (String)

      The name given by the user to the data filter cell.

    • RowFilter — (map)

      A PartiQL predicate.

      • FilterExpression — (String)

        A filter expression.

      • AllRowsWildcard — (map)

        A wildcard for all rows.

    • ColumnNames — (Array<String>)

      A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.

    • ColumnWildcard — (map)

      A wildcard with exclusions.

      You must specify either a ColumnNames list or the ColumnWildCard.

      • ExcludedColumnNames — (Array<String>)

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

    • VersionId — (String)

      The ID of the data cells filter version.

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.

var params = {
  CatalogId: 'STRING_VALUE',
  ExternalFiltering: {
    AuthorizedTargets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Status: ENABLED | DISABLED /* required */
  },
  InstanceArn: 'STRING_VALUE',
  ShareRecipients: [
    {
      DataLakePrincipalIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ]
};
lakeformation.createLakeFormationIdentityCenterConfiguration(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, view definitions, and other control information to manage your Lake Formation environment.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • ExternalFiltering — (map)

    A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation.

    • Status — required — (String)

      Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • AuthorizedTargets — required — (Array<String>)

      List of third-party application ARNs integrated with Lake Formation.

  • ShareRecipients — (Array<map>)

    A list of Amazon Web Services account IDs and/or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation.

    If the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources.

    If the ShareRecipients value is null or the list is empty, no resource share is created.

    • DataLakePrincipalIdentifier — (String)

      An identifier for the Lake Formation principal.

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:

    • ApplicationArn — (String)

      The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.

Returns:

• (AWS.Request) —

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

var params = {
  Principal: { /* required */
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: { /* required */
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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 */
        ]
      }
    }
  }
};
lakeformation.createLakeFormationOptIn(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: {}) —
  • Principal — (map)

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    • DataLakePrincipalIdentifier — (String)

      An identifier for the Lake Formation principal.

  • Resource — (map)

    A structure for the resource.

    • 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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

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.

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 Lake Formation environment.

  • TagKey — (String)

    The key-name for the LF-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.

var params = {
  DatabaseName: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  TableCatalogId: 'STRING_VALUE',
  TableName: 'STRING_VALUE'
};
lakeformation.deleteDataCellsFilter(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: {}) —
  • TableCatalogId — (String)

    The ID of the catalog to which the table belongs.

  • DatabaseName — (String)

    A database in the Glue Data Catalog.

  • TableName — (String)

    A table in the database.

  • Name — (String)

    The name given by the user to the data filter cell.

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.

var params = {
  CatalogId: 'STRING_VALUE'
};
lakeformation.deleteLakeFormationIdentityCenterConfiguration(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, view definition, and other control information to manage your 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.

Returns:

• (AWS.Request) —

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

var params = {
  Principal: { /* required */
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: { /* required */
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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 */
        ]
      }
    }
  }
};
lakeformation.deleteLakeFormationOptIn(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: {}) —
  • Principal — (map)

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    • DataLakePrincipalIdentifier — (String)

      An identifier for the Lake Formation principal.

  • Resource — (map)

    A structure for the resource.

    • 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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

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.

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 Lake Formation environment.

  • TagKey — (String)

    The key-name for the LF-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.

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Objects: [ /* required */
    {
      Uri: 'STRING_VALUE', /* required */
      ETag: 'STRING_VALUE'
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  TransactionId: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
lakeformation.deleteObjectsOnCancel(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 Glue data catalog that contains the governed table. Defaults to the current account ID.

  • DatabaseName — (String)

    The database that contains the governed table.

  • TableName — (String)

    The name of the governed table.

  • TransactionId — (String)

    ID of the transaction that the writes occur in.

  • Objects — (Array<map>)

    A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.

    • Uri — required — (String)

      The path to the Amazon S3 object. Must start with s3://

    • ETag — (String)

      The ETag of the Amazon S3 object.

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.

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.

var params = {
  CatalogId: 'STRING_VALUE'
};
lakeformation.describeLakeFormationIdentityCenterConfiguration(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 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:

    • 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 Lake Formation environment.

    • InstanceArn — (String)

      The Amazon Resource Name (ARN) of the connection.

    • ApplicationArn — (String)

      The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.

    • ExternalFiltering — (map)

      Indicates if external filtering is enabled.

      • Status — required — (String)

        Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • AuthorizedTargets — required — (Array<String>)

        List of third-party application ARNs integrated with Lake Formation.

    • ShareRecipients — (Array<map>)

      A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation.

      If the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources as the ShareRecipients.

      If the ShareRecipients value is null or the list is empty, no resource share is created.

      • DataLakePrincipalIdentifier — (String)

        An identifier for the Lake Formation principal.

    • ResourceShare — (String)

      The Amazon Resource Name (ARN) of the RAM share.

Returns:

• (AWS.Request) —

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

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 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.

      • WithFederation — (Boolean)

        Whether or not the resource is a federated resource.

      • HybridAccessEnabled — (Boolean)

        Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

Returns:

• (AWS.Request) —

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

var params = {
  TransactionId: 'STRING_VALUE' /* required */
};
lakeformation.describeTransaction(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: {}) —
  • TransactionId — (String)

    The transaction for which to return status.

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:

    • TransactionDescription — (map)

      Returns a TransactionDescription object containing information about the transaction.

      • TransactionId — (String)

        The ID of the transaction.

      • TransactionStatus — (String)

        A status of ACTIVE, COMMITTED, or ABORTED.

        Possible values include:
        • "ACTIVE"
        • "COMMITTED"
        • "ABORTED"
        • "COMMIT_IN_PROGRESS"
      • TransactionStartTime — (Date)

        The time when the transaction started.

      • TransactionEndTime — (Date)

        The time when the transaction committed or aborted, if it is not currently active.

Returns:

• (AWS.Request) —

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

var params = {
  TransactionId: 'STRING_VALUE'
};
lakeformation.extendTransaction(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: {}) —
  • TransactionId — (String)

    The transaction to extend.

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.

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TableCatalogId: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE' /* required */
};
lakeformation.getDataCellsFilter(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: {}) —
  • TableCatalogId — (String)

    The ID of the catalog to which the table belongs.

  • DatabaseName — (String)

    A database in the Glue Data Catalog.

  • TableName — (String)

    A table in the database.

  • Name — (String)

    The name given by the user to the data filter cell.

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:

    • DataCellsFilter — (map)

      A structure that describes certain columns on certain rows.

      • TableCatalogId — required — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — required — (String)

        A database in the Glue Data Catalog.

      • TableName — required — (String)

        A table in the database.

      • Name — required — (String)

        The name given by the user to the data filter cell.

      • RowFilter — (map)

        A PartiQL predicate.

        • FilterExpression — (String)

          A filter expression.

        • AllRowsWildcard — (map)

          A wildcard for all rows.

      • ColumnNames — (Array<String>)

        A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.

      • ColumnWildcard — (map)

        A wildcard with exclusions.

        You must specify either a ColumnNames list or the ColumnWildCard.

        • ExcludedColumnNames — (Array<String>)

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

      • VersionId — (String)

        The ID of the data cells filter version.

Returns:

• (AWS.Request) —

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

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 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 Lake Formation principals designated as data lake administrators.

      • DataLakeAdmins — (Array<map>)

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

        • DataLakePrincipalIdentifier — (String)

          An identifier for the Lake Formation principal.

      • ReadOnlyAdmins — (Array<map>)

        A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.

        • DataLakePrincipalIdentifier — (String)

          An identifier for the Lake Formation principal.

      • CreateDatabaseDefaultPermissions — (Array<map>)

        Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

        A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.

        The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.

        For more information, see Changing the Default Security Settings for Your Data Lake.

        • Principal — (map)

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the Lake Formation principal.

        • Permissions — (Array<String>)

          The permissions that are granted to the principal.

      • CreateTableDefaultPermissions — (Array<map>)

        Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

        A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.

        The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.

        For more information, see Changing the Default Security Settings for Your Data Lake.

        • Principal — (map)

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier — (String)

            An identifier for the Lake Formation principal.

        • Permissions — (Array<String>)

          The permissions that are granted to the principal.

      • Parameters — (map<String>)

        A key-value map that provides an additional configuration on your data lake. CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4.

      • 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 CloudTrail log.

        You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

      • AllowExternalDataFiltering — (Boolean)

        Whether to allow Amazon EMR clusters to access data managed by Lake Formation.

        If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.

        If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.

        For more information, see (Optional) Allow external data filtering.

      • AllowFullTableExternalDataAccess — (Boolean)

        Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.

      • ExternalDataFilteringAllowList — (Array<map>)

        A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>

        • DataLakePrincipalIdentifier — (String)

          An identifier for the Lake Formation principal.

      • AuthorizedSessionTagValueList — (Array<String>)

        Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs.

Returns:

• (AWS.Request) —

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

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 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 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 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.

          • Name — required — (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.

          • DatabaseName — required — (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.

          • DatabaseName — required — (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.

          • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

          • ResourceArn — required — (String)

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

        • DataCellsFilter — (map)

          A data cell filter.

          • TableCatalogId — (String)

            The ID of the catalog to which the table belongs.

          • DatabaseName — (String)

            A database in the Glue Data Catalog.

          • TableName — (String)

            The name of the table.

          • Name — (String)

            The name of the data cells filter.

        • LFTag — (map)

          The LF-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 Lake Formation environment.

          • TagKey — required — (String)

            The key-name for the LF-tag.

          • TagValues — required — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagPolicy — (map)

          A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

          • ResourceType — required — (String)

            The resource type for which the LF-tag policy applies.

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

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

            • TagKey — required — (String)

              The key-name for the LF-tag.

            • TagValues — required — (Array<String>)

              A list of possible values an attribute can take.

              The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

      • 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 RAM.

      • LastUpdated — (Date)

        The date and time when the resource was last updated.

      • LastUpdatedBy — (String)

        The user who updated the record.

    • 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.

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 Lake Formation environment.

  • TagKey — (String)

    The key-name for the LF-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 Lake Formation environment.

    • TagKey — (String)

      The key-name for the LF-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.

var params = {
  QueryId: 'STRING_VALUE' /* required */
};
lakeformation.getQueryState(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: {}) —
  • QueryId — (String)

    The ID of the plan query operation.

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:

    • Error — (String)

      An error message when the operation fails.

    • State — (String)

      The state of a query previously submitted. The possible states are:

      • PENDING: the query is pending.

      • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

      • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

      • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.

      Possible values include:
      • "PENDING"
      • "WORKUNITS_AVAILABLE"
      • "ERROR"
      • "FINISHED"
      • "EXPIRED"

Returns:

• (AWS.Request) —

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

var params = {
  QueryId: 'STRING_VALUE' /* required */
};
lakeformation.getQueryStatistics(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: {}) —
  • QueryId — (String)

    The ID of the plan query operation.

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:

    • ExecutionStatistics — (map)

      An ExecutionStatistics structure containing execution statistics.

      • AverageExecutionTimeMillis — (Integer)

        The average time the request took to be executed.

      • DataScannedBytes — (Integer)

        The amount of data that was scanned in bytes.

      • WorkUnitsExecutedCount — (Integer)

        The number of work units executed.

    • PlanningStatistics — (map)

      A PlanningStatistics structure containing query planning statistics.

      • EstimatedDataToScanBytes — (Integer)

        An estimate of the data that was scanned in bytes.

      • PlanningTimeMillis — (Integer)

        The time that it took to process the request.

      • QueueTimeMillis — (Integer)

        The time the request was in queue to be processed.

      • WorkUnitsGeneratedCount — (Integer)

        The number of work units generated.

    • QuerySubmissionTime — (Date)

      The time that the query was submitted.

Returns:

• (AWS.Request) —

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

var params = {
  Resource: { /* required */
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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 Lake Formation environment.

  • Resource — (map)

    The database, table, or column resource for which you want to return LF-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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

  • ShowAssignedLFTags — (Boolean)

    Indicates whether to show the assigned LF-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 LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagsOnTable — (Array<map>)

      A list of LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagsOnColumns — (Array<map>)

      A list of LF-tags applied to a column resource.

      • Name — (String)

        The name of a column resource.

      • LFTags — (Array<map>)

        The LF-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 Lake Formation environment.

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (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.

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PartitionPredicate: 'STRING_VALUE',
  QueryAsOfTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TransactionId: 'STRING_VALUE'
};
lakeformation.getTableObjects(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 catalog containing the governed table. Defaults to the caller’s account.

  • DatabaseName — (String)

    The database containing the governed table.

  • TableName — (String)

    The governed table for which to retrieve objects.

  • TransactionId — (String)

    The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

  • QueryAsOfTime — (Date)

    The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.

  • PartitionPredicate — (String)

    A predicate to filter the objects returned based on the partition keys defined in the governed table.

    • The comparison operators supported are: =, >, <, >=, <=

    • The logical operators supported are: AND

    • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

  • MaxResults — (Integer)

    Specifies how many values to return in a page.

  • NextToken — (String)

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

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:

    • Objects — (Array<map>)

      A list of objects organized by partition keys.

      • PartitionValues — (Array<String>)

        A list of partition values.

      • Objects — (Array<map>)

        A list of table objects

        • Uri — (String)

          The Amazon S3 location of the object.

        • ETag — (String)

          The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and used to identify changes to the underlying data.

        • Size — (Integer)

          The size of the Amazon S3 object in bytes.

    • NextToken — (String)

      A continuation token indicating whether additional data is available.

Returns:

• (AWS.Request) —

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

var params = {
  Partition: { /* required */
    Values: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  TableArn: 'STRING_VALUE', /* required */
  AuditContext: {
    AdditionalAuditContext: 'STRING_VALUE'
  },
  DurationSeconds: 'NUMBER_VALUE',
  Permissions: [
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
    /* more items */
  ],
  SupportedPermissionTypes: [
    COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION,
    /* more items */
  ]
};
lakeformation.getTemporaryGluePartitionCredentials(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: {}) —
  • TableArn — (String)

    The ARN of the partitions' table.

  • Partition — (map)

    A list of partition values identifying a single partition.

    • Values — required — (Array<String>)

      The list of partition values.

  • Permissions — (Array<String>)

    Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).

  • DurationSeconds — (Integer)

    The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

  • AuditContext — (map)

    A structure representing context to access a resource (column names, query ID, etc).

    • AdditionalAuditContext — (String)

      The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.

  • SupportedPermissionTypes — (Array<String>)

    A list of supported permission types for the partition. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.

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:

    • AccessKeyId — (String)

      The access key ID for the temporary credentials.

    • SecretAccessKey — (String)

      The secret key for the temporary credentials.

    • SessionToken — (String)

      The session token for the temporary credentials.

    • Expiration — (Date)

      The date and time when the temporary credentials expire.

Returns:

• (AWS.Request) —

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

var params = {
  TableArn: 'STRING_VALUE', /* required */
  AuditContext: {
    AdditionalAuditContext: 'STRING_VALUE'
  },
  DurationSeconds: 'NUMBER_VALUE',
  Permissions: [
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
    /* more items */
  ],
  QuerySessionContext: {
    AdditionalContext: {
      '<ContextKey>': 'STRING_VALUE',
      /* '<ContextKey>': ... */
    },
    ClusterId: 'STRING_VALUE',
    QueryAuthorizationId: 'STRING_VALUE',
    QueryId: 'STRING_VALUE',
    QueryStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  S3Path: 'STRING_VALUE',
  SupportedPermissionTypes: [
    COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION,
    /* more items */
  ]
};
lakeformation.getTemporaryGlueTableCredentials(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: {}) —
  • TableArn — (String)

    The ARN identifying a table in the Data Catalog for the temporary credentials request.

  • Permissions — (Array<String>)

    Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).

  • DurationSeconds — (Integer)

    The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

  • AuditContext — (map)

    A structure representing context to access a resource (column names, query ID, etc).

    • AdditionalAuditContext — (String)

      The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.

  • SupportedPermissionTypes — (Array<String>)

    A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.

  • S3Path — (String)

    The Amazon S3 path for the table.

  • QuerySessionContext — (map)

    A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

    • QueryId — (String)

      A unique identifier generated by the query engine for the query.

    • QueryStartTime — (Date)

      A timestamp provided by the query engine for when the query started.

    • ClusterId — (String)

      An identifier string for the consumer cluster.

    • QueryAuthorizationId — (String)

      A cryptographically generated query identifier generated by Glue or Lake Formation.

    • AdditionalContext — (map<String>)

      An opaque string-string map passed by the query engine.

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:

    • AccessKeyId — (String)

      The access key ID for the temporary credentials.

    • SecretAccessKey — (String)

      The secret key for the temporary credentials.

    • SessionToken — (String)

      The session token for the temporary credentials.

    • Expiration — (Date)

      The date and time when the temporary credentials expire.

    • VendedS3Path — (Array<String>)

      The Amazon S3 path for the temporary credentials.

Returns:

• (AWS.Request) —

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

var params = {
  QueryId: 'STRING_VALUE', /* required */
  WorkUnitId: 'NUMBER_VALUE', /* required */
  WorkUnitToken: 'STRING_VALUE' /* required */
};
lakeformation.getWorkUnitResults(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: {}) —
  • QueryId — (String)

    The ID of the plan query operation for which to get results.

  • WorkUnitId — (Integer)

    The work unit ID for which to get results. Value generated by enumerating WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output of GetWorkUnits.

  • WorkUnitToken — (String)

    A work token used to query the execution service. Token output from GetWorkUnits.

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:

    • ResultStream — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0 messages.

Returns:

• (AWS.Request) —

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

var params = {
  QueryId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
lakeformation.getWorkUnits(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 a continuation call.

  • PageSize — (Integer)

    The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.

  • QueryId — (String)

    The ID of the plan query operation.

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 for paginating the returned list of tokens, returned if the current segment of the list is not the last.

    • QueryId — (String)

      The ID of the plan query operation.

    • WorkUnitRanges — (Array<map>)

      A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.

      • WorkUnitIdMax — required — (Integer)

        Defines the maximum work unit ID in the range. The maximum value is inclusive.

      • WorkUnitIdMin — required — (Integer)

        Defines the minimum work unit ID in the range.

      • WorkUnitToken — required — (String)

        A work token used to query the execution service.

Returns:

• (AWS.Request) —

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

var params = {
  Permissions: [ /* required */
    ALL | SELECT | ALTER | DROP | DELETE | INSERT | DESCRIBE | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS | CREATE_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
    /* more items */
  ],
  Principal: { /* required */
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: { /* required */
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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_LF_TAG | ASSOCIATE | GRANT_WITH_LF_TAG_EXPRESSION,
    /* 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 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 Lake Formation principal.

  • Resource — (map)

    The resource to which permissions are to be granted. Resources in 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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

  • Permissions — (Array<String>)

    The permissions granted to the principal on the resource. 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. Lake Formation requires that each principal be authorized to perform a specific task on 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.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Table: {
    DatabaseName: 'STRING_VALUE', /* required */
    CatalogId: 'STRING_VALUE',
    Name: 'STRING_VALUE',
    TableWildcard: {
    }
  }
};
lakeformation.listDataCellsFilter(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: {}) —
  • Table — (map)

    A table in the Glue Data Catalog.

    • CatalogId — (String)

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

    • DatabaseName — required — (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.

  • NextToken — (String)

    A continuation token, if this is a continuation call.

  • MaxResults — (Integer)

    The maximum size of the response.

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:

    • DataCellsFilters — (Array<map>)

      A list of DataCellFilter structures.

      • TableCatalogId — required — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — required — (String)

        A database in the Glue Data Catalog.

      • TableName — required — (String)

        A table in the database.

      • Name — required — (String)

        The name given by the user to the data filter cell.

      • RowFilter — (map)

        A PartiQL predicate.

        • FilterExpression — (String)

          A filter expression.

        • AllRowsWildcard — (map)

          A wildcard for all rows.

      • ColumnNames — (Array<String>)

        A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.

      • ColumnWildcard — (map)

        A wildcard with exclusions.

        You must specify either a ColumnNames list or the ColumnWildCard.

        • ExcludedColumnNames — (Array<String>)

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

      • VersionId — (String)

        The ID of the data cells filter version.

    • NextToken — (String)

      A continuation token, if not all requested data cell filters have been returned.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Principal: {
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: {
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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 */
        ]
      }
    }
  }
};
lakeformation.listLakeFormationOptIns(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: {}) —
  • Principal — (map)

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    • DataLakePrincipalIdentifier — (String)

      An identifier for the Lake Formation principal.

  • Resource — (map)

    A structure for the resource.

    • 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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

  • 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:

    • LakeFormationOptInsInfoList — (Array<map>)

      A list of principal-resource pairs that have Lake Formation permissins enforced.

      • Resource — (map)

        A structure for the resource.

        • 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 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.

          • Name — required — (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.

          • DatabaseName — required — (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.

          • DatabaseName — required — (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.

          • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

          • ResourceArn — required — (String)

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

        • DataCellsFilter — (map)

          A data cell filter.

          • TableCatalogId — (String)

            The ID of the catalog to which the table belongs.

          • DatabaseName — (String)

            A database in the Glue Data Catalog.

          • TableName — (String)

            The name of the table.

          • Name — (String)

            The name of the data cells filter.

        • LFTag — (map)

          The LF-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 Lake Formation environment.

          • TagKey — required — (String)

            The key-name for the LF-tag.

          • TagValues — required — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagPolicy — (map)

          A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

          • ResourceType — required — (String)

            The resource type for which the LF-tag policy applies.

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

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

            • TagKey — required — (String)

              The key-name for the LF-tag.

            • TagValues — required — (Array<String>)

              A list of possible values an attribute can take.

              The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

      • Principal — (map)

        The Lake Formation principal. Supported principals are IAM users or IAM roles.

        • DataLakePrincipalIdentifier — (String)

          An identifier for the Lake Formation principal.

      • LastModified — (Date)

        The last modified date and time of the record.

      • LastUpdatedBy — (String)

        The user who updated the record.

    • 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.

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 Lake Formation environment.

  • ResourceShareType — (String)

    If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-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 LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (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.

var params = {
  CatalogId: 'STRING_VALUE',
  IncludeRelated: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Principal: {
    DataLakePrincipalIdentifier: 'STRING_VALUE'
  },
  Resource: {
    Catalog: {
    },
    DataCellsFilter: {
      DatabaseName: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      TableCatalogId: 'STRING_VALUE',
      TableName: 'STRING_VALUE'
    },
    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 Lake Formation environment.

  • Principal — (map)

    Specifies a principal to filter the permissions returned.

    • DataLakePrincipalIdentifier — (String)

      An identifier for the 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 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.

      • Name — required — (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.

      • DatabaseName — required — (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.

      • DatabaseName — required — (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.

      • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

      • ResourceArn — required — (String)

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

    • DataCellsFilter — (map)

      A data cell filter.

      • TableCatalogId — (String)

        The ID of the catalog to which the table belongs.

      • DatabaseName — (String)

        A database in the Glue Data Catalog.

      • TableName — (String)

        The name of the table.

      • Name — (String)

        The name of the data cells filter.

    • LFTag — (map)

      The LF-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 Lake Formation environment.

      • TagKey — required — (String)

        The key-name for the LF-tag.

      • TagValues — required — (Array<String>)

        A list of possible values an attribute can take.

    • LFTagPolicy — (map)

      A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

      • ResourceType — required — (String)

        The resource type for which the LF-tag policy applies.

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

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

        • TagKey — required — (String)

          The key-name for the LF-tag.

        • TagValues — required — (Array<String>)

          A list of possible values an attribute can take.

          The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

  • 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.

  • IncludeRelated — (String)

    Indicates that related permissions should be included in the results.

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 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 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.

          • Name — required — (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.

          • DatabaseName — required — (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.

          • DatabaseName — required — (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.

          • Name — required — (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 Lake Formation. By default, it is the account ID of the caller.

          • ResourceArn — required — (String)

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

        • DataCellsFilter — (map)

          A data cell filter.

          • TableCatalogId — (String)

            The ID of the catalog to which the table belongs.

          • DatabaseName — (String)

            A database in the Glue Data Catalog.

          • TableName — (String)

            The name of the table.

          • Name — (String)

            The name of the data cells filter.

        • LFTag — (map)

          The LF-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 Lake Formation environment.

          • TagKey — required — (String)

            The key-name for the LF-tag.

          • TagValues — required — (Array<String>)

            A list of possible values an attribute can take.

        • LFTagPolicy — (map)

          A list of LF-tag conditions that define a resource's LF-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 Lake Formation environment.

          • ResourceType — required — (String)

            The resource type for which the LF-tag policy applies.

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

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

            • TagKey — required — (String)

              The key-name for the LF-tag.

            • TagValues — required — (Array<String>)

              A list of possible values an attribute can take.

              The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

      • 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 RAM.

      • LastUpdated — (Date)

        The date and time when the resource was last updated.

      • LastUpdatedBy — (String)

        The user who updated the record.

    • NextToken — (String)

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