GetRLSPolicy - Lake Formation
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

GetRLSPolicy

Returns the definition of a row-level security policy, including its attachment columns and filter expression.

Request Syntax

POST /GetRLSPolicy HTTP/1.1 Content-type: application/json { "Name": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Name

The name of the row-level security policy to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "RLSPolicy": { "AttachmentColumns": [ { "Name": "string", "Type": "string" } ], "CatalogId": "string", "FilterExpression": "string", "Name": "string" } }

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.

RLSPolicy

An RLSPolicy structure containing the definition of the requested row-level security policy.

Type: RLSPolicy object

Errors

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

AccessDeniedException

Access to a resource was denied.

Message

A message describing the problem.

HTTP Status Code: 403

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 AWS SDKs, see the following: