View a markdown version of this page

DescribeResource - Lake Formation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeResource

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

Request Syntax

POST /DescribeResource HTTP/1.1 Content-type: application/json { "ResourceArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ResourceArn

The resource ARN.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ResourceInfo": { "ExpectedResourceOwnerAccount": "string", "HybridAccessEnabled": boolean, "LastModified": number, "ResourceArn": "string", "RoleArn": "string", "VerificationStatus": "string", "WithFederation": boolean, "WithPrivilegedAccess": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ResourceInfo

A structure containing information about an Lake Formation resource.

Type: ResourceInfo object

Errors

For information about the errors that are common to all actions, see Common Error Types.

EntityNotFoundException

A specified entity does not exist.

Message

A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message

A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

Message

A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message

A message describing the problem.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: