[ aws . lakeformation ]

search-tables-by-lf-tags

Description

This operation allows a search on TABLE resources by LFTag s. This will be used by admins who want to grant user permissions on certain LFTags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTag s are valid to verify whether the returned resources can be shared.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-tables-by-lf-tags
[--next-token <value>]
[--max-results <value>]
[--catalog-id <value>]
--expression <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

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

--max-results (integer)

The maximum number of results to return.

--catalog-id (string)

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.

--expression (list)

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

(structure)

A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns not tagged ‘PII’ of tables tagged ‘Prod’.

TagKey -> (string)

The key-name for the tag.

TagValues -> (list)

A list of possible values an attribute can take.

(string)

Shorthand Syntax:

TagKey=string,TagValues=string,string ...

JSON Syntax:

[
  {
    "TagKey": "string",
    "TagValues": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

A continuation token, present if the current list segment is not the last.

TableList -> (list)

A list of tables that meet the tag conditions.

(structure)

A structure describing a table resource with tags.

Table -> (structure)

A table that has tags attached to it.

CatalogId -> (string)

The identifier for the Data Catalog. By default, it is the account ID of the caller.

DatabaseName -> (string)

The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

Name -> (string)

The name of the table.

TableWildcard -> (structure)

A wildcard object representing every table under a database.

At least one of TableResource$Name or TableResource$TableWildcard is required.

LFTagOnDatabase -> (list)

A list of tags attached to the database where the table resides.

(structure)

A structure containing a tag key-value pair.

CatalogId -> (string)

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.

TagKey -> (string)

The key-name for the tag.

TagValues -> (list)

A list of possible values an attribute can take.

(string)

LFTagsOnTable -> (list)

A list of tags attached to the table.

(structure)

A structure containing a tag key-value pair.

CatalogId -> (string)

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.

TagKey -> (string)

The key-name for the tag.

TagValues -> (list)

A list of possible values an attribute can take.

(string)

LFTagsOnColumns -> (list)

A list of tags attached to columns in the table.

(structure)

A structure containing the name of a column resource and the tags attached to it.

Name -> (string)

The name of a column resource.

LFTags -> (list)

The tags attached to a column resource.

(structure)

A structure containing a tag key-value pair.

CatalogId -> (string)

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.

TagKey -> (string)

The key-name for the tag.

TagValues -> (list)

A list of possible values an attribute can take.

(string)