LakeFormation

Client

class LakeFormation.Client

A low-level client representing AWS Lake Formation

Defines the public endpoint for the Lake Formation service.

client = session.create_client('lakeformation')

These are the available methods:

add_lf_tags_to_resource(**kwargs)

Attaches one or more LF-tags to an existing resource.

See also: AWS API Documentation

Request Syntax

response = client.add_lf_tags_to_resource(
    CatalogId='string',
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    LFTags=[
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)
Parameters
  • 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 (dict) --

    [REQUIRED]

    The database, table, or column resource to which to attach an LF-tag.

    • Catalog (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • LFTags (list) --

    [REQUIRED]

    The LF-tags to attach to the resource.

    • (dict) --

      A structure containing an LF-tag key-value pair.

      • 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) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'Failures': [
        {
            'LFTag': {
                'CatalogId': 'string',
                'TagKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Failures (list) --

      A list of failures to tag the resource.

      • (dict) --

        A structure containing an error related to a TagResource or UnTagResource operation.

        • LFTag (dict) --

          The key-name of the LF-tag.

          • CatalogId (string) --

            The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

          • TagKey (string) --

            The key-name for the LF-tag.

          • TagValues (list) --

            A list of possible values an attribute can take.

            • (string) --
        • Error (dict) --

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

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

assume_decorated_role_with_saml(**kwargs)

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.

This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess . Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows:

See also: AWS API Documentation

Request Syntax

response = client.assume_decorated_role_with_saml(
    SAMLAssertion='string',
    RoleArn='string',
    PrincipalArn='string',
    DurationSeconds=123
)
Parameters
  • SAMLAssertion (string) --

    [REQUIRED]

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

    [REQUIRED]

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

    [REQUIRED]

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

dict

Returns

Response Syntax

{
    'AccessKeyId': 'string',
    'SecretAccessKey': 'string',
    'SessionToken': 'string',
    'Expiration': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • 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 (datetime) --

      The date and time when the temporary credentials expire.

Exceptions

batch_grant_permissions(**kwargs)

Batch operation to grant permissions to the principal.

See also: AWS API Documentation

Request Syntax

response = client.batch_grant_permissions(
    CatalogId='string',
    Entries=[
        {
            'Id': 'string',
            'Principal': {
                'DataLakePrincipalIdentifier': 'string'
            },
            'Resource': {
                'Catalog': {}
                ,
                'Database': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'Table': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'TableWildcard': {}

                },
                'TableWithColumns': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'ColumnNames': [
                        'string',
                    ],
                    'ColumnWildcard': {
                        'ExcludedColumnNames': [
                            'string',
                        ]
                    }
                },
                'DataLocation': {
                    'CatalogId': 'string',
                    'ResourceArn': 'string'
                },
                'DataCellsFilter': {
                    'TableCatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'Name': 'string'
                },
                'LFTag': {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'DATABASE'|'TABLE',
                    'Expression': [
                        {
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ]
        },
    ]
)
Parameters
  • 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 (list) --

    [REQUIRED]

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

    • (dict) --

      A permission to a resource granted by batch operation to the principal.

      • Id (string) -- [REQUIRED]

        A unique identifier for the batch permissions request entry.

      • Principal (dict) --

        The principal to be granted a permission.

        • DataLakePrincipalIdentifier (string) --

          An identifier for the Lake Formation principal.

      • Resource (dict) --

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

        • Catalog (dict) --

          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 (dict) --

          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 (string) -- [REQUIRED]

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

        • Table (dict) --

          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 (string) -- [REQUIRED]

            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 (dict) --

            A wildcard object representing every table under a database.

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

        • TableWithColumns (dict) --

          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 (string) -- [REQUIRED]

            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 (string) -- [REQUIRED]

            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 (list) --

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

            • (string) --
          • ColumnWildcard (dict) --

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

            • ExcludedColumnNames (list) --

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

              • (string) --
        • DataLocation (dict) --

          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 (string) -- [REQUIRED]

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

        • DataCellsFilter (dict) --

          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 (dict) --

          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 (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
        • LFTagPolicy (dict) --

          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 (string) -- [REQUIRED]

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

          • Expression (list) -- [REQUIRED]

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

            • (dict) --

              A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

              • TagKey (string) -- [REQUIRED]

                The key-name for the LF-tag.

              • TagValues (list) -- [REQUIRED]

                A list of possible values an attribute can take.

                • (string) --
      • Permissions (list) --

        The permissions to be granted.

        • (string) --
      • PermissionsWithGrantOption (list) --

        Indicates if the option to pass permissions is granted.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'Failures': [
        {
            'RequestEntry': {
                'Id': 'string',
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Resource': {
                    'Catalog': {},
                    'Database': {
                        'CatalogId': 'string',
                        'Name': 'string'
                    },
                    'Table': {
                        'CatalogId': 'string',
                        'DatabaseName': 'string',
                        'Name': 'string',
                        'TableWildcard': {}
                    },
                    'TableWithColumns': {
                        'CatalogId': 'string',
                        'DatabaseName': 'string',
                        'Name': 'string',
                        'ColumnNames': [
                            'string',
                        ],
                        'ColumnWildcard': {
                            'ExcludedColumnNames': [
                                'string',
                            ]
                        }
                    },
                    'DataLocation': {
                        'CatalogId': 'string',
                        'ResourceArn': 'string'
                    },
                    'DataCellsFilter': {
                        'TableCatalogId': 'string',
                        'DatabaseName': 'string',
                        'TableName': 'string',
                        'Name': 'string'
                    },
                    'LFTag': {
                        'CatalogId': 'string',
                        'TagKey': 'string',
                        'TagValues': [
                            'string',
                        ]
                    },
                    'LFTagPolicy': {
                        'CatalogId': 'string',
                        'ResourceType': 'DATABASE'|'TABLE',
                        'Expression': [
                            {
                                'TagKey': 'string',
                                'TagValues': [
                                    'string',
                                ]
                            },
                        ]
                    }
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ],
                'PermissionsWithGrantOption': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Failures (list) --

      A list of failures to grant permissions to the resources.

      • (dict) --

        A list of failures when performing a batch grant or batch revoke operation.

        • RequestEntry (dict) --

          An identifier for an entry of the batch request.

          • Id (string) --

            A unique identifier for the batch permissions request entry.

          • Principal (dict) --

            The principal to be granted a permission.

            • DataLakePrincipalIdentifier (string) --

              An identifier for the Lake Formation principal.

          • Resource (dict) --

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

            • Catalog (dict) --

              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 (dict) --

              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 (string) --

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

            • Table (dict) --

              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 (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 (dict) --

                A wildcard object representing every table under a database.

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

            • TableWithColumns (dict) --

              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 (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 (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 (list) --

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

                • (string) --
              • ColumnWildcard (dict) --

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

                • ExcludedColumnNames (list) --

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

                  • (string) --
            • DataLocation (dict) --

              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 (string) --

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

            • DataCellsFilter (dict) --

              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 (dict) --

              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 (string) --

                The key-name for the LF-tag.

              • TagValues (list) --

                A list of possible values an attribute can take.

                • (string) --
            • LFTagPolicy (dict) --

              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 (string) --

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

              • Expression (list) --

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

                • (dict) --

                  A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

                  • TagKey (string) --

                    The key-name for the LF-tag.

                  • TagValues (list) --

                    A list of possible values an attribute can take.

                    • (string) --
          • Permissions (list) --

            The permissions to be granted.

            • (string) --
          • PermissionsWithGrantOption (list) --

            Indicates if the option to pass permissions is granted.

            • (string) --
        • Error (dict) --

          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.

Exceptions

batch_revoke_permissions(**kwargs)

Batch operation to revoke permissions from the principal.

See also: AWS API Documentation

Request Syntax

response = client.batch_revoke_permissions(
    CatalogId='string',
    Entries=[
        {
            'Id': 'string',
            'Principal': {
                'DataLakePrincipalIdentifier': 'string'
            },
            'Resource': {
                'Catalog': {}
                ,
                'Database': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'Table': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'TableWildcard': {}

                },
                'TableWithColumns': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'ColumnNames': [
                        'string',
                    ],
                    'ColumnWildcard': {
                        'ExcludedColumnNames': [
                            'string',
                        ]
                    }
                },
                'DataLocation': {
                    'CatalogId': 'string',
                    'ResourceArn': 'string'
                },
                'DataCellsFilter': {
                    'TableCatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'Name': 'string'
                },
                'LFTag': {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'DATABASE'|'TABLE',
                    'Expression': [
                        {
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ]
        },
    ]
)
Parameters
  • 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 (list) --

    [REQUIRED]

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

    • (dict) --

      A permission to a resource granted by batch operation to the principal.

      • Id (string) -- [REQUIRED]

        A unique identifier for the batch permissions request entry.

      • Principal (dict) --

        The principal to be granted a permission.

        • DataLakePrincipalIdentifier (string) --

          An identifier for the Lake Formation principal.

      • Resource (dict) --

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

        • Catalog (dict) --

          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 (dict) --

          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 (string) -- [REQUIRED]

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

        • Table (dict) --

          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 (string) -- [REQUIRED]

            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 (dict) --

            A wildcard object representing every table under a database.

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

        • TableWithColumns (dict) --

          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 (string) -- [REQUIRED]

            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 (string) -- [REQUIRED]

            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 (list) --

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

            • (string) --
          • ColumnWildcard (dict) --

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

            • ExcludedColumnNames (list) --

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

              • (string) --
        • DataLocation (dict) --

          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 (string) -- [REQUIRED]

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

        • DataCellsFilter (dict) --

          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 (dict) --

          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 (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
        • LFTagPolicy (dict) --

          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 (string) -- [REQUIRED]

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

          • Expression (list) -- [REQUIRED]

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

            • (dict) --

              A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

              • TagKey (string) -- [REQUIRED]

                The key-name for the LF-tag.

              • TagValues (list) -- [REQUIRED]

                A list of possible values an attribute can take.

                • (string) --
      • Permissions (list) --

        The permissions to be granted.

        • (string) --
      • PermissionsWithGrantOption (list) --

        Indicates if the option to pass permissions is granted.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'Failures': [
        {
            'RequestEntry': {
                'Id': 'string',
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Resource': {
                    'Catalog': {},
                    'Database': {
                        'CatalogId': 'string',
                        'Name': 'string'
                    },
                    'Table': {
                        'CatalogId': 'string',
                        'DatabaseName': 'string',
                        'Name': 'string',
                        'TableWildcard': {}
                    },
                    'TableWithColumns': {
                        'CatalogId': 'string',
                        'DatabaseName': 'string',
                        'Name': 'string',
                        'ColumnNames': [
                            'string',
                        ],
                        'ColumnWildcard': {
                            'ExcludedColumnNames': [
                                'string',
                            ]
                        }
                    },
                    'DataLocation': {
                        'CatalogId': 'string',
                        'ResourceArn': 'string'
                    },
                    'DataCellsFilter': {
                        'TableCatalogId': 'string',
                        'DatabaseName': 'string',
                        'TableName': 'string',
                        'Name': 'string'
                    },
                    'LFTag': {
                        'CatalogId': 'string',
                        'TagKey': 'string',
                        'TagValues': [
                            'string',
                        ]
                    },
                    'LFTagPolicy': {
                        'CatalogId': 'string',
                        'ResourceType': 'DATABASE'|'TABLE',
                        'Expression': [
                            {
                                'TagKey': 'string',
                                'TagValues': [
                                    'string',
                                ]
                            },
                        ]
                    }
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ],
                'PermissionsWithGrantOption': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Failures (list) --

      A list of failures to revoke permissions to the resources.

      • (dict) --

        A list of failures when performing a batch grant or batch revoke operation.

        • RequestEntry (dict) --

          An identifier for an entry of the batch request.

          • Id (string) --

            A unique identifier for the batch permissions request entry.

          • Principal (dict) --

            The principal to be granted a permission.

            • DataLakePrincipalIdentifier (string) --

              An identifier for the Lake Formation principal.

          • Resource (dict) --

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

            • Catalog (dict) --

              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 (dict) --

              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 (string) --

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

            • Table (dict) --

              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 (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 (dict) --

                A wildcard object representing every table under a database.

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

            • TableWithColumns (dict) --

              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 (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 (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 (list) --

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

                • (string) --
              • ColumnWildcard (dict) --

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

                • ExcludedColumnNames (list) --

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

                  • (string) --
            • DataLocation (dict) --

              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 (string) --

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

            • DataCellsFilter (dict) --

              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 (dict) --

              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 (string) --

                The key-name for the LF-tag.

              • TagValues (list) --

                A list of possible values an attribute can take.

                • (string) --
            • LFTagPolicy (dict) --

              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 (string) --

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

              • Expression (list) --

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

                • (dict) --

                  A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

                  • TagKey (string) --

                    The key-name for the LF-tag.

                  • TagValues (list) --

                    A list of possible values an attribute can take.

                    • (string) --
          • Permissions (list) --

            The permissions to be granted.

            • (string) --
          • PermissionsWithGrantOption (list) --

            Indicates if the option to pass permissions is granted.

            • (string) --
        • Error (dict) --

          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.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_transaction(**kwargs)

Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.

See also: AWS API Documentation

Request Syntax

response = client.cancel_transaction(
    TransactionId='string'
)
Parameters
TransactionId (string) --

[REQUIRED]

The transaction to cancel.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

close()

Closes underlying endpoint connections.

commit_transaction(**kwargs)

Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.

See also: AWS API Documentation

Request Syntax

response = client.commit_transaction(
    TransactionId='string'
)
Parameters
TransactionId (string) --

[REQUIRED]

The transaction to commit.

Return type
dict
Returns
Response Syntax
{
    'TransactionStatus': 'ACTIVE'|'COMMITTED'|'ABORTED'|'COMMIT_IN_PROGRESS'
}

Response Structure

  • (dict) --
    • TransactionStatus (string) --

      The status of the transaction.

Exceptions

create_data_cells_filter(**kwargs)

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

See also: AWS API Documentation

Request Syntax

response = client.create_data_cells_filter(
    TableData={
        'TableCatalogId': 'string',
        'DatabaseName': 'string',
        'TableName': 'string',
        'Name': 'string',
        'RowFilter': {
            'FilterExpression': 'string',
            'AllRowsWildcard': {}

        },
        'ColumnNames': [
            'string',
        ],
        'ColumnWildcard': {
            'ExcludedColumnNames': [
                'string',
            ]
        }
    }
)
Parameters
TableData (dict) --

[REQUIRED]

A DataCellsFilter structure containing information about the data cells filter.

  • TableCatalogId (string) -- [REQUIRED]

    The ID of the catalog to which the table belongs.

  • DatabaseName (string) -- [REQUIRED]

    A database in the Glue Data Catalog.

  • TableName (string) -- [REQUIRED]

    A table in the database.

  • Name (string) -- [REQUIRED]

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

  • RowFilter (dict) --

    A PartiQL predicate.

    • FilterExpression (string) --

      A filter expression.

    • AllRowsWildcard (dict) --

      A wildcard for all rows.

  • ColumnNames (list) --

    A list of column names.

    • (string) --
  • ColumnWildcard (dict) --

    A wildcard with exclusions.

    You must specify either a ColumnNames list or the ColumnWildCard .

    • ExcludedColumnNames (list) --

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

      • (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

create_lf_tag(**kwargs)

Creates an LF-tag with the specified name and values.

See also: AWS API Documentation

Request Syntax

response = client.create_lf_tag(
    CatalogId='string',
    TagKey='string',
    TagValues=[
        'string',
    ]
)
Parameters
  • 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) --

    [REQUIRED]

    The key-name for the LF-tag.

  • TagValues (list) --

    [REQUIRED]

    A list of possible values an attribute can take.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_data_cells_filter(**kwargs)

Deletes a data cell filter.

See also: AWS API Documentation

Request Syntax

response = client.delete_data_cells_filter(
    TableCatalogId='string',
    DatabaseName='string',
    TableName='string',
    Name='string'
)
Parameters
  • 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_lf_tag(**kwargs)

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_lf_tag(
    CatalogId='string',
    TagKey='string'
)
Parameters
  • 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) --

    [REQUIRED]

    The key-name for the LF-tag to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_objects_on_cancel(**kwargs)

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.

The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes .

See also: AWS API Documentation

Request Syntax

response = client.delete_objects_on_cancel(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    TransactionId='string',
    Objects=[
        {
            'Uri': 'string',
            'ETag': 'string'
        },
    ]
)
Parameters
  • CatalogId (string) -- The Glue data catalog that contains the governed table. Defaults to the current account ID.
  • DatabaseName (string) --

    [REQUIRED]

    The database that contains the governed table.

  • TableName (string) --

    [REQUIRED]

    The name of the governed table.

  • TransactionId (string) --

    [REQUIRED]

    ID of the transaction that the writes occur in.

  • Objects (list) --

    [REQUIRED]

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

    • (dict) --

      An object that defines an Amazon S3 object to be deleted if a transaction cancels, provided that VirtualPut was called before writing the object.

      • Uri (string) -- [REQUIRED]

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

      • ETag (string) --

        The ETag of the Amazon S3 object.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

deregister_resource(**kwargs)

Deregisters the resource as managed by the Data Catalog.

When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.

See also: AWS API Documentation

Request Syntax

response = client.deregister_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

describe_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The resource ARN.

Return type
dict
Returns
Response Syntax
{
    'ResourceInfo': {
        'ResourceArn': 'string',
        'RoleArn': 'string',
        'LastModified': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • ResourceInfo (dict) --

      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 (datetime) --

        The date and time the resource was last modified.

Exceptions

describe_transaction(**kwargs)

Returns the details of a single transaction.

See also: AWS API Documentation

Request Syntax

response = client.describe_transaction(
    TransactionId='string'
)
Parameters
TransactionId (string) --

[REQUIRED]

The transaction for which to return status.

Return type
dict
Returns
Response Syntax
{
    'TransactionDescription': {
        'TransactionId': 'string',
        'TransactionStatus': 'ACTIVE'|'COMMITTED'|'ABORTED'|'COMMIT_IN_PROGRESS',
        'TransactionStartTime': datetime(2015, 1, 1),
        'TransactionEndTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • TransactionDescription (dict) --

      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.

      • TransactionStartTime (datetime) --

        The time when the transaction started.

      • TransactionEndTime (datetime) --

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

Exceptions

extend_transaction(**kwargs)

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.

See also: AWS API Documentation

Request Syntax

response = client.extend_transaction(
    TransactionId='string'
)
Parameters
TransactionId (string) -- The transaction to extend.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_data_lake_settings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_data_lake_settings(
    CatalogId='string'
)
Parameters
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.
Return type
dict
Returns
Response Syntax
{
    'DataLakeSettings': {
        'DataLakeAdmins': [
            {
                'DataLakePrincipalIdentifier': 'string'
            },
        ],
        'CreateDatabaseDefaultPermissions': [
            {
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
        ],
        'CreateTableDefaultPermissions': [
            {
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
        ],
        'TrustedResourceOwners': [
            'string',
        ],
        'AllowExternalDataFiltering': True|False,
        'ExternalDataFilteringAllowList': [
            {
                'DataLakePrincipalIdentifier': 'string'
            },
        ],
        'AuthorizedSessionTagValueList': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • DataLakeSettings (dict) --

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

      • DataLakeAdmins (list) --

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

        • (dict) --

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

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

      • CreateDatabaseDefaultPermissions (list) --

        Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. You can override this default setting when you create a database.

        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 .

        • (dict) --

          Permissions granted to a principal.

          • Principal (dict) --

            The principal who is granted permissions.

            • DataLakePrincipalIdentifier (string) --

              An identifier for the Lake Formation principal.

          • Permissions (list) --

            The permissions that are granted to the principal.

            • (string) --
      • CreateTableDefaultPermissions (list) --

        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 .

        • (dict) --

          Permissions granted to a principal.

          • Principal (dict) --

            The principal who is granted permissions.

            • DataLakePrincipalIdentifier (string) --

              An identifier for the Lake Formation principal.

          • Permissions (list) --

            The permissions that are granted to the principal.

            • (string) --
      • TrustedResourceOwners (list) --

        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.

        • (string) --
      • 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 Data Filtering on Amazon EMR .

      • ExternalDataFilteringAllowList (list) --

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

        • (dict) --

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

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

      • AuthorizedSessionTagValueList (list) --

        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.

        • (string) --

Exceptions

get_effective_permissions_for_path(**kwargs)

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

See also: AWS API Documentation

Request Syntax

response = client.get_effective_permissions_for_path(
    CatalogId='string',
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • 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) --

    [REQUIRED]

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

dict

Returns

Response Syntax

{
    'Permissions': [
        {
            'Principal': {
                'DataLakePrincipalIdentifier': 'string'
            },
            'Resource': {
                'Catalog': {},
                'Database': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'Table': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'TableWildcard': {}
                },
                'TableWithColumns': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'ColumnNames': [
                        'string',
                    ],
                    'ColumnWildcard': {
                        'ExcludedColumnNames': [
                            'string',
                        ]
                    }
                },
                'DataLocation': {
                    'CatalogId': 'string',
                    'ResourceArn': 'string'
                },
                'DataCellsFilter': {
                    'TableCatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'Name': 'string'
                },
                'LFTag': {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'DATABASE'|'TABLE',
                    'Expression': [
                        {
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'AdditionalDetails': {
                'ResourceShare': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Permissions (list) --

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

      • (dict) --

        The permissions granted or revoked on a resource.

        • Principal (dict) --

          The Data Lake principal to be granted or revoked permissions.

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

        • Resource (dict) --

          The resource where permissions are to be granted or revoked.

          • Catalog (dict) --

            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 (dict) --

            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 (string) --

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

          • Table (dict) --

            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 (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 (dict) --

              A wildcard object representing every table under a database.

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

          • TableWithColumns (dict) --

            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 (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 (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 (list) --

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

              • (string) --
            • ColumnWildcard (dict) --

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

              • ExcludedColumnNames (list) --

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

                • (string) --
          • DataLocation (dict) --

            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 (string) --

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

          • DataCellsFilter (dict) --

            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 (dict) --

            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 (string) --

              The key-name for the LF-tag.

            • TagValues (list) --

              A list of possible values an attribute can take.

              • (string) --
          • LFTagPolicy (dict) --

            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 (string) --

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

            • Expression (list) --

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

              • (dict) --

                A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

                • TagKey (string) --

                  The key-name for the LF-tag.

                • TagValues (list) --

                  A list of possible values an attribute can take.

                  • (string) --
        • Permissions (list) --

          The permissions to be granted or revoked on the resource.

          • (string) --
        • PermissionsWithGrantOption (list) --

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

          • (string) --
        • AdditionalDetails (dict) --

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

          • ResourceShare (list) --

            A resource share ARN for a catalog resource shared through RAM.

            • (string) --
    • NextToken (string) --

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

Exceptions

get_lf_tag(**kwargs)

Returns an LF-tag definition.

See also: AWS API Documentation

Request Syntax

response = client.get_lf_tag(
    CatalogId='string',
    TagKey='string'
)
Parameters
  • 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) --

    [REQUIRED]

    The key-name for the LF-tag.

Return type

dict

Returns

Response Syntax

{
    'CatalogId': 'string',
    'TagKey': 'string',
    'TagValues': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • 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 (list) --

      A list of possible values an attribute can take.

      • (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_query_state(**kwargs)

Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning .

See also: AWS API Documentation

Request Syntax

response = client.get_query_state(
    QueryId='string'
)
Parameters
QueryId (string) --

[REQUIRED]

The ID of the plan query operation.

Return type
dict
Returns
Response Syntax
{
    'Error': 'string',
    'State': 'PENDING'|'WORKUNITS_AVAILABLE'|'ERROR'|'FINISHED'|'EXPIRED'
}

Response Structure

  • (dict) --

    A structure for the output.

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

Exceptions

get_query_statistics(**kwargs)

Retrieves statistics on the planning and execution of a query.

See also: AWS API Documentation

Request Syntax

response = client.get_query_statistics(
    QueryId='string'
)
Parameters
QueryId (string) --

[REQUIRED]

The ID of the plan query operation.

Return type
dict
Returns
Response Syntax
{
    'ExecutionStatistics': {
        'AverageExecutionTimeMillis': 123,
        'DataScannedBytes': 123,
        'WorkUnitsExecutedCount': 123
    },
    'PlanningStatistics': {
        'EstimatedDataToScanBytes': 123,
        'PlanningTimeMillis': 123,
        'QueueTimeMillis': 123,
        'WorkUnitsGeneratedCount': 123
    },
    'QuerySubmissionTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • ExecutionStatistics (dict) --

      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 (dict) --

      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 (datetime) --

      The time that the query was submitted.

Exceptions

get_resource_lf_tags(**kwargs)

Returns the LF-tags applied to a resource.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_lf_tags(
    CatalogId='string',
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    ShowAssignedLFTags=True|False
)
Parameters
  • 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 (dict) --

    [REQUIRED]

    The database, table, or column resource for which you want to return LF-tags.

    • Catalog (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • ShowAssignedLFTags (boolean) -- Indicates whether to show the assigned LF-tags.
Return type

dict

Returns

Response Syntax

{
    'LFTagOnDatabase': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'LFTagsOnTable': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'LFTagsOnColumns': [
        {
            'Name': 'string',
            'LFTags': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • LFTagOnDatabase (list) --

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

      • (dict) --

        A structure containing an LF-tag key-value pair.

        • 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 (list) --

          A list of possible values an attribute can take.

          • (string) --
    • LFTagsOnTable (list) --

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

      • (dict) --

        A structure containing an LF-tag key-value pair.

        • 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 (list) --

          A list of possible values an attribute can take.

          • (string) --
    • LFTagsOnColumns (list) --

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

      • (dict) --

        A structure containing the name of a column resource and the LF-tags attached to it.

        • Name (string) --

          The name of a column resource.

        • LFTags (list) --

          The LF-tags attached to a column resource.

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --

Exceptions

get_table_objects(**kwargs)

Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.

See also: AWS API Documentation

Request Syntax

response = client.get_table_objects(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    TransactionId='string',
    QueryAsOfTime=datetime(2015, 1, 1),
    PartitionPredicate='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CatalogId (string) -- The catalog containing the governed table. Defaults to the caller’s account.
  • DatabaseName (string) --

    [REQUIRED]

    The database containing the governed table.

  • TableName (string) --

    [REQUIRED]

    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 (datetime) -- 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.
Return type

dict

Returns

Response Syntax

{
    'Objects': [
        {
            'PartitionValues': [
                'string',
            ],
            'Objects': [
                {
                    'Uri': 'string',
                    'ETag': 'string',
                    'Size': 123
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Objects (list) --

      A list of objects organized by partition keys.

      • (dict) --

        A structure containing a list of partition values and table objects.

        • PartitionValues (list) --

          A list of partition values.

          • (string) --
        • Objects (list) --

          A list of table objects

          • (dict) --

            Specifies the details of a governed table.

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

Exceptions

get_temporary_glue_partition_credentials(**kwargs)

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.

See also: AWS API Documentation

Request Syntax

response = client.get_temporary_glue_partition_credentials(
    TableArn='string',
    Partition={
        'Values': [
            'string',
        ]
    },
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ],
    DurationSeconds=123,
    AuditContext={
        'AdditionalAuditContext': 'string'
    },
    SupportedPermissionTypes=[
        'COLUMN_PERMISSION'|'CELL_FILTER_PERMISSION',
    ]
)
Parameters
  • TableArn (string) --

    [REQUIRED]

    The ARN of the partitions' table.

  • Partition (dict) --

    [REQUIRED]

    A list of partition values identifying a single partition.

    • Values (list) -- [REQUIRED]

      The list of partition values.

      • (string) --
  • Permissions (list) --

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

    • (string) --
  • DurationSeconds (integer) -- The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
  • AuditContext (dict) --

    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 (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'AccessKeyId': 'string',
    'SecretAccessKey': 'string',
    'SessionToken': 'string',
    'Expiration': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • 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 (datetime) --

      The date and time when the temporary credentials expire.

Exceptions

get_temporary_glue_table_credentials(**kwargs)

Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.

See also: AWS API Documentation

Request Syntax

response = client.get_temporary_glue_table_credentials(
    TableArn='string',
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ],
    DurationSeconds=123,
    AuditContext={
        'AdditionalAuditContext': 'string'
    },
    SupportedPermissionTypes=[
        'COLUMN_PERMISSION'|'CELL_FILTER_PERMISSION',
    ]
)
Parameters
  • TableArn (string) --

    [REQUIRED]

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

  • Permissions (list) --

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

    • (string) --
  • DurationSeconds (integer) -- The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
  • AuditContext (dict) --

    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 (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'AccessKeyId': 'string',
    'SecretAccessKey': 'string',
    'SessionToken': 'string',
    'Expiration': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • 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 (datetime) --

      The date and time when the temporary credentials expire.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_work_unit_results(**kwargs)

Returns the work units resulting from the query. Work units can be executed in any order and in parallel.

See also: AWS API Documentation

Request Syntax

response = client.get_work_unit_results(
    QueryId='string',
    WorkUnitId=123,
    WorkUnitToken='string'
)
Parameters
  • QueryId (string) --

    [REQUIRED]

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

  • WorkUnitId (integer) --

    [REQUIRED]

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

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'ResultStream': StreamingBody()
}

Response Structure

  • (dict) --

    A structure for the output.

    • ResultStream (StreamingBody) --

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

Exceptions

get_work_units(**kwargs)

Retrieves the work units generated by the StartQueryPlanning operation.

See also: AWS API Documentation

Request Syntax

response = client.get_work_units(
    NextToken='string',
    PageSize=123,
    QueryId='string'
)
Parameters
  • 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) --

    [REQUIRED]

    The ID of the plan query operation.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'QueryId': 'string',
    'WorkUnitRanges': [
        {
            'WorkUnitIdMax': 123,
            'WorkUnitIdMin': 123,
            'WorkUnitToken': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A structure for the output.

    • 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 (list) --

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

      • (dict) --

        Defines the valid range of work unit IDs for querying the execution service.

        • WorkUnitIdMax (integer) --

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

        • WorkUnitIdMin (integer) --

          Defines the minimum work unit ID in the range.

        • WorkUnitToken (string) --

          A work token used to query the execution service.

Exceptions

grant_permissions(**kwargs)

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

For information about permissions, see Security and Access Control to Metadata and Data .

See also: AWS API Documentation

Request Syntax

response = client.grant_permissions(
    CatalogId='string',
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ],
    PermissionsWithGrantOption=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ]
)
Parameters
  • 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 (dict) --

    [REQUIRED]

    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 (dict) --

    [REQUIRED]

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

    • Catalog (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • Permissions (list) --

    [REQUIRED]

    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.

    • (string) --
  • PermissionsWithGrantOption (list) --

    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 .

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

list_data_cells_filter(**kwargs)

Lists all the data cell filters on a table.

See also: AWS API Documentation

Request Syntax

response = client.list_data_cells_filter(
    Table={
        'CatalogId': 'string',
        'DatabaseName': 'string',
        'Name': 'string',
        'TableWildcard': {}

    },
    NextToken='string',
    MaxResults=123
)
Parameters
  • Table (dict) --

    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 (string) -- [REQUIRED]

      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 (dict) --

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

dict

Returns

Response Syntax

{
    'DataCellsFilters': [
        {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string',
            'RowFilter': {
                'FilterExpression': 'string',
                'AllRowsWildcard': {}
            },
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DataCellsFilters (list) --

      A list of DataCellFilter structures.

      • (dict) --

        A structure that describes certain columns on certain rows.

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

        • RowFilter (dict) --

          A PartiQL predicate.

          • FilterExpression (string) --

            A filter expression.

          • AllRowsWildcard (dict) --

            A wildcard for all rows.

        • ColumnNames (list) --

          A list of column names.

          • (string) --
        • ColumnWildcard (dict) --

          A wildcard with exclusions.

          You must specify either a ColumnNames list or the ColumnWildCard .

          • ExcludedColumnNames (list) --

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

            • (string) --
    • NextToken (string) --

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

Exceptions

list_lf_tags(**kwargs)

Lists LF-tags that the requester has permission to view.

See also: AWS API Documentation

Request Syntax

response = client.list_lf_tags(
    CatalogId='string',
    ResourceShareType='FOREIGN'|'ALL',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • 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.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'LFTags': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LFTags (list) --

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

      • (dict) --

        A structure containing an LF-tag key-value pair.

        • 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 (list) --

          A list of possible values an attribute can take.

          • (string) --
    • NextToken (string) --

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

Exceptions

list_permissions(**kwargs)

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data .

See also: AWS API Documentation

Request Syntax

response = client.list_permissions(
    CatalogId='string',
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    ResourceType='CATALOG'|'DATABASE'|'TABLE'|'DATA_LOCATION'|'LF_TAG'|'LF_TAG_POLICY'|'LF_TAG_POLICY_DATABASE'|'LF_TAG_POLICY_TABLE',
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    NextToken='string',
    MaxResults=123,
    IncludeRelated='string'
)
Parameters
  • 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 (dict) --

    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.
  • Resource (dict) --

    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 (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'PrincipalResourcePermissions': [
        {
            'Principal': {
                'DataLakePrincipalIdentifier': 'string'
            },
            'Resource': {
                'Catalog': {},
                'Database': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'Table': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'TableWildcard': {}
                },
                'TableWithColumns': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'ColumnNames': [
                        'string',
                    ],
                    'ColumnWildcard': {
                        'ExcludedColumnNames': [
                            'string',
                        ]
                    }
                },
                'DataLocation': {
                    'CatalogId': 'string',
                    'ResourceArn': 'string'
                },
                'DataCellsFilter': {
                    'TableCatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'Name': 'string'
                },
                'LFTag': {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'DATABASE'|'TABLE',
                    'Expression': [
                        {
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
            ],
            'AdditionalDetails': {
                'ResourceShare': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PrincipalResourcePermissions (list) --

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

      • (dict) --

        The permissions granted or revoked on a resource.

        • Principal (dict) --

          The Data Lake principal to be granted or revoked permissions.

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

        • Resource (dict) --

          The resource where permissions are to be granted or revoked.

          • Catalog (dict) --

            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 (dict) --

            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 (string) --

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

          • Table (dict) --

            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 (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 (dict) --

              A wildcard object representing every table under a database.

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

          • TableWithColumns (dict) --

            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 (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 (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 (list) --

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

              • (string) --
            • ColumnWildcard (dict) --

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

              • ExcludedColumnNames (list) --

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

                • (string) --
          • DataLocation (dict) --

            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 (string) --

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

          • DataCellsFilter (dict) --

            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 (dict) --

            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 (string) --

              The key-name for the LF-tag.

            • TagValues (list) --

              A list of possible values an attribute can take.

              • (string) --
          • LFTagPolicy (dict) --

            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 (string) --

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

            • Expression (list) --

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

              • (dict) --

                A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

                • TagKey (string) --

                  The key-name for the LF-tag.

                • TagValues (list) --

                  A list of possible values an attribute can take.

                  • (string) --
        • Permissions (list) --

          The permissions to be granted or revoked on the resource.

          • (string) --
        • PermissionsWithGrantOption (list) --

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

          • (string) --
        • AdditionalDetails (dict) --

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

          • ResourceShare (list) --

            A resource share ARN for a catalog resource shared through RAM.

            • (string) --
    • NextToken (string) --

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

Exceptions

list_resources(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_resources(
    FilterConditionList=[
        {
            'Field': 'RESOURCE_ARN'|'ROLE_ARN'|'LAST_MODIFIED',
            'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT'|'CONTAINS'|'NOT_CONTAINS'|'BEGINS_WITH'|'IN'|'BETWEEN',
            'StringValueList': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters
  • FilterConditionList (list) --

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

    • (dict) --

      This structure describes the filtering of columns in a table based on a filter condition.

      • Field (string) --

        The field to filter in the filter condition.

      • ComparisonOperator (string) --

        The comparison operator used in the filter condition.

      • StringValueList (list) --

        A string with values used in evaluating the filter condition.

        • (string) --
  • MaxResults (integer) -- The maximum number of resource results.
  • NextToken (string) -- A continuation token, if this is not the first call to retrieve these resources.
Return type

dict

Returns

Response Syntax

{
    'ResourceInfoList': [
        {
            'ResourceArn': 'string',
            'RoleArn': 'string',
            'LastModified': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ResourceInfoList (list) --

      A summary of the data lake resources.

      • (dict) --

        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 (datetime) --

          The date and time the resource was last modified.

    • NextToken (string) --

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

Exceptions

list_table_storage_optimizers(**kwargs)

Returns the configuration of all storage optimizers associated with a specified table.

See also: AWS API Documentation

Request Syntax

response = client.list_table_storage_optimizers(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    StorageOptimizerType='COMPACTION'|'GARBAGE_COLLECTION'|'ALL',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CatalogId (string) -- The Catalog ID of the table.
  • DatabaseName (string) --

    [REQUIRED]

    Name of the database where the table is present.

  • TableName (string) --

    [REQUIRED]

    Name of the table.

  • StorageOptimizerType (string) -- The specific type of storage optimizers to list. The supported value is compaction .
  • MaxResults (integer) -- The number of storage optimizers to return on each call.
  • NextToken (string) -- A continuation token, if this is a continuation call.
Return type

dict

Returns

Response Syntax

{
    'StorageOptimizerList': [
        {
            'StorageOptimizerType': 'COMPACTION'|'GARBAGE_COLLECTION'|'ALL',
            'Config': {
                'string': 'string'
            },
            'ErrorMessage': 'string',
            'Warnings': 'string',
            'LastRunDetails': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • StorageOptimizerList (list) --

      A list of the storage optimizers associated with a table.

      • (dict) --

        A structure describing the configuration and details of a storage optimizer.

        • StorageOptimizerType (string) --

          The specific type of storage optimizer. The supported value is compaction .

        • Config (dict) --

          A map of the storage optimizer configuration. Currently contains only one key-value pair: is_enabled indicates true or false for acceleration.

          • (string) --
            • (string) --
        • ErrorMessage (string) --

          A message that contains information about any error (if present).

          When an acceleration result has an enabled status, the error message is empty.

          When an acceleration result has a disabled status, the message describes an error or simply indicates "disabled by the user".

        • Warnings (string) --

          A message that contains information about any warnings (if present).

        • LastRunDetails (string) --

          When an acceleration result has an enabled status, contains the details of the last job run.

    • NextToken (string) --

      A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Exceptions

list_transactions(**kwargs)

Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

This operation can help you identify uncommitted transactions or to get information about transactions.

See also: AWS API Documentation

Request Syntax

response = client.list_transactions(
    CatalogId='string',
    StatusFilter='ALL'|'COMPLETED'|'ACTIVE'|'COMMITTED'|'ABORTED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CatalogId (string) -- The catalog for which to list transactions. Defaults to the account ID of the caller.
  • StatusFilter (string) -- A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL .
  • MaxResults (integer) -- The maximum number of transactions to return in a single call.
  • NextToken (string) -- A continuation token if this is not the first call to retrieve transactions.
Return type

dict

Returns

Response Syntax

{
    'Transactions': [
        {
            'TransactionId': 'string',
            'TransactionStatus': 'ACTIVE'|'COMMITTED'|'ABORTED'|'COMMIT_IN_PROGRESS',
            'TransactionStartTime': datetime(2015, 1, 1),
            'TransactionEndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Transactions (list) --

      A list of transactions. The record for each transaction is a TransactionDescription object.

      • (dict) --

        A structure that contains information about a transaction.

        • TransactionId (string) --

          The ID of the transaction.

        • TransactionStatus (string) --

          A status of ACTIVE, COMMITTED, or ABORTED.

        • TransactionStartTime (datetime) --

          The time when the transaction started.

        • TransactionEndTime (datetime) --

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

    • NextToken (string) --

      A continuation token indicating whether additional data is available.

Exceptions

put_data_lake_settings(**kwargs)

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions .

This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.

See also: AWS API Documentation

Request Syntax

response = client.put_data_lake_settings(
    CatalogId='string',
    DataLakeSettings={
        'DataLakeAdmins': [
            {
                'DataLakePrincipalIdentifier': 'string'
            },
        ],
        'CreateDatabaseDefaultPermissions': [
            {
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
        ],
        'CreateTableDefaultPermissions': [
            {
                'Principal': {
                    'DataLakePrincipalIdentifier': 'string'
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
                ]
            },
        ],
        'TrustedResourceOwners': [
            'string',
        ],
        'AllowExternalDataFiltering': True|False,
        'ExternalDataFilteringAllowList': [
            {
                'DataLakePrincipalIdentifier': 'string'
            },
        ],
        'AuthorizedSessionTagValueList': [
            'string',
        ]
    }
)
Parameters
  • 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.
  • DataLakeSettings (dict) --

    [REQUIRED]

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

    • DataLakeAdmins (list) --

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

      • (dict) --

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

        • DataLakePrincipalIdentifier (string) --

          An identifier for the Lake Formation principal.

    • CreateDatabaseDefaultPermissions (list) --

      Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. You can override this default setting when you create a database.

      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 .

      • (dict) --

        Permissions granted to a principal.

        • Principal (dict) --

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

        • Permissions (list) --

          The permissions that are granted to the principal.

          • (string) --
    • CreateTableDefaultPermissions (list) --

      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 .

      • (dict) --

        Permissions granted to a principal.

        • Principal (dict) --

          The principal who is granted permissions.

          • DataLakePrincipalIdentifier (string) --

            An identifier for the Lake Formation principal.

        • Permissions (list) --

          The permissions that are granted to the principal.

          • (string) --
    • TrustedResourceOwners (list) --

      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.

      • (string) --
    • 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 Data Filtering on Amazon EMR .

    • ExternalDataFilteringAllowList (list) --

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

      • (dict) --

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

        • DataLakePrincipalIdentifier (string) --

          An identifier for the Lake Formation principal.

    • AuthorizedSessionTagValueList (list) --

      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.

      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

register_resource(**kwargs)

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.

ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn :

arn:aws:iam::12345:role/my-data-access-role

See also: AWS API Documentation

Request Syntax

response = client.register_resource(
    ResourceArn='string',
    UseServiceLinkedRole=True|False,
    RoleArn='string'
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • UseServiceLinkedRole (boolean) --

    Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.

    For more information, see Using Service-Linked Roles for Lake Formation .

  • RoleArn (string) -- The identifier for the role that registers the resource.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

remove_lf_tags_from_resource(**kwargs)

Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

See also: AWS API Documentation

Request Syntax

response = client.remove_lf_tags_from_resource(
    CatalogId='string',
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    LFTags=[
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)
Parameters
  • 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 (dict) --

    [REQUIRED]

    The database, table, or column resource where you want to remove an LF-tag.

    • Catalog (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • LFTags (list) --

    [REQUIRED]

    The LF-tags to be removed from the resource.

    • (dict) --

      A structure containing an LF-tag key-value pair.

      • 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) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'Failures': [
        {
            'LFTag': {
                'CatalogId': 'string',
                'TagKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Failures (list) --

      A list of failures to untag a resource.

      • (dict) --

        A structure containing an error related to a TagResource or UnTagResource operation.

        • LFTag (dict) --

          The key-name of the LF-tag.

          • CatalogId (string) --

            The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

          • TagKey (string) --

            The key-name for the LF-tag.

          • TagValues (list) --

            A list of possible values an attribute can take.

            • (string) --
        • Error (dict) --

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

          • ErrorCode (string) --

            The code associated with this error.

          • ErrorMessage (string) --

            A message describing the error.

Exceptions

revoke_permissions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.revoke_permissions(
    CatalogId='string',
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    Resource={
        'Catalog': {}
        ,
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ],
    PermissionsWithGrantOption=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_TAG'|'ASSOCIATE',
    ]
)
Parameters
  • 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 (dict) --

    [REQUIRED]

    The principal to be revoked permissions on the resource.

    • DataLakePrincipalIdentifier (string) --

      An identifier for the Lake Formation principal.

  • Resource (dict) --

    [REQUIRED]

    The resource to which permissions are to be revoked.

    • Catalog (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

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

    • Table (dict) --

      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 (string) -- [REQUIRED]

        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 (dict) --

        A wildcard object representing every table under a database.

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

    • TableWithColumns (dict) --

      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 (string) -- [REQUIRED]

        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 (string) -- [REQUIRED]

        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 (list) --

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

        • (string) --
      • ColumnWildcard (dict) --

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

        • ExcludedColumnNames (list) --

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

          • (string) --
    • DataLocation (dict) --

      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 (string) -- [REQUIRED]

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

    • DataCellsFilter (dict) --

      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 (dict) --

      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 (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
    • LFTagPolicy (dict) --

      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 (string) -- [REQUIRED]

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

      • Expression (list) -- [REQUIRED]

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

        • (dict) --

          A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

          • TagKey (string) -- [REQUIRED]

            The key-name for the LF-tag.

          • TagValues (list) -- [REQUIRED]

            A list of possible values an attribute can take.

            • (string) --
  • Permissions (list) --

    [REQUIRED]

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

    • (string) --
  • PermissionsWithGrantOption (list) --

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

search_databases_by_lf_tags(**kwargs)

This operation allows a search on DATABASE resources by TagCondition . This operation is used by admins who want to grant user permissions on certain TagConditions . Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

See also: AWS API Documentation

Request Syntax

response = client.search_databases_by_lf_tags(
    NextToken='string',
    MaxResults=123,
    CatalogId='string',
    Expression=[
        {
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)
Parameters
  • NextToken (string) -- A continuation token, if this is not the first call to retrieve this list.
  • MaxResults (integer) -- The maximum number of results to return.
  • CatalogId (string) -- The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
  • Expression (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

      • TagKey (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'DatabaseList': [
        {
            'Database': {
                'CatalogId': 'string',
                'Name': 'string'
            },
            'LFTags': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • DatabaseList (list) --

      A list of databases that meet the LF-tag conditions.

      • (dict) --

        A structure describing a database resource with LF-tags.

        • Database (dict) --

          A database that has LF-tags attached to it.

          • CatalogId (string) --

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

          • Name (string) --

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

        • LFTags (list) --

          A list of LF-tags attached to the database.

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --

Exceptions

search_tables_by_lf_tags(**kwargs)

This operation allows a search on TABLE resources by LFTag s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTag s are valid to verify whether the returned resources can be shared.

See also: AWS API Documentation

Request Syntax

response = client.search_tables_by_lf_tags(
    NextToken='string',
    MaxResults=123,
    CatalogId='string',
    Expression=[
        {
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)
Parameters
  • NextToken (string) -- A continuation token, if this is not the first call to retrieve this list.
  • MaxResults (integer) -- The maximum number of results to return.
  • CatalogId (string) -- The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
  • Expression (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

      • TagKey (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'TableList': [
        {
            'Table': {
                'CatalogId': 'string',
                'DatabaseName': 'string',
                'Name': 'string',
                'TableWildcard': {}
            },
            'LFTagOnDatabase': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ],
            'LFTagsOnTable': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ],
            'LFTagsOnColumns': [
                {
                    'Name': 'string',
                    'LFTags': [
                        {
                            'CatalogId': 'string',
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • TableList (list) --

      A list of tables that meet the LF-tag conditions.

      • (dict) --

        A structure describing a table resource with LF-tags.

        • Table (dict) --

          A table that has LF-tags attached to it.

          • CatalogId (string) --

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

          • DatabaseName (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 (dict) --

            A wildcard object representing every table under a database.

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

        • LFTagOnDatabase (list) --

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

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --
        • LFTagsOnTable (list) --

          A list of LF-tags attached to the table.

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --
        • LFTagsOnColumns (list) --

          A list of LF-tags attached to columns in the table.

          • (dict) --

            A structure containing the name of a column resource and the LF-tags attached to it.

            • Name (string) --

              The name of a column resource.

            • LFTags (list) --

              The LF-tags attached to a column resource.

              • (dict) --

                A structure containing an LF-tag key-value pair.

                • 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 (list) --

                  A list of possible values an attribute can take.

                  • (string) --

Exceptions

start_query_planning(**kwargs)

Submits a request to process a query statement.

This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

See also: AWS API Documentation

Request Syntax

response = client.start_query_planning(
    QueryPlanningContext={
        'CatalogId': 'string',
        'DatabaseName': 'string',
        'QueryAsOfTime': datetime(2015, 1, 1),
        'QueryParameters': {
            'string': 'string'
        },
        'TransactionId': 'string'
    },
    QueryString='string'
)
Parameters
  • QueryPlanningContext (dict) --

    [REQUIRED]

    A structure containing information about the query plan.

    • CatalogId (string) --

      The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.

    • DatabaseName (string) -- [REQUIRED]

      The database containing the table.

    • QueryAsOfTime (datetime) --

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

    • QueryParameters (dict) --

      A map consisting of key-value pairs.

      • (string) --
        • (string) --
    • TransactionId (string) --

      The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime .

  • QueryString (string) --

    [REQUIRED]

    A PartiQL query statement used as an input to the planner service.

Return type

dict

Returns

Response Syntax

{
    'QueryId': 'string'
}

Response Structure

  • (dict) --

    A structure for the output.

    • QueryId (string) --

      The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the Execute operation.

Exceptions

start_transaction(**kwargs)

Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.

See also: AWS API Documentation

Request Syntax

response = client.start_transaction(
    TransactionType='READ_AND_WRITE'|'READ_ONLY'
)
Parameters
TransactionType (string) -- Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed.
Return type
dict
Returns
Response Syntax
{
    'TransactionId': 'string'
}

Response Structure

  • (dict) --
    • TransactionId (string) --

      An opaque identifier for the transaction.

Exceptions

update_lf_tag(**kwargs)

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

See also: AWS API Documentation

Request Syntax

response = client.update_lf_tag(
    CatalogId='string',
    TagKey='string',
    TagValuesToDelete=[
        'string',
    ],
    TagValuesToAdd=[
        'string',
    ]
)
Parameters
  • 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) --

    [REQUIRED]

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

  • TagValuesToDelete (list) --

    A list of LF-tag values to delete from the LF-tag.

    • (string) --
  • TagValuesToAdd (list) --

    A list of LF-tag values to add from the LF-tag.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_resource(
    RoleArn='string',
    ResourceArn='string'
)
Parameters
  • RoleArn (string) --

    [REQUIRED]

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

  • ResourceArn (string) --

    [REQUIRED]

    The resource ARN.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_table_objects(**kwargs)

Updates the manifest of Amazon S3 objects that make up the specified governed table.

See also: AWS API Documentation

Request Syntax

response = client.update_table_objects(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    TransactionId='string',
    WriteOperations=[
        {
            'AddObject': {
                'Uri': 'string',
                'ETag': 'string',
                'Size': 123,
                'PartitionValues': [
                    'string',
                ]
            },
            'DeleteObject': {
                'Uri': 'string',
                'ETag': 'string',
                'PartitionValues': [
                    'string',
                ]
            }
        },
    ]
)
Parameters
  • CatalogId (string) -- The catalog containing the governed table to update. Defaults to the caller’s account ID.
  • DatabaseName (string) --

    [REQUIRED]

    The database containing the governed table to update.

  • TableName (string) --

    [REQUIRED]

    The governed table to update.

  • TransactionId (string) -- The transaction at which to do the write.
  • WriteOperations (list) --

    [REQUIRED]

    A list of WriteOperation objects that define an object to add to or delete from the manifest for a governed table.

    • (dict) --

      Defines an object to add to or delete from a governed table.

      • AddObject (dict) --

        A new object to add to the governed table.

        • Uri (string) -- [REQUIRED]

          The Amazon S3 location of the object.

        • ETag (string) -- [REQUIRED]

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

        • Size (integer) -- [REQUIRED]

          The size of the Amazon S3 object in bytes.

        • PartitionValues (list) --

          A list of partition values for the object. A value must be specified for each partition key associated with the table.

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

          • (string) --
      • DeleteObject (dict) --

        An object to delete from the governed table.

        • Uri (string) -- [REQUIRED]

          The Amazon S3 location of the object to delete.

        • ETag (string) --

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

        • PartitionValues (list) --

          A list of partition values for the object. A value must be specified for each partition key associated with the governed table.

          • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_table_storage_optimizer(**kwargs)

Updates the configuration of the storage optimizers for a table.

See also: AWS API Documentation

Request Syntax

response = client.update_table_storage_optimizer(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    StorageOptimizerConfig={
        'string': {
            'string': 'string'
        }
    }
)
Parameters
  • CatalogId (string) -- The Catalog ID of the table.
  • DatabaseName (string) --

    [REQUIRED]

    Name of the database where the table is present.

  • TableName (string) --

    [REQUIRED]

    Name of the table for which to enable the storage optimizer.

  • StorageOptimizerConfig (dict) --

    [REQUIRED]

    Name of the table for which to enable the storage optimizer.

    • (string) --
      • (dict) --
        • (string) --
          • (string) --
Return type

dict

Returns

Response Syntax

{
    'Result': 'string'
}

Response Structure

  • (dict) --

    • Result (string) --

      A response indicating the success of failure of the operation.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LakeFormation.Client.exceptions.AccessDeniedException

Access to a resource was denied.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Access to a resource was denied.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.AlreadyExistsException

A resource to be created or added already exists.

Example

try:
  ...
except client.exceptions.AlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource to be created or added already exists.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

Example

try:
  ...
except client.exceptions.ConcurrentModificationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Two processes are trying to modify a resource simultaneously.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.EntityNotFoundException

A specified entity does not exist

Example

try:
  ...
except client.exceptions.EntityNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A specified entity does not exist

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.ExpiredException

Contains details about an error where the query request expired.

Example

try:
  ...
except client.exceptions.ExpiredException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error where the query request expired.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.GlueEncryptionException

An encryption operation failed.

Example

try:
  ...
except client.exceptions.GlueEncryptionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An encryption operation failed.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.InternalServiceException

An internal service error occurred.

Example

try:
  ...
except client.exceptions.InternalServiceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal service error occurred.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.InvalidInputException

The input provided was not valid.

Example

try:
  ...
except client.exceptions.InvalidInputException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input provided was not valid.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.OperationTimeoutException

The operation timed out.

Example

try:
  ...
except client.exceptions.OperationTimeoutException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation timed out.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.PermissionTypeMismatchException

The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission , but cell-level permissions exist on the table, this exception is thrown.

Example

try:
  ...
except client.exceptions.PermissionTypeMismatchException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission , but cell-level permissions exist on the table, this exception is thrown.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.ResourceNotReadyException

Contains details about an error related to a resource which is not ready for a transaction.

Example

try:
  ...
except client.exceptions.ResourceNotReadyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error related to a resource which is not ready for a transaction.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

Example

try:
  ...
except client.exceptions.ResourceNumberLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource numerical limit was exceeded.

    • Message (string) --

      A message describing the problem.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.StatisticsNotReadyYetException

Contains details about an error related to statistics not being ready.

Example

try:
  ...
except client.exceptions.StatisticsNotReadyYetException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error related to statistics not being ready.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.ThrottledException

Contains details about an error where the query request was throttled.

Example

try:
  ...
except client.exceptions.ThrottledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error where the query request was throttled.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.TransactionCanceledException

Contains details about an error related to a transaction that was cancelled.

Example

try:
  ...
except client.exceptions.TransactionCanceledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error related to a transaction that was cancelled.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.TransactionCommitInProgressException

Contains details about an error related to a transaction commit that was in progress.

Example

try:
  ...
except client.exceptions.TransactionCommitInProgressException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error related to a transaction commit that was in progress.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.TransactionCommittedException

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects .

Example

try:
  ...
except client.exceptions.TransactionCommittedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects .

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LakeFormation.Client.exceptions.WorkUnitsNotReadyYetException

Contains details about an error related to work units not being ready.

Example

try:
  ...
except client.exceptions.WorkUnitsNotReadyYetException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Contains details about an error related to work units not being ready.

    • Message (string) --

      A message describing the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class LakeFormation.Paginator.GetWorkUnits
paginator = client.get_paginator('get_work_units')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.get_work_units().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    QueryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • QueryId (string) --

    [REQUIRED]

    The ID of the plan query operation.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'QueryId': 'string',
    'WorkUnitRanges': [
        {
            'WorkUnitIdMax': 123,
            'WorkUnitIdMin': 123,
            'WorkUnitToken': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A structure for the output.

    • QueryId (string) --

      The ID of the plan query operation.

    • WorkUnitRanges (list) --

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

      • (dict) --

        Defines the valid range of work unit IDs for querying the execution service.

        • WorkUnitIdMax (integer) --

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

        • WorkUnitIdMin (integer) --

          Defines the minimum work unit ID in the range.

        • WorkUnitToken (string) --

          A work token used to query the execution service.

class LakeFormation.Paginator.ListDataCellsFilter
paginator = client.get_paginator('list_data_cells_filter')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.list_data_cells_filter().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Table={
        'CatalogId': 'string',
        'DatabaseName': 'string',
        'Name': 'string',
        'TableWildcard': {}

    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Table (dict) --

    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 (string) -- [REQUIRED]

      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 (dict) --

      A wildcard object representing every table under a database.

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

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DataCellsFilters': [
        {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string',
            'RowFilter': {
                'FilterExpression': 'string',
                'AllRowsWildcard': {}
            },
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
    ],

}

Response Structure

  • (dict) --

    • DataCellsFilters (list) --

      A list of DataCellFilter structures.

      • (dict) --

        A structure that describes certain columns on certain rows.

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

        • RowFilter (dict) --

          A PartiQL predicate.

          • FilterExpression (string) --

            A filter expression.

          • AllRowsWildcard (dict) --

            A wildcard for all rows.

        • ColumnNames (list) --

          A list of column names.

          • (string) --
        • ColumnWildcard (dict) --

          A wildcard with exclusions.

          You must specify either a ColumnNames list or the ColumnWildCard .

          • ExcludedColumnNames (list) --

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

            • (string) --

class LakeFormation.Paginator.ListLFTags
paginator = client.get_paginator('list_lf_tags')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.list_lf_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    ResourceShareType='FOREIGN'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LFTags': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • LFTags (list) --

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

      • (dict) --

        A structure containing an LF-tag key-value pair.

        • 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 (list) --

          A list of possible values an attribute can take.

          • (string) --

class LakeFormation.Paginator.SearchDatabasesByLFTags
paginator = client.get_paginator('search_databases_by_lf_tags')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.search_databases_by_lf_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    Expression=[
        {
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • Expression (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

      • TagKey (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DatabaseList': [
        {
            'Database': {
                'CatalogId': 'string',
                'Name': 'string'
            },
            'LFTags': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • DatabaseList (list) --

      A list of databases that meet the LF-tag conditions.

      • (dict) --

        A structure describing a database resource with LF-tags.

        • Database (dict) --

          A database that has LF-tags attached to it.

          • CatalogId (string) --

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

          • Name (string) --

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

        • LFTags (list) --

          A list of LF-tags attached to the database.

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --

class LakeFormation.Paginator.SearchTablesByLFTags
paginator = client.get_paginator('search_tables_by_lf_tags')
paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.search_tables_by_lf_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    Expression=[
        {
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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.
  • Expression (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

      • TagKey (string) -- [REQUIRED]

        The key-name for the LF-tag.

      • TagValues (list) -- [REQUIRED]

        A list of possible values an attribute can take.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TableList': [
        {
            'Table': {
                'CatalogId': 'string',
                'DatabaseName': 'string',
                'Name': 'string',
                'TableWildcard': {}
            },
            'LFTagOnDatabase': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ],
            'LFTagsOnTable': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ],
            'LFTagsOnColumns': [
                {
                    'Name': 'string',
                    'LFTags': [
                        {
                            'CatalogId': 'string',
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • TableList (list) --

      A list of tables that meet the LF-tag conditions.

      • (dict) --

        A structure describing a table resource with LF-tags.

        • Table (dict) --

          A table that has LF-tags attached to it.

          • CatalogId (string) --

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

          • DatabaseName (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 (dict) --

            A wildcard object representing every table under a database.

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

        • LFTagOnDatabase (list) --

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

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --
        • LFTagsOnTable (list) --

          A list of LF-tags attached to the table.

          • (dict) --

            A structure containing an LF-tag key-value pair.

            • 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 (list) --

              A list of possible values an attribute can take.

              • (string) --
        • LFTagsOnColumns (list) --

          A list of LF-tags attached to columns in the table.

          • (dict) --

            A structure containing the name of a column resource and the LF-tags attached to it.

            • Name (string) --

              The name of a column resource.

            • LFTags (list) --

              The LF-tags attached to a column resource.

              • (dict) --

                A structure containing an LF-tag key-value pair.

                • 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 (list) --

                  A list of possible values an attribute can take.

                  • (string) --