Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lakeformation ]

remove-lf-tags-from-resource

Description

Removes a tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  remove-lf-tags-from-resource
[--catalog-id <value>]
--resource <value>
--lf-tags <value>
[--cli-input-json <value>]
[--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 (structure)

The resource where you want to remove a tag.

Catalog -> (structure)

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.

Database -> (structure)

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

CatalogId -> (string)

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

Name -> (string)

The name of the database resource. Unique to the Data Catalog.

Table -> (structure)

The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

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.

TableWithColumns -> (structure)

The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

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 with columns resource. Unique to the 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 resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

ColumnNames -> (list)

The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

(string)

ColumnWildcard -> (structure)

A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

ExcludedColumnNames -> (list)

Excludes column names. Any column with this name will be excluded.

(string)

DataLocation -> (structure)

The location of an Amazon S3 path where permissions are granted or revoked.

CatalogId -> (string)

The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.

ResourceArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

LFTag -> (structure)

The tag key and values attached to a resource.

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)

LFTagPolicy -> (structure)

A list of tag conditions that define a resource's tag policy.

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.

ResourceType -> (string)

The resource type for which the tag policy applies.

Expression -> (list)

A list of tag conditions that apply to the resource's tag policy.

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

JSON Syntax:

{
  "Catalog": {

  },
  "Database": {
    "CatalogId": "string",
    "Name": "string"
  },
  "Table": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "Name": "string",
    "TableWildcard": {

    }
  },
  "TableWithColumns": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "Name": "string",
    "ColumnNames": ["string", ...],
    "ColumnWildcard": {
      "ExcludedColumnNames": ["string", ...]
    }
  },
  "DataLocation": {
    "CatalogId": "string",
    "ResourceArn": "string"
  },
  "LFTag": {
    "CatalogId": "string",
    "TagKey": "string",
    "TagValues": ["string", ...]
  },
  "LFTagPolicy": {
    "CatalogId": "string",
    "ResourceType": "DATABASE"|"TABLE",
    "Expression": [
      {
        "TagKey": "string",
        "TagValues": ["string", ...]
      }
      ...
    ]
  }
}

--lf-tags (list)

The tags to be removed from the 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)

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Failures -> (list)

A list of failures to untag a resource.

(structure)

A structure containing an error related to a TagResource or UnTagResource operation.

LFTag -> (structure)

The key-name of the tag.

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)

Error -> (structure)

An error that occurred with the attachment or detachment of the tag.

ErrorCode -> (string)

The code associated with this error.

ErrorMessage -> (string)

A message describing the error.