Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetEffectivePermissionsForPathCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { LakeFormationClient, GetEffectivePermissionsForPathCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, GetEffectivePermissionsForPathCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // GetEffectivePermissionsForPathRequest
CatalogId: "STRING_VALUE",
ResourceArn: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new GetEffectivePermissionsForPathCommand(input);
const response = await client.send(command);
// { // GetEffectivePermissionsForPathResponse
// Permissions: [ // PrincipalResourcePermissionsList
// { // PrincipalResourcePermissions
// Principal: { // DataLakePrincipal
// DataLakePrincipalIdentifier: "STRING_VALUE",
// },
// Resource: { // Resource
// Catalog: {},
// Database: { // DatabaseResource
// CatalogId: "STRING_VALUE",
// Name: "STRING_VALUE", // required
// },
// Table: { // TableResource
// CatalogId: "STRING_VALUE",
// DatabaseName: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// TableWildcard: {},
// },
// TableWithColumns: { // TableWithColumnsResource
// CatalogId: "STRING_VALUE",
// DatabaseName: "STRING_VALUE", // required
// Name: "STRING_VALUE", // required
// ColumnNames: [ // ColumnNames
// "STRING_VALUE",
// ],
// ColumnWildcard: { // ColumnWildcard
// ExcludedColumnNames: [
// "STRING_VALUE",
// ],
// },
// },
// DataLocation: { // DataLocationResource
// CatalogId: "STRING_VALUE",
// ResourceArn: "STRING_VALUE", // required
// },
// DataCellsFilter: { // DataCellsFilterResource
// TableCatalogId: "STRING_VALUE",
// DatabaseName: "STRING_VALUE",
// TableName: "STRING_VALUE",
// Name: "STRING_VALUE",
// },
// LFTag: { // LFTagKeyResource
// CatalogId: "STRING_VALUE",
// TagKey: "STRING_VALUE", // required
// TagValues: [ // TagValueList // required
// "STRING_VALUE",
// ],
// },
// LFTagPolicy: { // LFTagPolicyResource
// CatalogId: "STRING_VALUE",
// ResourceType: "DATABASE" || "TABLE", // required
// Expression: [ // Expression // required
// { // LFTag
// TagKey: "STRING_VALUE", // required
// TagValues: [ // required
// "STRING_VALUE",
// ],
// },
// ],
// },
// },
// Permissions: [ // PermissionList
// "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "DESCRIBE" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS" || "CREATE_LF_TAG" || "ASSOCIATE" || "GRANT_WITH_LF_TAG_EXPRESSION",
// ],
// PermissionsWithGrantOption: [
// "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "DESCRIBE" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS" || "CREATE_LF_TAG" || "ASSOCIATE" || "GRANT_WITH_LF_TAG_EXPRESSION",
// ],
// AdditionalDetails: { // DetailsMap
// ResourceShare: [ // ResourceShareList
// "STRING_VALUE",
// ],
// },
// },
// ],
// NextToken: "STRING_VALUE",
// };

Param

GetEffectivePermissionsForPathCommandInput

Returns

GetEffectivePermissionsForPathCommandOutput

See

Throws

EntityNotFoundException (client fault)

A specified entity does not exist.

Throws

InternalServiceException (server fault)

An internal service error occurred.

Throws

InvalidInputException (client fault)

The input provided was not valid.

Throws

OperationTimeoutException (client fault)

The operation timed out.

Throws

LakeFormationServiceException

Base exception class for all service exceptions from LakeFormation service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods