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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb

Overview

Note:

When making an API call, you may pass ListPermissionsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

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)


906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#principalTypes::DataLakePrincipal

Specifies a principal to filter the permissions returned.



906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

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



906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

Specifies a resource type to filter the permissions returned.

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 906

class ListPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource_type,
  :resource,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end