Class: Aws::LakeFormation::Types::ListPermissionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LakeFormation::Types::ListPermissionsRequest
- Defined in:
- gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb
Overview
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, LF_TAG, LF_TAG_POLICY, LF_TAG_POLICY_DATABASE, LF_TAG_POLICY_TABLE
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
},
data_cells_filter: {
table_catalog_id: "CatalogIdString",
database_name: "NameString",
table_name: "NameString",
name: "NameString",
},
lf_tag: {
catalog_id: "CatalogIdString",
tag_key: "NameString", # required
tag_values: ["LFTagValue"], # required
},
lf_tag_policy: {
catalog_id: "CatalogIdString",
resource_type: "DATABASE", # required, accepts DATABASE, TABLE
expression: [ # required
{
tag_key: "LFTagKey", # required
tag_values: ["LFTagValue"], # required
},
],
},
},
next_token: "Token",
max_results: 1,
include_related: "TrueFalseString",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#catalog_id ⇒ String
The identifier for the Data Catalog.
-
#include_related ⇒ String
Indicates that related permissions should be included in the results.
-
#max_results ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
A continuation token, if this is not the first call to retrieve this list.
-
#principal ⇒ Types::DataLakePrincipal
Specifies a principal to filter the permissions returned.
-
#resource ⇒ Types::Resource
A resource where you will get a list of the principal permissions.
-
#resource_type ⇒ String
Specifies a resource type to filter the permissions returned.
Instance Attribute Details
#catalog_id ⇒ 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.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#include_related ⇒ String
Indicates that related permissions should be included in the results.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to return.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
A continuation token, if this is not the first call to retrieve this list.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#principal ⇒ Types::DataLakePrincipal
Specifies a principal to filter the permissions returned.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#resource ⇒ Types::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.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |
#resource_type ⇒ String
Specifies a resource type to filter the permissions returned.
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 2710 class ListPermissionsRequest < Struct.new( :catalog_id, :principal, :resource_type, :resource, :next_token, :max_results, :include_related) SENSITIVE = [] include Aws::Structure end |