Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetResourceLFTags

Returns the LF-tags applied to a resource.

Request Syntax


{
   "CatalogId": "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"
      }
   },
   "ShowAssignedLFTags": boolean
}

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

Resource

The database, table, or column resource for which you want to return LF-tags.

Type: Resource object

Required: Yes

ShowAssignedLFTags

Indicates whether to show the assigned LF-tags.

Type: Boolean

Required: No

Response Syntax


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

LFTagOnDatabase

A list of LF-tags applied to a database resource.

Type: Array of LFTagPair objects

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

LFTagsOnColumns

A list of LF-tags applied to a column resource.

Type: Array of ColumnLFTag objects

LFTagsOnTable

A list of LF-tags applied to a table resource.

Type: Array of LFTagPair objects

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

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

GlueEncryptionException

An encryption operation failed.

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