Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRLSPolicyAttachments

Lists the row-level security policy attachments in the Data Catalog. You can filter the results by resource, principal, or policy name.

Request Syntax


POST /ListRLSPolicyAttachments HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "PolicyName": "string",
   "Principal": { 
      "DataLakePrincipalIdentifier": "string"
   },
   "Resource": { 
      "Catalog": { 
         "Id": "string"
      },
      "Database": { 
         "CatalogId": "string",
         "Name": "string"
      },
      "DataCellsFilter": { 
         "DatabaseName": "string",
         "Name": "string",
         "TableCatalogId": "string",
         "TableName": "string"
      },
      "DataLocation": { 
         "CatalogId": "string",
         "ResourceArn": "string"
      },
      "LFTag": { 
         "CatalogId": "string",
         "TagKey": "string",
         "TagValues": [ "string" ]
      },
      "LFTagExpression": { 
         "CatalogId": "string",
         "Name": "string"
      },
      "LFTagPolicy": { 
         "CatalogId": "string",
         "Expression": [ 
            { 
               "TagKey": "string",
               "TagValues": [ "string" ]
            }
         ],
         "ExpressionName": "string",
         "ResourceType": "string"
      },
      "RLSPolicy": { 
         "CatalogId": "string",
         "Name": "string"
      },
      "Table": { 
         "CatalogId": "string",
         "DatabaseName": "string",
         "Name": "string",
         "TableWildcard": { 
         }
      },
      "TableWithColumns": { 
         "CatalogId": "string",
         "ColumnNames": [ "string" ],
         "ColumnWildcard": { 
            "ExcludedColumnNames": [ "string" ]
         },
         "DatabaseName": "string",
         "Name": "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 attachments 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

PolicyName

If specified, returns only the attachments for the row-level security policy with this name.

Type: String

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

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

Required: No

Principal

If specified, returns only the attachments for the given principal.

Type: DataLakePrincipal object

Required: No

Resource

If specified, returns only the attachments for the given resource.

Type: Resource object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RLSPolicyAttachments": [ 
      { 
         "CatalogId": "string",
         "Condition": { 
            "Expression": "string"
         },
         "DefaultRLSPolicy": boolean,
         "PolicyName": "string",
         "Principal": { 
            "DataLakePrincipalIdentifier": "string"
         },
         "Resource": { 
            "Catalog": { 
               "Id": "string"
            },
            "Database": { 
               "CatalogId": "string",
               "Name": "string"
            },
            "DataCellsFilter": { 
               "DatabaseName": "string",
               "Name": "string",
               "TableCatalogId": "string",
               "TableName": "string"
            },
            "DataLocation": { 
               "CatalogId": "string",
               "ResourceArn": "string"
            },
            "LFTag": { 
               "CatalogId": "string",
               "TagKey": "string",
               "TagValues": [ "string" ]
            },
            "LFTagExpression": { 
               "CatalogId": "string",
               "Name": "string"
            },
            "LFTagPolicy": { 
               "CatalogId": "string",
               "Expression": [ 
                  { 
                     "TagKey": "string",
                     "TagValues": [ "string" ]
                  }
               ],
               "ExpressionName": "string",
               "ResourceType": "string"
            },
            "RLSPolicy": { 
               "CatalogId": "string",
               "Name": "string"
            },
            "Table": { 
               "CatalogId": "string",
               "DatabaseName": "string",
               "Name": "string",
               "TableWildcard": { 
               }
            },
            "TableWithColumns": { 
               "CatalogId": "string",
               "ColumnNames": [ "string" ],
               "ColumnWildcard": { 
                  "ExcludedColumnNames": [ "string" ]
               },
               "DatabaseName": "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 attachments have been returned.

Type: String

RLSPolicyAttachments

A list of RLSPolicyAttachment structures.

Type: Array of RLSPolicyAttachment 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