AddLFTagsToResource - Lake Formation

AddLFTagsToResource

Attaches one or more LF-tags to an existing resource.

Request Syntax

{ "CatalogId": "string", "LFTags": [ { "CatalogId": "string", "TagKey": "string", "TagValues": [ "string" ] } ], "Resource": { "Catalog": { }, "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" ] }, "LFTagPolicy": { "CatalogId": "string", "Expression": [ { "TagKey": "string", "TagValues": [ "string" ] } ], "ResourceType": "string" }, "Table": { "CatalogId": "string", "DatabaseName": "string", "Name": "string", "TableWildcard": { } }, "TableWithColumns": { "CatalogId": "string", "ColumnNames": [ "string" ], "ColumnWildcard": { "ExcludedColumnNames": [ "string" ] }, "DatabaseName": "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. 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

LFTags

The LF-tags to attach to the resource.

Type: Array of LFTagPair objects

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

Required: Yes

Resource

The database, table, or column resource to which to attach an LF-tag.

Type: Resource object

Required: Yes

Response Syntax

{ "Failures": [ { "Error": { "ErrorCode": "string", "ErrorMessage": "string" }, "LFTag": { "CatalogId": "string", "TagKey": "string", "TagValues": [ "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.

Failures

A list of failures to tag the resource.

Type: Array of LFTagError objects

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

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

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

See Also

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