You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::LakeFormation::Types::ListPermissionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListPermissionsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  catalog_id: "CatalogIdString",
  principal: {
    data_lake_principal_identifier: "DataLakePrincipalString",
  },
  resource_type: "CATALOG", # accepts CATALOG, DATABASE, TABLE, DATA_LOCATION
  resource: {
    catalog: {
    },
    database: {
      name: "NameString", # required
    },
    table: {
      database_name: "NameString", # required
      name: "NameString", # required
    },
    table_with_columns: {
      database_name: "NameString",
      name: "NameString",
      column_names: ["NameString"],
      column_wildcard: {
        excluded_column_names: ["NameString"],
      },
    },
    data_location: {
      resource_arn: "ResourceArnString", # required
    },
  },
  next_token: "Token",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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.

Returns:

  • (String)

    The identifier for the Data Catalog.

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)

    The maximum number of results to return.

#next_tokenString

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

Returns:

  • (String)

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

#principalTypes::DataLakePrincipal

Specifies a principal to filter the permissions returned.

Returns:

#resourceTypes::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.

Returns:

  • (Types::Resource)

    A resource where you will get a list of the principal permissions.

#resource_typeString

Specifies a resource type to filter the permissions returned.

Possible values:

  • CATALOG
  • DATABASE
  • TABLE
  • DATA_LOCATION

Returns:

  • (String)

    Specifies a resource type to filter the permissions returned.