Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SearchDatabasesByLFTags

This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

Request Syntax


{
   "CatalogId": "string",
   "Expression": [ 
      { 
         "TagKey": "string",
         "TagValues": [ "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. 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

Expression

A list of conditions (LFTag structures) to search for in database resources.

Type: Array of LFTag objects

Required: Yes

MaxResults

The maximum number of results to return.

Type: Integer

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

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


{
   "DatabaseList": [ 
      { 
         "Database": { 
            "CatalogId": "string",
            "Name": "string"
         },
         "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.

DatabaseList

A list of databases that meet the LF-tag conditions.

Type: Array of TaggedDatabase objects

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.

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