[ aws . lakeformation ]

list-lf-tags

Description

Lists tags that the requester has permission to view.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-lf-tags
[--catalog-id <value>]
[--resource-share-type <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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.

--resource-share-type (string)

If resource share type is ALL , returns both in-account tags and shared tags that the requester has permission to view. If resource share type is FOREIGN , returns all share tags that the requester can view. If no resource share type is passed, lists tags in the given catalog ID that the requester has permission to view.

Possible values:

• FOREIGN

• ALL

--max-results (integer)

The maximum number of results to return.

--next-token (string)

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

--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

LFTags -> (list)

A list of tags that the requested has permission to view.

(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)

NextToken -> (string)

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