DescribeResourceCommand

Suggest an Edit

Retrieves the current data access role for the given resource registered in Lake Formation.

Example Syntax

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

import { LakeFormationClient, DescribeResourceCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, DescribeResourceCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // DescribeResourceRequest
  ResourceArn: "STRING_VALUE", // required
};
const command = new DescribeResourceCommand(input);
const response = await client.send(command);
// { // DescribeResourceResponse
//   ResourceInfo: { // ResourceInfo
//     ResourceArn: "STRING_VALUE",
//     RoleArn: "STRING_VALUE",
//     LastModified: new Date("TIMESTAMP"),
//     WithFederation: true || false,
//     HybridAccessEnabled: true || false,
//     WithPrivilegedAccess: true || false,
//   },
// };

DescribeResourceCommand Input

See DescribeResourceCommandInput for more details

Parameter
Type
Description
ResourceArn
Required
string | undefined

The resource ARN.

DescribeResourceCommand Output

See DescribeResourceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ResourceInfo
ResourceInfo | undefined

A structure containing information about an Lake Formation resource.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

LakeFormationServiceException
Base exception class for all service exceptions from LakeFormation service.