Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListLFTagExpressions

Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.

Request Syntax


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

The identifier for the Data Catalog. By default, the account ID.

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

Response Syntax


{
   "LFTagExpressions": [ 
      { 
         "CatalogId": "string",
         "Description": "string",
         "Expression": [ 
            { 
               "TagKey": "string",
               "TagValues": [ "string" ]
            }
         ],
         "Name": "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.

LFTagExpressions

Logical expressions composed of one more LF-Tag key-value pairs.

Type: Array of LFTagExpression objects

NextToken

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

Type: String

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

Examples

Request example

This example illustrates one usage of ListLFTagExpressions.


{
  "CatalogId": "123456789012",
  "MaxResults": 5,
  "NextToken": "ExampleNa0ZYUnpkWVZVWk5TRFpaVA=="
}

Response example

This example illustrates one usage of ListLFTagExpressions.


{
  "LFTagExpressions": [
    {
      "Name": "city_department",
      "Description": "An updated description",
      "CatalogId": "123456789012",
      "Expression": [
        {
          "TagKey": "department",
          "TagValues": [
            "sales"
          ]
        }
      ]
    }
  ],
  "NextToken": "ExampleNa0ZYUnpkWVZVWk5TRFpaVA=="
}