Spec-Zone.ru › AWS CLI v2

[ aws . lakeformation ]

get-resource-lf-tags

Описание

Возвращает применённые к ресурсу теги LF.

См. также: Документацию API AWS

Синтаксис

  get-resource-lf-tags
[--catalog-id <value>]
--resource <value>
[--show-assigned-lf-tags | --no-show-assigned-lf-tags]
[--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 (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

--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 -> (строка)

Идентификатор каталога данных, где расположение зарегистрировано в Lake Formation. По умолчанию — идентификатор учётной записи вызывающего абонента.

ResourceArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий ресурс расположения данных.

DataCellsFilter -> (структура)

Фильтр ячеек данных.

TableCatalogId -> (строка)

Идентификатор каталога, к которому принадлежит таблица.

DatabaseName -> (строка)

База данных в Glue Data Catalog.

TableName -> (строка)

Имя таблицы.

Name -> (строка)

Имя фильтра ячеек данных.

LFTag -> (структура)

Ключ и значения тега LF, прикреплённого к ресурсу.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

TagKey -> (строка)

Имя ключа тега LF.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

(строка)

LFTagPolicy -> (структура)

Список условий тегов LF или сохранённых выражений тегов LF, определяющих политику тегов LF ресурса.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

ResourceType -> (строка)

Тип ресурса, к которому применяется политика тегов LF.

Expression -> (список)

Список условий тегов LF или сохранённого выражения, которые применяются к политике тегов LF ресурса.

(структура)

Структура, которая позволяет администратору предоставлять пользователям разрешения при определённых условиях. Например, предоставление роли доступа ко всем столбцам, не имеющим тега LF «PII», в таблицах, имеющих тег LF «Prod».

TagKey -> (строка)

Имя ключа тега LF.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

Максимальное количество значений, которые могут быть определены для тега LF, равно 1000. Один вызов API поддерживает 50 значений. Вы можете использовать несколько вызовов API, чтобы добавить больше значений.

(строка)

ExpressionName -> (строка)

Если указано, разрешения предоставляются ресурсам каталога данных, назначенные теги LF которых соответствуют выражению тела сохранённого выражения по предоставленному ExpressionName.

LFTagExpression -> (структура)

Ресурс выражения тегов LF. Логическое выражение, состоящее из одной или нескольких пар ключ:значение тегов LF.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи.

Name -> (строка)

Имя выражения тега LF, для которого предоставляются разрешения.

Синтаксис 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"
  }
}

--show-assigned-lf-tags | --no-show-assigned-lf-tags (булево)

Указывает, нужно ли отображать назначенные теги LF.

--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 (булево)

Включить отладку регистрации.

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

--cli-auto-prompt (булево)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров входных данных CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Чтобы получить список LF-меток

Следующий list-lf-tags пример возвращает список LF-меток, просмотр которых разрешен для запросившего.

aws lakeformation list-lf-tags \
    --cli-input-json file://input.json

Содержание input.json:

{
    "CatalogId": "123456789111",
    "ResourceShareType": "ALL",
    "MaxResults": 2
}

Вывод:

{
"LFTags": [{
        "CatalogId": "123456789111",
        "TagKey": "category",
        "TagValues": [
            "private",
            "public"
        ]
    },
    {
        "CatalogId": "123456789111",
        "TagKey": "group",
        "TagValues": [
            "analyst",
            "campaign",
            "developer"
        ]
    }],
    "NextToken": "kIiwiZXhwaXJhdGlvbiI6eyJzZWNvbmRzIjoxNjYwMDY4dCI6ZmFsc2V9"
}

Дополнительную информацию см. в разделе «Управление LF-метками для управления доступом к метаданным» в Руководстве разработчика AWS Lake Formation.

Вывод

LFTagOnDatabase -> (список)

Список LF-меток, применённых к ресурсу базы данных.

(структура)

Структура, содержащая пару «ключ-значение» LF-метки.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашей средой Lake Formation.

TagKey -> (строка)

Имя ключа LF-метки.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

(строка)

LFTagsOnTable -> (список)

Список LF-меток, применённых к ресурсу таблицы.

(структура)

Структура, содержащая пару «ключ-значение» LF-метки.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашей средой Lake Formation.

TagKey -> (строка)

Имя ключа LF-метки.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

(строка)

LFTagsOnColumns -> (список)

Список LF-меток, применённых к ресурсу столбца.

(структура)

Структура, содержащая имя ресурса столбца и прикреплённые к нему LF-метки.

Name -> (строка)

Имя ресурса столбца.

LFTags -> (список)

LF-метки, прикреплённые к ресурсу столбца.

(структура)

Структура, содержащая пару «ключ-значение» LF-метки.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учётной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, таблиц и другую управляющую информацию для управления вашей средой Lake Formation.

TagKey -> (строка)

Имя ключа LF-метки.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API