AWS Lake Formation

{'Permissions': {'AdditionalDetails': {'ResourceShare': ['string']}}}

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

client.get_effective_permissions_for_path(
    CatalogId='string',
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)

type CatalogId:

string

param CatalogId:

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

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

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'
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
            ],
            '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 AWS 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 AWS 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 AWS 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.

      • 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 share resource ARN.

        • ResourceShare (list) --

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

          • (string) --

  • NextToken (string) --

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

{'PrincipalResourcePermissions': {'AdditionalDetails': {'ResourceShare': ['string']}}}

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

client.list_permissions(
    CatalogId='string',
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    ResourceType='CATALOG'|'DATABASE'|'TABLE'|'DATA_LOCATION',
    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'
        }
    },
    NextToken='string',
    MaxResults=123
)

type CatalogId:

string

param CatalogId:

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

type Principal:

dict

param Principal:

Specifies a principal to filter the permissions returned.

• DataLakePrincipalIdentifier (string) --

  An identifier for the AWS Lake Formation principal.

type ResourceType:

string

param ResourceType:

Specifies a resource type to filter the permissions returned.

type Resource:

dict

param Resource:

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

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

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'
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS',
            ],
            '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 AWS 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 AWS 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 AWS 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.

      • 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 share resource ARN.

        • ResourceShare (list) --

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

          • (string) --

  • NextToken (string) --

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