Class ListPermissionsCommandProtected

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

Example

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

import { LakeFormationClient, ListPermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, ListPermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // ListPermissionsRequest
  CatalogId: "STRING_VALUE",
  Principal: { // DataLakePrincipal
    DataLakePrincipalIdentifier: "STRING_VALUE",
  },
  ResourceType: "CATALOG" || "DATABASE" || "TABLE" || "DATA_LOCATION" || "LF_TAG" || "LF_TAG_POLICY" || "LF_TAG_POLICY_DATABASE" || "LF_TAG_POLICY_TABLE",
  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",
          ],
        },
      ],
    },
  },
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  IncludeRelated: "STRING_VALUE",
};
const command = new ListPermissionsCommand(input);
const response = await client.send(command);
// { // ListPermissionsResponse
//   PrincipalResourcePermissions: [ // 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",
//         ],
//       },
//       LastUpdated: new Date("TIMESTAMP"),
//       LastUpdatedBy: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListPermissionsCommandInput

Returns

ListPermissionsCommandOutput

See

• ListPermissionsCommandInput for command's input shape.
• ListPermissionsCommandOutput for command's response shape.
• config for LakeFormationClient's config shape.

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.