Get Effective Permissions For Path

lakeformation_get_effective_permissions_for_path

R Documentation

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3

Description

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

Usage

lakeformation_get_effective_permissions_for_path(CatalogId, ResourceArn,
  NextToken, MaxResults)

Arguments

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

ResourceArn

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

NextToken

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

MaxResults

The maximum number of results to return.

Value

A list with the following syntax:

list(
  Permissions = list(
    list(
      Principal = list(
        DataLakePrincipalIdentifier = "string"
      ),
      Resource = list(
        Catalog = list(),
        Database = list(
          CatalogId = "string",
          Name = "string"
        ),
        Table = list(
          CatalogId = "string",
          DatabaseName = "string",
          Name = "string",
          TableWildcard = list()
        ),
        TableWithColumns = list(
          CatalogId = "string",
          DatabaseName = "string",
          Name = "string",
          ColumnNames = list(
            "string"
          ),
          ColumnWildcard = list(
            ExcludedColumnNames = list(
              "string"
            )
          )
        ),
        DataLocation = list(
          CatalogId = "string",
          ResourceArn = "string"
        ),
        DataCellsFilter = list(
          TableCatalogId = "string",
          DatabaseName = "string",
          TableName = "string",
          Name = "string"
        ),
        LFTag = list(
          CatalogId = "string",
          TagKey = "string",
          TagValues = list(
            "string"
          )
        ),
        LFTagPolicy = list(
          CatalogId = "string",
          ResourceType = "DATABASE"|"TABLE",
          Expression = list(
            list(
              TagKey = "string",
              TagValues = list(
                "string"
              )
            )
          )
        )
      ),
      Permissions = list(
        "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"DESCRIBE"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"|"CREATE_LF_TAG"|"ASSOCIATE"|"GRANT_WITH_LF_TAG_EXPRESSION"
      ),
      PermissionsWithGrantOption = list(
        "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"DESCRIBE"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"|"CREATE_LF_TAG"|"ASSOCIATE"|"GRANT_WITH_LF_TAG_EXPRESSION"
      ),
      AdditionalDetails = list(
        ResourceShare = list(
          "string"
        )
      ),
      LastUpdated = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedBy = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_effective_permissions_for_path(
  CatalogId = "string",
  ResourceArn = "string",
  NextToken = "string",
  MaxResults = 123
)