标记 Systems Manager 文档

本节主题介绍如何在 Systems Manager 文档（SSM 文档）上使用标签。

创建带标签的文档

您可以在创建自定义 SSM 文档时，向它们添加标签。

有关信息，请参阅以下主题：

• 创建 SSM 文档（控制台）

• 创建 SSM 文档（命令行）

向现有文档添加标签

您可以使用 Systems Manager 控制台或命令行向您拥有的自定义 SSM 文档添加标签。

主题

• 向现有 SSM 文档添加标签（控制台）
• 向现有 SSM 文档添加标签（命令行）

向现有 SSM 文档添加标签（控制台）

1. 访问 https://console.aws.amazon.com/systems-manager/，打开 AWS Systems Manager 控制台。

2. 在导航窗格中，选择 文档。

   -或者-

   如果首先打开 AWS Systems Manager 主页，选择菜单图标（ ）打开导航窗格，然后在导航窗格中选择文档。

3. 选择 我拥有的选项卡。

4. 选择要添加标签的文档的名称，然后选择详细信息选项卡。

5. 在标签部分中，选择编辑，然后添加一个或多个键值标签对。

6. 选择保存。

向现有 SSM 文档添加标签（命令行）

向现有 SSM 文档添加标签（命令行）

1. 通过使用首选命令行工具，运行以下命令来查看您可以标记的文档的列表。

   Linux & macOS

   aws ssm list-documents

   Windows

   aws ssm list-documents

   PowerShell

   Get-SSMDocumentList

   记下要标记的文档的名称。

2. 运行以下命令以标记文档。将每个示例资源占位符替换为您自己的信息。

   Linux & macOS

   aws ssm add-tags-to-resource \
       --resource-type "Document" \
       --resource-id "document-name" \
       --tags "Key=tag-key,Value=tag-value"

   Windows

   aws ssm add-tags-to-resource ^
       --resource-type "Document" ^
       --resource-id "document-name" ^
       --tags "Key=tag-key,Value=tag-value"

   PowerShell

   $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag

   $tag.Key = "tag-key"

   $tag.Value = "tag-value"

   Add-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name" `
       -Tag $tag `
       -Force

   如果成功，则命令没有输出。

3. 执行以下命令，以验证文档标签。

   Linux & macOS

   aws ssm list-tags-for-resource \
       --resource-type "Document" \
       --resource-id "document-name"

   Windows

   aws ssm list-tags-for-resource ^
       --resource-type "Document" ^
       --resource-id "document-name"

   PowerShell

   Get-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name"

从 SSM 文档中删除标签

您可以使用 Systems Manager 控制台或命令行从 SSM 文档中删除标签。

主题

• 从 SSM 文档中删除标签（控制台）
• 从 SSM 文档中删除标签（命令行）

从 SSM 文档中删除标签（控制台）

1. 访问 https://console.aws.amazon.com/systems-manager/，打开 AWS Systems Manager 控制台。

2. 在导航窗格中，选择 文档。

   -或者-

   如果首先打开 AWS Systems Manager 主页，选择菜单图标（ ）打开导航窗格，然后在导航窗格中选择文档。

3. 选择 我拥有的选项卡。

4. 选择要从中删除标签的文档的名称，然后选择详细信息选项卡。

5. 在标签部分中，选择编辑，然后选择不再需要的标签对旁边的删除。

6. 选择保存。

从 SSM 文档中删除标签（命令行）

1. 通过使用首选命令行工具，运行以下命令列出您账户中的文档。

   Linux & macOS

   aws ssm list-documents

   Windows

   aws ssm list-documents

   PowerShell

   Get-SSMDocumentList

   记下要从中删除标签的文档的名称。

2. 运行以下命令从文档中删除标签。将每个示例资源占位符替换为您自己的信息。

   Linux & macOS

   aws ssm remove-tags-from-resource \
       --resource-type "Document" \
       --resource-id "document-name" \
       --tag-key "tag-key"

   Windows

   aws ssm remove-tags-from-resource ^
       --resource-type "Document" ^
       --resource-id "document-name" ^
       --tag-key "tag-key"

   PowerShell

   Remove-SSMResourceTag `
       -ResourceId "document-name" `
       -ResourceType "Document" `
       -TagKey "tag-key" `
       -Force

   如果成功，则命令没有输出。

3. 执行以下命令，以验证文档标签。

   Linux & macOS

   aws ssm list-tags-for-resource \
       --resource-type "Document" \
       --resource-id "document-name"

   Windows

   aws ssm list-tags-for-resource ^
       --resource-type "Document" ^
       --resource-id "document-name"

   PowerShell

   Get-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name"