使用 API 操作管理 CMK 标签 - AWS Key Management Service
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

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

使用 API 操作管理 CMK 标签

您可以使用AWS Key Management Service vices (AWS KMS) API来添加、删除和列出您管理的 CMK 的标签。这些示例使用AWS 命令行界面 (AWS CLI),但您可以使用任何受支持的编程语言。您无法为 AWS 管理的 CMK 添加标签。

要为 CMK 添加、编辑、查看和删除标签,您必须具有所需的权限。有关详细信息,请参阅 控制对标签的访问

CreateKey:向新 CMK 添加标签

您可以在创建客户托管 CMK 时添加标签。要指定标签,请使用Tags的参数CreateKeyoperation.

要在创建 CMK 时添加标签,调用者必须具有kms:TagResource权限。至少,权限必须覆盖账户和区域中的所有 CMK。有关详细信息,请参阅 控制对标签的访问

的值Tags的参数CreateKey是区分大小写的标签键和标签值对的集合。CMK 上的每个标签都必须具有不同的标签名称。标签值可以是空字符串或空字符串。

例如,以下 AWS CLI 命令创建具有Project:Alpha标签。指定多个键值对时,请使用空格分隔每个对。

$ aws kms create-key --tags TagKey=Project,TagValue=Alpha

当此命令成功时,它会返回一个 KeyMetadata 对象以及有关新 CMK 的信息。但是,KeyMetadata 不包括标签。要获取标签,请使用 ListResourceTags 操作。

TagResource:为 CMK 添加或更改标签

TagResource 操作会向 CMK 添加一个或多个标签。您不能使用此操作在不同的 AWS 账户添加或编辑标签。

要添加标签,请指定新的标签键和标签值。要编辑标签,请指定现有标签键和新标签值。CMK 上的每个标签都必须具有不同的标签键。标签值可以是空字符串或空字符串。

例如,以下命令将 PurposeDepartment 标签添加到示例 CMK 中。

$ aws kms tag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tags TagKey=Purpose,TagValue=Pretest TagKey=Department,TagValue=Finance

此命令成功执行后,不会返回任何输出。要查看 CMK 上的标签,请使用 ListResourceTags 操作。

您还可以使用 TagResource来更改现有标签的标签值。要替换标签值,请指定具有不同值的相同标签键。

例如,此命令会更改Purpose标签自标签PretestTest

$ aws kms tag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tags TagKey=Purpose,TagValue=Test

ListResourceTags:获取 CMK 的标签

ListResourceTags 操作会获取 CMK 的标签。KeyId 参数是必需的。您不能使用此操作查看不同 AWS 账户中的 CMK 上的标签。

例如,以下命令获取示例 CMK 的标签。

$ aws kms list-resource-tags --key-id 1234abcd-12ab-34cd-56ef-1234567890ab "Truncated": false, "Tags": [ { "TagKey": "Project", "TagValue": "Alpha" }, { "TagKey": "Purpose", "TagValue": "Test" }, { "TagKey": "Department", "TagValue": "Finance" } ] }

UntagResource:删除 CMK 中的标签标签

UntagResource 操作会从 CMK 中删除标签。要标识要删除的标签,请指定标签键。您不能使用此操作从不同的 AWS 账户删除标签。

当它成功时,UntagResource操作不返回任何输出。另外,如果在 CMK 上找不到指定的标签键,它不会抛出异常或返回响应。若要确认操作是否正常工作,请使用ListResourceTagsoperation.

例如,此命令删除Purpose标签及其值来自指定 CMK。

$ aws kms untag-resource --key-id 1234abcd-12ab-34cd-56ef-1234567890ab --tag-keys Purpose