Spec-Zone.ru › AWS CLI v2

[ aws . lakeformation ]

Список подключённых к Lake Formation ресурсов и принципалов

Описание

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

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

Синтаксис

  list-lake-formation-opt-ins
[--principal <value>]
[--resource <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--principal (структура)

Принципал Lake Formation. Поддерживаются IAM пользователи или IAM роли.

DataLakePrincipalIdentifier -> (строка)

Идентификатор принципала Lake Formation.

Сокращённый синтаксис:

DataLakePrincipalIdentifier=string

Синтаксис JSON:

{
  "DataLakePrincipalIdentifier": "string"
}

--resource (структура)

Структура для ресурса.

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

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

Id -> (строка)

Идентификатор ресурса каталога.

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

База данных для ресурса. Уникальна для Data Catalog. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для принципала.

CatalogId -> (строка)

Идентификатор Data Catalog. По умолчанию, идентификатор учётной записи вызывающего.

Name -> (строка)

Название ресурса базы данных. Уникально для Data Catalog.

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

Таблица для ресурса. Таблица — это определение метаданных, представляющее ваши данные. Вы можете предоставлять и отзывать права доступа на таблицу для принципала.

CatalogId -> (строка)

Идентификатор Data Catalog. По умолчанию, идентификатор учётной записи вызывающего.

DatabaseName -> (строка)

Имя базы данных для таблицы. Уникально для Data Catalog. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для принципала.

Name -> (строка)

Имя таблицы.

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

Знак подстановки, представляющий все таблицы в базе данных.

Требуется хотя бы один из TableResource$Name или TableResource$TableWildcard.

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

Таблица со столбцами для ресурса. Принципал с разрешениями на этот ресурс может выбирать метаданные из столбцов таблицы в Data Catalog и основополагающие данные в Amazon S3.

CatalogId -> (строка)

Идентификатор Data Catalog. По умолчанию, идентификатор учётной записи вызывающего.

DatabaseName -> (строка)

Имя базы данных для ресурса таблицы со столбцами. Уникально для Data Catalog. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для принципала.

Name -> (строка)

Имя ресурса таблицы. Таблица — это определение метаданных, представляющее ваши данные. Вы можете предоставлять и отзывать права доступа на таблицу для принципала.

ColumnNames -> (список)

Список имён столбцов таблицы. Требуется хотя бы один из ColumnNames или ColumnWildcard.

(строка)

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

Знак подстановки, заданный объектом ColumnWildcard. Требуется хотя бы один из ColumnNames или ColumnWildcard.

ExcludedColumnNames -> (список)

Исключает имена столбцов. Любой столбец с таким именем будет исключён.

(строка)

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

Расположение пути Amazon S3, где предоставляются или отзываются разрешения.

CatalogId -> (строка)

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

ResourceArn -> (строка)

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

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

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

TableCatalogId -> (строка)

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

DatabaseName -> (строка)

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

TableName -> (строка)

Имя таблицы.

Name -> (строка)

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

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

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

CatalogId -> (строка)

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

TagKey -> (строка)

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

TagValues -> (список)

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

(строка)

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

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

CatalogId -> (строка)

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

ResourceType -> (строка)

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

Expression -> (список)

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

(структура)

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

TagKey -> (строка)

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

TagValues -> (список)

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

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

(строка)

ExpressionName -> (строка)

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

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

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

CatalogId -> (строка)

Идентификатор Data Catalog. По умолчанию, идентификатор учётной записи.

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

--max-results (целое число)

Максимальное количество результатов для возврата.

--next-token (строка)

Маркер продолжения, если это не первый вызов для получения этого списка.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

LakeFormationOptInsInfoList -> (список)

Список пар «главный ресурс», для которых принудительно применяются разрешения Lake Formation.

(структура)

Одна пара «главный ресурс», для которой принудительно применяются разрешения Lake Formation.

Ресурс -> (структура)

Структура для ресурса.

Каталог -> (структура)

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

Id -> (строка)

Идентификатор ресурса каталога.

База данных -> (структура)

База данных для ресурса. Уникальна для каталога данных. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для субъекта.

CatalogId -> (строка)

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

Имя -> (строка)

Имя ресурса базы данных. Уникально для каталога данных.

Таблица -> (структура)

Таблица для ресурса. Таблица — это определение метаданных, представляющее ваши данные. Вы можете предоставлять и отзывать привилегии на таблицу для субъекта.

CatalogId -> (строка)

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

Имя базы данных -> (строка)

Имя базы данных для таблицы. Уникально для каталога данных. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать привилегии на базу данных для субъекта.

Имя -> (строка)

Имя таблицы.

Таблица с подстановочным знаком -> (структура)

Объект подстановки, представляющий все таблицы в базе данных.

Необходимо указать хотя бы один из TableResource$Name или TableResource$TableWildcard.

Таблица со столбцами -> (структура)

Таблица со столбцами для ресурса. Субъект с разрешениями на этот ресурс может выбрать метаданные из столбцов таблицы в каталоге данных и базовые данные в Amazon S3.

CatalogId -> (строка)

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

Имя базы данных -> (строка)

Имя базы данных для ресурса таблицы со столбцами. Уникально для каталога данных. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать привилегии на базу данных для субъекта.

Имя -> (строка)

Имя ресурса таблицы. Таблица — это определение метаданных, представляющее ваши данные. Вы можете предоставлять и отзывать привилегии на таблицу для субъекта.

Имена столбцов -> (список)

Список имен столбцов для таблицы. Необходимо указать хотя бы один из ColumnNames или ColumnWildcard.

(строка)

Столбец с подстановочным знаком -> (структура)

Подстановка, определяемая объектом ColumnWildcard. Необходимо указать хотя бы один из ColumnNames или ColumnWildcard.

Исключенные имена столбцов -> (список)

Исключает имена столбцов. Любой столбец с этим именем будет исключен.

(строка)

Расположение данных -> (структура)

Расположение пути Amazon S3, где предоставляются или отзываются разрешения.

CatalogId -> (строка)

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

ResourceArn -> (строка)

Уникальный Amazon Resource Name (ARN) ресурса расположения данных.

Фильтр данных -> (структура)

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

CatalogId таблицы -> (строка)

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

Имя базы данных -> (строка)

База данных в каталоге данных Glue.

Имя таблицы -> (строка)

Имя таблицы.

Имя -> (строка)

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

LF-метка -> (структура)

Ключ и значения LF-метки, прикрепленные к ресурсу.

CatalogId -> (строка)

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

Ключ метки -> (строка)

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

Значения меток -> (список)

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

(строка)

Политика LF-меток -> (структура)

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

CatalogId -> (строка)

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

Тип ресурса -> (строка)

Тип ресурса, на который распространяется политика LF-меток.

Выражение -> (список)

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

(структура)

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

Ключ метки -> (строка)

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

Значения меток -> (список)

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

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

(строка)

Имя выражения -> (строка)

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

Выражение LF-меток -> (структура)

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

CatalogId -> (строка)

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

Имя -> (строка)

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

Субъект -> (структура)

Субъект Lake Formation. Поддерживаемые субъекты — пользователи IAM или роли IAM.

Идентификатор субъекта DataLake -> (строка)

Идентификатор субъекта Lake Formation.

Условие -> (структура)

Условие Lake Formation, которое применяется к разрешениям и подпискам, содержащим выражение.

Выражение -> (строка)

Выражение, написанное на языке Cedar Policy Language, используемое для сопоставления атрибутов субъекта.

Изменено -> (временная метка)

Дата и время последнего изменения записи.

Изменено пользователем -> (строка)

Пользователь, который обновил запись.

NextToken -> (строка)

Маркер продолжения, если это не первый вызов для получения этого списка.

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

Spec-Zone.ru

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