标记 API - Amazon Lake Formation
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

标记 API

标记 API 描述了与定义属性或键值对标签的权限模型的授权策略相关的数据类型和 API。

数据类型

Tag 结构

LF-tag 键值对的结构。

字段

  • key – UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。

    LF 标签的钥匙。

  • value – UTF-8 字符串,不超过 256 个字节。

    LF-Tag 的值。

LftagKey 资源结构

包含 LF-tag 键和资源值的结构。

字段

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与匹配。Single-line string pattern.

    lf-tag 的键名。

  • TagValues:必需 — UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    属性可以获取的值列表。

LFTAG 策略资源结构

包含适用于资源的 LF-tag 策略的 LF-tag 条件列表的结构。

字段

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • ResourceType:必需 :UTF-8 字符串(有效值:DATABASE|TABLE)。

    LF-tag 策略适用的资源类型。

  • Expression:必需 数组lfTag对象,不少于 1 个或不超过 5 个结构。

    适用于资源的 LF-tag 策略的 LF-tag 条件列表。

TagedStable 结构

描述带有 LF-Tags 的表资源的结构。

字段

  • Table – 一个 TableResource 对象。

    附加了 LF 标签的表。

  • LFTagOnDatabase— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    附加到表所在数据库的 LF-Tags 列表。

  • LFTagsOnTable— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    附加到表格的 LF 标签列表。

  • LFTagsOnColumnsColumlFTag 对象的数组。

    附加到表中列的 LF 标签列表。

Tags 数据库结构

用 lf-Tags 描述数据库资源的结构。

字段

  • Database – 一个 DatabaseResource 对象。

    附加了 LF 标签的数据库。

  • LFTags— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    附加到数据库的 LF 标签列表。

LfTag 结构

允许管理员在特定条件下授予用户权限的结构。例如,授予角色访问具有 LF-Tag 'Prod 的表中没有 LF-Tag “PII” 的所有列的权限。

字段

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    lf-tag 的键名。

  • TagValues:必需 — UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    属性可以获取的值列表。

LftagPair 结构

包含 LF-tag 键值对的结构。

字段

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    lf-tag 的键名。

  • TagValues:必需 — UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    属性可以获取的值列表。

LftagFtagCrror 结构

包含与TagResource要么UnTagResourceoperation.

字段

  • LFTag – 一个 lftagPair 对象。

    lf-tag 的键名。

  • Error – 一个 ErrorDetail 对象。

    LF-Tag 的附件或分离时发生的错误。

ColumlFTag 结构

包含列资源名称及其附加的 LF 标签的结构。

字段

  • Name – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    列资源的名称。

  • LFTags— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    附加到列资源的 LF 标签。

操作

Addlftag 到资源操作(Python:add_lf_tags_to_资源)

将一个或多个 LF 标签附加到现有资源。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • Resource:必需 一个 资源 对象。

    要附加 LF-Tag 的数据库、表或列资源。

  • LFTags:必需 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    要附加到资源的 LF 标签。

响应

  • Failureslftag 错误 对象的数组。

    标记资源的失败列表。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

  • ConcurrentModificationException

从资源操作中删除 FTags(Python:remove_lf_tags_resource)

从资源中删除 LF-Tag。只允许使用数据库、表或 tableWhwitColumn 资源。要标记列,请使用中的列包含列表tableWithColumns以指定列输入。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • Resource:必需 一个 资源 对象。

    要删除 LF-Tag 的数据库、表或列资源。

  • LFTags:必需 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    要从资源中删除的 LF 标签。

响应

  • Failureslftag 错误 对象的数组。

    取消标记资源的失败列表。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • AccessDeniedException

  • ConcurrentModificationException

GetResourceFTags 操作(Python:get_resource_lf_tags)

返回应用于资源的 LF 标签。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • Resource:必需 一个 资源 对象。

    要返回 LF-Tags 的数据库、表或列资源。

  • ShowAssignedLFTags – 布尔值。

    指示是否显示分配的 LF 标签。

响应

  • LFTagOnDatabase— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    应用于数据库资源的 LF 标签列表。

  • LFTagsOnTable— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    应用于表资源的 LF 标签列表。

  • LFTagsOnColumnsColumlFTag 对象的数组。

    应用于列资源的 LF 标签列表。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • AccessDeniedException

ListLfTags 操作(Python:list_lf_tags)

列出请求者有权查看的 LF 标签。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • ResourceShareType – UTF-8 字符串(有效值:FOREIGN | ALL)。

    如果资源共享类型为ALL,返回请求者有权查看的账户内 LF 标签和共享 LF 标签。如果资源共享类型为FOREIGN,返回请求者可以查看的所有共享 LF 标签。如果没有通过资源共享类型,请求者有权查看的给定目录 ID 中列出 LF-Tags。

  • MaxResults – 数字(整数),不小于 1 或大于 1000。

    要返回的最大结果数量。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这不是检索此列表的第一个调用)。

响应

  • LFTags— 数组lftagPair对象,不少于 1 个或不超过 50 个结构。

    请求有权查看的 LF 标签列表。

  • NextToken – UTF-8 字符串。

    延续令牌 (如果当前列表片段不是最后一个,则呈现)。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

CreateFTag 操作(Python:create_lf_tag)

使用指定的名称和值创建 LF-tag。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    lf-tag 的键名。

  • TagValues:必需 — UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    属性可以获取的值列表。

响应

  • 无响应参数。

错误

  • EntityNotFoundException

  • InvalidInputException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

getLfTag 操作(Python:get_lf_tag)

返回 lf-tag 定义。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    lf-tag 的键名。

响应

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey – UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与 Custom string pattern #9 匹配。

    lf-tag 的键名。

  • TagValues— UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    属性可以获取的值列表。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

UpdateLfTag 操作(Python:update_lf_tag)

更新指定 LF-Tag 键的可能值列表。如果 LF-Tag 不存在,该操作将抛出 EntityNotFoundException。删除键值中的值将从可能值列表中删除。如果删除键值中的任何值附加到资源,则 API 会出错并出现 400 例外-“不允许更新”。在删除 lf-tag 键的值之前取消标记属性。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    要为其添加或删除值的 LF-tag 的键名称。

  • TagValuesToDelete— UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    要从 LF-Tag 中删除的 LF-Tag 值的列表。

  • TagValuesToAdd— UTF-8 字符串数组,不少于 1 个或不超过 50 个字符串。

    要从 LF-tag 中添加的 lf-tag 值的列表。

响应

  • 无响应参数。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

  • AccessDeniedException

DeleteFTag 操作(Python:delete_lf_tag)

删除指定的 lf-tag 密钥名称。如果属性键不存在或 LF-Tag 不存在,则操作将不会执行任何操作。如果属性键存在,则操作将检查是否有资源标记为此属性键,如果是,API 会抛出 400 例外,并显示 “不允许删除” 消息,因为 LF-Tag 键仍附有资源。您可以考虑使用此 LF-tag 密钥取消标记资源。

请求

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • TagKey:必需 — UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节,与匹配。Custom string pattern #9.

    要删除的 LF-Tag 的键名。

响应

  • 无响应参数。

错误

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

SearchTablebylfTags 操作(Python:search_table _by_lf_tags)

此操作允许搜索TABLE资源LFTag。这将由想要授予用户对某些 LF-Tags 的权限的管理员使用。在获得补助之前,管理员可以使用SearchTablesByLFTags找到给定的所有资源LFTags 对于验证返回的资源是否可以共享是否有效。

请求

  • NextToken – UTF-8 字符串。

    延续标记 (如果这不是检索此列表的第一个调用)。

  • MaxResults – 数字(整数),不小于 1 或大于 1000。

    要返回的最大结果数量。

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • Expression:必需 数组lfTag对象,不少于 1 个或不超过 5 个结构。

    条件的列表 (LFTag结构)以在表资源中搜索。

响应

  • NextToken – UTF-8 字符串。

    延续令牌 (如果当前列表片段不是最后一个,则呈现)。

  • TableList标记表 对象的数组。

    满足 LF-Tag 条件的表的列表。

错误

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • OperationTimeoutException

  • GlueEncryptionException

  • AccessDeniedException

SearchDatabesbylfTags 操作(Python:search_databases_by_lf_tags)

此操作允许搜索DATABASE资源TagCondition. 想要授予用户对某些特定权限的管理员使用此操作TagConditions. 在获得补助之前,管理员可以使用SearchDatabasesByTags找到给定的所有资源TagConditions用于验证返回的资源是否可以共享。

请求

  • NextToken – UTF-8 字符串。

    延续标记 (如果这不是检索此列表的第一个调用)。

  • MaxResults – 数字(整数),不小于 1 或大于 1000。

    要返回的最大结果数量。

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    数据目录的标识符。默认情况下,账户 ID。数据目录是持久性元数据存储。它包含数据库定义、表定义以及其他用于管理您的控制信息。Amazon Lake Formation一个环境。

  • Expression:必需 数组lfTag对象,不少于 1 个或不超过 5 个结构。

    条件的列表 (LFTag结构)以在数据库资源中搜索。

响应

  • NextToken – UTF-8 字符串。

    延续令牌 (如果当前列表片段不是最后一个,则呈现)。

  • DatabaseList标记数据库 对象的数组。

    满足 LF-Tag 条件的数据库列表。

错误

  • EntityNotFoundException

  • InternalServiceException

  • InvalidInputException

  • OperationTimeoutException

  • GlueEncryptionException

  • AccessDeniedException