[ aws . lakeformation ]
поиск баз данных по тегам LF
Описание
Эта операция позволяет искать ресурсы DATABASE по TagCondition. Данная операция используется администраторами для предоставления пользователям разрешений на определённые TagConditions. Перед предоставлением разрешений администратор может использовать SearchDatabasesByTags для поиска всех ресурсов, где заданные TagConditions являются допустимыми, чтобы проверить, могут ли возвращённые ресурсы быть предоставлены.
См. также: Документация API AWS
Операция search-databases-by-lf-tags является постраничной. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответной постраничной информации, аргумент --query должен извлекать данные из результатов следующих выражений запросов: DatabaseList
Синтаксис
search-databases-by-lf-tags
[--catalog-id <value>]
--expression <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)
--expression (список)
Список условий (структуры LFTag) для поиска в ресурсах баз данных.
(структура)
Структура, которая позволяет администратору предоставлять пользователям разрешения на определённые условия. Например, предоставление роли доступа ко всем столбцам, в которых нет тега LF «PII», в таблицах, которые имеют тег LF «Prod».
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
Максимальное количество значений, которые можно определить для тега LF, составляет 1000. Один вызов API поддерживает 50 значений. Для добавления большего количества значений можно использовать несколько вызовов API.
(строка)
Сокращённый синтаксис:
TagKey=string,TagValues=string,string ...
Синтаксис JSON:
[
{
"TagKey": "string",
"TagValues": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничного вывода. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возвращения в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, происходит валидация входных данных команды и возвращается пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и гарантии обратной совместимости в сгенерированном скелете JSON отсутствуют.
Глобальные параметры
--debug (логическое значение)
Включить отладку протоколирования.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команд.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла с данными учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить вывод в цвете.
- вкл
- выкл
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования для использования с двоичными блоками. По умолчанию используется формат 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 (логическое значение)
Отключить вывод кли паджера.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для поиска ресурсов баз данных по тегам LF
Следующий пример поиска ресурсов баз данных, соответствующих выражению тега LF.
aws lakeformation search-databases-by-lf-tags \
--cli-input-json file://input.json
Содержимое input.json:
{
"MaxResults": 1,
"CatalogId": "123456789111",
"Expression": [{
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}
Вывод:
{
"DatabaseList": [{
"Database": {
"CatalogId": "123456789111",
"Name": "tpc"
},
"LFTags": [{
"CatalogId": "123456789111",
"TagKey": "usergroup",
"TagValues": [
"developer"
]
}]
}]
}
Дополнительную информацию см. в разделе Просмотр ресурсов, которым назначен тег LF, в Руководстве разработчика AWS Lake Formation.
Вывод
NextToken -> (строка)
DatabaseList -> (список)
Список баз данных, удовлетворяющих условиям тегов LF.
(структура)
Структура, описывающая ресурс базы данных с тегами LF.
Database -> (структура)
База данных, к которой прикреплены теги LF.
CatalogId -> (строка)
Name -> (строка)
LFTags -> (список)
Список тегов LF, прикреплённых к базе данных.
(структура)
Структура, содержащая пару ключ-значение тега LF.
CatalogId -> (строка)
TagKey -> (строка)
TagValues -> (список)
Список возможных значений, которые может принимать атрибут.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.