UpdateLFTagExpression - Lake Formation

UpdateLFTagExpression

Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.

Request Syntax

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

Description

The description with information about the saved LF-Tag expression.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

Required: No

Expression

The LF-Tag expression body composed of one more LF-Tag key-value pairs.

Type: Array of LFTag objects

Required: Yes

Name

The name for the LF-Tag expression.

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 Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

HTTP Status Code: 400

Examples

Request example

This example illustrates one usage of UpdateLFTagExpression.

{ "CatalogId": "123456789012", "Name": "city_department", "Description": "An updated description", "Expression": [ { "TagKey": "Department", "TagValues": [ "Sales" ] } ] }

Response example

This example illustrates one usage of UpdateLFTagExpression.

{}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: