View a markdown version of this page

ListRLSPolicies - Lake Formation

ListRLSPolicies

Lists the row-level security policies in the Data Catalog.

Request Syntax

POST /ListRLSPolicies HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of row-level security policies to return in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RLSPolicies": [ { "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.

NextToken

A continuation token, if not all row-level security policies have been returned.

Type: String

RLSPolicies

A list of RLSPolicy structures.

Type: Array of RLSPolicy objects

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: