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

ListLFTags

Lists LF-tags that the requester has permission to view.

Request Syntax


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

{
   "CatalogId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceShareType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

CatalogId

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

Type: String

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

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

Required: No

MaxResults

The maximum number of results to return.

Type: Integer

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

Required: No

NextToken

A continuation token, if this is not the first call to retrieve this list.

Type: String

Required: No

ResourceShareType

If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.

Type: String

Valid Values: FOREIGN | ALL

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LFTags": [ 
      { 
         "CatalogId": "string",
         "TagKey": "string",
         "TagValues": [ "string" ]
      }
   ],
   "NextToken": "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.

LFTags

A list of LF-tags that the requested has permission to view.

Type: Array of LFTagPair objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

NextToken

A continuation token, present if the current list segment is not the last.

Type: String

Errors

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

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