[ aws . lakeformation ]
add-lf-tags-to-resource
Описание
Прикрепляет один или несколько тегов LF к существующему ресурсу.
См. также: Документацию API AWS
Синтаксис
add-lf-tags-to-resource
[--catalog-id <value>]
--resource <value>
--lf-tags <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--catalog-id (строка)
--resource (структура)
Ресурс базы данных, таблицы или столбца, к которому нужно прикрепить тег LF.
Catalog -> (структура)
Идентификатор каталога данных. По умолчанию - идентификатор учетной записи. Каталог данных - это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашей средой Lake Formation.
Id -> (строка)
Database -> (структура)
База данных для ресурса. Уникальна для каталога данных. База данных - это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать права доступа к базе данных для принципала.
CatalogId -> (строка)
Name -> (строка)
Table -> (структура)
Таблица для ресурса. Таблица - это метаданные, представляющие ваши данные. Вы можете предоставлять и отзывать права доступа к таблице для принципала.
CatalogId -> (строка)
DatabaseName -> (строка)
Name -> (строка)
TableWildcard -> (структура)
Объект подстановки, представляющий все таблицы в базе данных.
Требуется хотя бы один из TableResource$Name или TableResource$TableWildcard.
TableWithColumns -> (структура)
Таблица со столбцами для ресурса. Принципал с правами на этот ресурс может выбирать метаданные из столбцов таблицы в каталоге данных и подлежащие данные в Amazon S3.
CatalogId -> (строка)
DatabaseName -> (строка)
Name -> (строка)
ColumnNames -> (список)
Список имён столбцов таблицы. Требуется хотя бы один из ColumnNames или ColumnWildcard.
(строка)
ColumnWildcard -> (структура)
Подстановка, заданная объектом ColumnWildcard. Требуется хотя бы один из ColumnNames или ColumnWildcard.
ExcludedColumnNames -> (список)
Исключает имена столбцов. Любой столбец с этим именем будет исключен.
(строка)
DataLocation -> (структура)
Расположение пути Amazon S3, где предоставляются или отзываются права.
CatalogId -> (строка)
ResourceArn -> (строка)
DataCellsFilter -> (структура)
Фильтр ячеек данных.
TableCatalogId -> (строка)
DatabaseName -> (строка)
TableName -> (строка)
Name -> (строка)
LFTag -> (структура)
Ключи и значения тегов LF, прикрепленных к ресурсу.
CatalogId -> (строка)
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
(строка)
LFTagPolicy -> (структура)
Список условий тегов LF или сохранённых выражений тегов LF, определяющих политику тегов LF ресурса.
CatalogId -> (строка)
ResourceType -> (строка)
Expression -> (список)
Список условий тегов LF или сохранённого выражения, которое применяется к политике тегов LF ресурса.
(структура)
Структура, которая позволяет администратору предоставлять права доступа пользователям при определённых условиях. Например, предоставление роли доступа ко всем столбцам, не имеющим тег LF «PII», в таблицах, имеющих тег LF «Prod».
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
Максимальное количество значений, которое можно определить для тега LF, составляет 1000. В одном вызове API поддерживается 50 значений. Вы можете использовать несколько вызовов API для добавления большего количества значений.
(строка)
ExpressionName -> (строка)
ExpressionName.LFTagExpression -> (структура)
Ресурс выражения тегов LF. Логическое выражение, составленное из одной или нескольких пар ключ:значение тегов LF.
CatalogId -> (строка)
Name -> (строка)
Синтаксис JSON:
{
"Catalog": {
"Id": "string"
},
"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"
},
"DataCellsFilter": {
"TableCatalogId": "string",
"DatabaseName": "string",
"TableName": "string",
"Name": "string"
},
"LFTag": {
"CatalogId": "string",
"TagKey": "string",
"TagValues": ["string", ...]
},
"LFTagPolicy": {
"CatalogId": "string",
"ResourceType": "DATABASE"|"TABLE",
"Expression": [
{
"TagKey": "string",
"TagValues": ["string", ...]
}
...
],
"ExpressionName": "string"
},
"LFTagExpression": {
"CatalogId": "string",
"Name": "string"
}
}
--lf-tags (список)
Теги LF, которые нужно прикрепить к ресурсу.
(структура)
Структура, содержащая пару ключ-значение тега LF.
CatalogId -> (строка)
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
(строка)
Сокращённый синтаксис:
CatalogId=string,TagKey=string,TagValues=string,string ...
Синтаксис JSON:
[
{
"CatalogId": "string",
"TagKey": "string",
"TagValues": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передавать произвольные двоичные данные с помощью предоставленного значения JSON, так как строка будет интерпретирована буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет образец YAML-ввода, который можно использовать с --cli-input-yaml. Если указано значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (boolean)
Включить отладку логирования.
--endpoint-url (string)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросить параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация содержится в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для добавления одной или нескольких тегов LF к существующему ресурсу
В следующем add-lf-tags-to-resource примере заданный тег LF добавляется к ресурсу таблицы.
aws lakeformation add-lf-tags-to-resource \
--cli-input-json file://input.json
Содержимое input.json:
{
"CatalogId": "123456789111",
"Resource": {
"Table": {
"CatalogId": "123456789111",
"DatabaseName": "tpc",
"Name": "dl_tpc_promotion"
}
},
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"analyst"
]
}]
}
Вывод:
{
"Failures": []
}
Для получения дополнительной информации см. Назначение тегов LF для ресурсов каталога данных в Руководстве разработчика AWS Lake Formation.
Вывод
Ошибки -> (список)
Список ошибок при присвоении тегов ресурсу.
(структура)
Структура, содержащая ошибку, связанную с операцией TagResource или UnTagResource.
LFTag -> (структура)
Ключ-имя тега LF.
CatalogId -> (строка)
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
(строка)
Error -> (структура)
Ошибка, возникшая при присвоении или отсоединении тега LF.
ErrorCode -> (строка)
ErrorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.