

文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。

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

# 使用 Resource Groups 的代码示例 AWS SDKs
<a name="resource-groups_code_examples"></a>

以下代码示例向您展示了如何 AWS Resource Groups 使用 AWS 软件开发套件 (SDK)。

*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

**更多资源**
+  **[ Resource Groups 用户指南](https://docs.aws.amazon.com/ARG/latest/userguide/resource-groups.html)**——有关 Resource Groups 的更多信息。
+ **[Resource Groups API 参考](https://docs.aws.amazon.com/ARG/latest/APIReference/Welcome.html)**——所有可用 Resource Groups 操作的详细信息。
+ **[AWS 开发者中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** — 您可以按类别或全文搜索筛选的代码示例。
+ **[AWS SDK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)** — 包含首选语言完整代码的 GitHub 存储库。包括有关设置和运行代码的说明。

**Contents**
+ [基本功能](resource-groups_code_examples_basics.md)
  + [操作](resource-groups_code_examples_actions.md)
    + [`CreateGroup`](resource-groups_example_resource-groups_CreateGroup_section.md)
    + [`DeleteGroup`](resource-groups_example_resource-groups_DeleteGroup_section.md)
    + [`GetGroup`](resource-groups_example_resource-groups_GetGroup_section.md)
    + [`GetGroupQuery`](resource-groups_example_resource-groups_GetGroupQuery_section.md)
    + [`GetTags`](resource-groups_example_resource-groups_GetTags_section.md)
    + [`ListGroupResources`](resource-groups_example_resource-groups_ListGroupResources_section.md)
    + [`ListGroups`](resource-groups_example_resource-groups_ListGroups_section.md)
    + [`SearchResources`](resource-groups_example_resource-groups_SearchResources_section.md)
    + [`Tag`](resource-groups_example_resource-groups_Tag_section.md)
    + [`Untag`](resource-groups_example_resource-groups_Untag_section.md)
    + [`UpdateGroup`](resource-groups_example_resource-groups_UpdateGroup_section.md)
    + [`UpdateGroupQuery`](resource-groups_example_resource-groups_UpdateGroupQuery_section.md)

# 使用 Resource Groups 的基本示例 AWS SDKs
<a name="resource-groups_code_examples_basics"></a>

以下代码示例说明如何使用 with 的基础 AWS Resource Groups 知识 AWS SDKs。

**Contents**
+ [操作](resource-groups_code_examples_actions.md)
  + [`CreateGroup`](resource-groups_example_resource-groups_CreateGroup_section.md)
  + [`DeleteGroup`](resource-groups_example_resource-groups_DeleteGroup_section.md)
  + [`GetGroup`](resource-groups_example_resource-groups_GetGroup_section.md)
  + [`GetGroupQuery`](resource-groups_example_resource-groups_GetGroupQuery_section.md)
  + [`GetTags`](resource-groups_example_resource-groups_GetTags_section.md)
  + [`ListGroupResources`](resource-groups_example_resource-groups_ListGroupResources_section.md)
  + [`ListGroups`](resource-groups_example_resource-groups_ListGroups_section.md)
  + [`SearchResources`](resource-groups_example_resource-groups_SearchResources_section.md)
  + [`Tag`](resource-groups_example_resource-groups_Tag_section.md)
  + [`Untag`](resource-groups_example_resource-groups_Untag_section.md)
  + [`UpdateGroup`](resource-groups_example_resource-groups_UpdateGroup_section.md)
  + [`UpdateGroupQuery`](resource-groups_example_resource-groups_UpdateGroupQuery_section.md)

# 使用 Resource Groups 执行的操作 AWS SDKs
<a name="resource-groups_code_examples_actions"></a>

以下代码示例演示了如何使用执行各个 Resource Groups 操作 AWS SDKs。每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关设置和运行代码的说明。

 以下示例仅包括最常用的操作。有关完整列表，请参阅 [AWS Resource Groups API 参考](https://docs.aws.amazon.com/ARG/latest/APIReference/Welcome.html)。

**Topics**
+ [`CreateGroup`](resource-groups_example_resource-groups_CreateGroup_section.md)
+ [`DeleteGroup`](resource-groups_example_resource-groups_DeleteGroup_section.md)
+ [`GetGroup`](resource-groups_example_resource-groups_GetGroup_section.md)
+ [`GetGroupQuery`](resource-groups_example_resource-groups_GetGroupQuery_section.md)
+ [`GetTags`](resource-groups_example_resource-groups_GetTags_section.md)
+ [`ListGroupResources`](resource-groups_example_resource-groups_ListGroupResources_section.md)
+ [`ListGroups`](resource-groups_example_resource-groups_ListGroups_section.md)
+ [`SearchResources`](resource-groups_example_resource-groups_SearchResources_section.md)
+ [`Tag`](resource-groups_example_resource-groups_Tag_section.md)
+ [`Untag`](resource-groups_example_resource-groups_Untag_section.md)
+ [`UpdateGroup`](resource-groups_example_resource-groups_UpdateGroup_section.md)
+ [`UpdateGroupQuery`](resource-groups_example_resource-groups_UpdateGroupQuery_section.md)

# 将 `CreateGroup` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_CreateGroup_section"></a>

以下代码示例演示如何使用 `CreateGroup`。

------
#### [ CLI ]

**AWS CLI**  
**示例 1：创建基于标签的资源组**  
以下 `create-group` 示例在当前区域中创建 Amazon EC2 实例的基于标签的资源组。它基于使用键 `Name` 和值 `WebServers` 标记的资源的查询。日志组为 `tbq-WebServer`。该查询在传递给命令的单独 JSON 文件中。  

```
aws resource-groups create-group \
    --name tbq-WebServer \
    --resource-query file://query.json
```
`query.json` 的内容：  

```
{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}
```
**示例 2：创建 CloudFormation 基于堆栈的资源组**  
以下`create-group`示例创建了一个名为的 AWS CloudFormation 基于堆栈的资源组。`sampleCFNstackgroup`该查询包括指定 CloudFormation 堆栈中所有受 Resource Group AWS s 支持的资源。  

```
aws resource-groups create-group \
    --name cbq-CFNstackgroup \
    --resource-query file://query.json
```
`query.json` 的内容：  

```
{
    "Type": "CLOUDFORMATION_STACK_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
}
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'
    }
}
```
有关更多信息，请参阅《AWS 用户指南》**中的[创建组](https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/create-group.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例创建了一个名 TestPowerShellGroup为的基于标签的新资源组 Resource Groups AWS 资源组。该组包括当前区域中使用标签键“Name”和标签值“test2”标记的 Amazon EC2 实例。该命令返回组的查询和类型以及操作结果。**  

```
$ResourceQuery = New-Object -TypeName Amazon.ResourceGroups.Model.ResourceQuery
$ResourceQuery.Type = "TAG_FILTERS_1_0"
$ResourceQuery.Query = '{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]}'
$ResourceQuery

New-RGGroup -Name TestPowerShellGroup -ResourceQuery $ResourceQuery -Description "Test resource group."
```
**输出**：  

```
Query                                                                                           Type           
-----                                                                                           ----           
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]} TAG_FILTERS_1_0

LoggedAt         : 11/20/2018 2:40:59 PM
Group            : Amazon.ResourceGroups.Model.Group
ResourceQuery    : Amazon.ResourceGroups.Model.ResourceQuery
Tags             : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength    : 338
HttpStatusCode   : OK
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [CreateGroup](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例创建了一个名 TestPowerShellGroup为的基于标签的新资源组 Resource Groups AWS 资源组。该组包括当前区域中使用标签键“Name”和标签值“test2”标记的 Amazon EC2 实例。该命令返回组的查询和类型以及操作结果。**  

```
$ResourceQuery = New-Object -TypeName Amazon.ResourceGroups.Model.ResourceQuery
$ResourceQuery.Type = "TAG_FILTERS_1_0"
$ResourceQuery.Query = '{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]}'
$ResourceQuery

New-RGGroup -Name TestPowerShellGroup -ResourceQuery $ResourceQuery -Description "Test resource group."
```
**输出**：  

```
Query                                                                                           Type           
-----                                                                                           ----           
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]} TAG_FILTERS_1_0

LoggedAt         : 11/20/2018 2:40:59 PM
Group            : Amazon.ResourceGroups.Model.Group
ResourceQuery    : Amazon.ResourceGroups.Model.ResourceQuery
Tags             : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength    : 338
HttpStatusCode   : OK
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `DeleteGroup` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_DeleteGroup_section"></a>

以下代码示例演示如何使用 `DeleteGroup`。

------
#### [ CLI ]

**AWS CLI**  
**更新资源组的描述**  
以下 `delete-group` 示例更新了指定资源组。  

```
aws resource-groups delete-group \
    --group-name tbq-WebServer
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:1234567890:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    }
}
```
有关更多信息，请参阅《AWS 用户指南》**中的[删除组](https://docs.aws.amazon.com/ARG/latest/userguide/deleting-resource-groups.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/delete-group.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例移除指定的资源组**  

```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**输出**：  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGGroup (DeleteGroup)" on target "non-tag-cfn-elbv2".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

Description GroupArn                                                               Name
----------- --------                                                               ----
            arn:aws:resource-groups:eu-west-1:123456789012:group/non-tag-cfn-elbv2 non-tag-cfn-elbv2
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DeleteGroup](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例移除指定的资源组**  

```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**输出**：  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGGroup (DeleteGroup)" on target "non-tag-cfn-elbv2".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

Description GroupArn                                                               Name
----------- --------                                                               ----
            arn:aws:resource-groups:eu-west-1:123456789012:group/non-tag-cfn-elbv2 non-tag-cfn-elbv2
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `GetGroup` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_GetGroup_section"></a>

以下代码示例演示如何使用 `GetGroup`。

------
#### [ CLI ]

**AWS CLI**  
**获取有关资源组的信息**  
以下 `get-group` 示例显示了有关指定资源组的详细信息。要将查询附加到群组，请使用 `get-group-query`。  

```
aws resource-groups get-group \
    --group-name tbq-WebServer
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer",
        "Description": "A tag-based query resource group of WebServers."
    }
}
```
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-group.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例按组名称检索资源组**  

```
Get-RGGroup -GroupName auto-no
```
**输出**：  

```
Description GroupArn                                                     Name
----------- --------                                                     ----
            arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [GetGroup](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例按组名称检索资源组**  

```
Get-RGGroup -GroupName auto-no
```
**输出**：  

```
Description GroupArn                                                     Name
----------- --------                                                     ----
            arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `GetGroupQuery` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_GetGroupQuery_section"></a>

以下代码示例演示如何使用 `GetGroupQuery`。

------
#### [ CLI ]

**AWS CLI**  
**将查询附加到资源组**  
以下 `get-group-query` 示例显示了附加到指定资源组的查询。  

```
aws resource-groups get-group-query \
    --group-name tbq-WebServer
```
输出：  

```
{
    "GroupQuery": {
        "GroupName": "tbq-WebServer",
        "ResourceQuery": {
            "Type": "TAG_FILTERS_1_0",
            "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
        }
    }
}
```
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetGroupQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-group-query.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例获取给定资源组的资源查询**  

```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**输出**：  

```
Query                                                                                        Type
-----                                                                                        ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [GetGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例获取给定资源组的资源查询**  

```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**输出**：  

```
Query                                                                                        Type
-----                                                                                        ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `GetTags` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_GetTags_section"></a>

以下代码示例演示如何使用 `GetTags`。

------
#### [ CLI ]

**AWS CLI**  
**检索附加到资源组的标签**  
以下 `get-tags` 示例显示了附加到指定资源组（组本身，而不是其成员）的标签键和值对。  

```
aws resource-groups get-tags \
    --arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer
```
输出：  

```
{
    "Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
    "Tags": {
        "QueryType": "tags",
        "QueryResources": "ec2-instances"
    }
}
```
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-tags.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例列出给定资源组 arn 的标签**  

```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**输出**：  

```
Key       Value
---       -----
Instances workboxes
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [GetTags](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例列出给定资源组 arn 的标签**  

```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**输出**：  

```
Key       Value
---       -----
Instances workboxes
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [GetTags](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `ListGroupResources` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_ListGroupResources_section"></a>

以下代码示例演示如何使用 `ListGroupResources`。

------
#### [ CLI ]

**AWS CLI**  
**列出资源组中的所有资源**  
示例 1：以下 `list-resource-groups` 示例列出了属于指定资源组的所有资源。  

```
aws resource-groups list-group-resources \
    --group-name tbq-WebServer
```
输出：  

```
{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-09f77fa38c12345ab",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}
```
示例 2：以下示例列出了组中“resource-type”也为“AWS::EC2::Instance”的所有资源。  
aws 资源组 list-group-resources--group-name tbq-WebServer --filters name=Resource-type，Values=:: EC2:: Instance AWS  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/list-group-resources.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例在按资源类型进行筛选的基础之上列出组资源**  

```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**输出**：  

```
ResourceArn                                                     ResourceType
-----------                                                     ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123bc45b567890e1 AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0a1caf2345f67d8dc AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0fd12dd3456789012 AWS::EC2::Instance
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ListGroupResources](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例在按资源类型进行筛选的基础之上列出组资源**  

```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**输出**：  

```
ResourceArn                                                     ResourceType
-----------                                                     ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123bc45b567890e1 AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0a1caf2345f67d8dc AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0fd12dd3456789012 AWS::EC2::Instance
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `ListGroups` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_ListGroups_section"></a>

以下代码示例演示如何使用 `ListGroups`。

------
#### [ CLI ]

**AWS CLI**  
**列出可用的资源组**  
以下 `list-groups` 示例显示了所有资源组的列表。  

```
aws resource-groups list-groups
```
输出：  

```
{
    "GroupIdentifiers": [
        {
            "GroupName": "tbq-WebServer",
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer3"
        },
        {
            "GroupName": "cbq-CFNStackQuery",
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNStackQuery"
        }
    ],
    "Groups": [
        {
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
            "Name": "tbq-WebServer"
        },
        {
            "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNStackQuery",
            "Name": "cbq-CFNStackQuery"
        }
    ]
}
```
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/list-groups.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例列出已创建的资源组。**  

```
Get-RGGroupList
```
**输出**：  

```
GroupArn                                                                  GroupName
--------                                                                  ---------
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no              auto-no
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes             auto-yes
arn:aws:resource-groups:eu-west-1:123456789012:group/build600             build600
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ListGroups](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例列出已创建的资源组。**  

```
Get-RGGroupList
```
**输出**：  

```
GroupArn                                                                  GroupName
--------                                                                  ---------
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no              auto-no
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes             auto-yes
arn:aws:resource-groups:eu-west-1:123456789012:group/build600             build600
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `SearchResources` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_SearchResources_section"></a>

以下代码示例演示如何使用 `SearchResources`。

------
#### [ CLI ]

**AWS CLI**  
**查找与查询相匹配的资源**  
以下`search-resources`示例检索与指定查询相匹配的所有 AWS 资源的列表。  

```
aws resource-groups search-resources \
    --resource-query file://query.json
```
`query.json` 的内容：  

```
{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Patch Group\", \"Values\":[\"Dev\"]}]}"
}
```
输出：  

```
{
    "ResourceIdentifiers": [
        {
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a23bc45d67890ef",
            "ResourceType": "AWS::EC2::Instance"
        }
    ]
}
```
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[SearchResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/search-resources.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例使用标签筛选器 ResourceQuery 创建 for Instance 资源类型并查找资源。**  

```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = ConvertTo-Json -Compress -Depth 4 -InputObject @{
  ResourceTypeFilters = @('AWS::EC2::Instance')
  TagFilters = @(@{
    Key = 'auto'
    Values = @('no')
  })
 }

Find-RGResource -ResourceQuery $query | Select-Object -ExpandProperty ResourceIdentifiers
```
**输出**：  

```
ResourceArn                                                     ResourceType
-----------                                                     ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [SearchResources](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例使用标签筛选器 ResourceQuery 创建 for Instance 资源类型并查找资源。**  

```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = ConvertTo-Json -Compress -Depth 4 -InputObject @{
  ResourceTypeFilters = @('AWS::EC2::Instance')
  TagFilters = @(@{
    Key = 'auto'
    Values = @('no')
  })
 }

Find-RGResource -ResourceQuery $query | Select-Object -ExpandProperty ResourceIdentifiers
```
**输出**：  

```
ResourceArn                                                     ResourceType
-----------                                                     ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [SearchResources](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `Tag` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_Tag_section"></a>

以下代码示例演示如何使用 `Tag`。

------
#### [ CLI ]

**AWS CLI**  
**将标签附加到资源组**  
以下 `tag` 示例将指定的标签键和值对附加到指定的资源组（组本身，而不是其成员）。  

```
aws resource-groups tag \
    --tags QueryType=tags,QueryResources=ec2-instances \
    --arn arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer
```
输出：  

```
{
    "Arn": "arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer",
    "Tags": {
        "QueryType": "tags",
        "QueryResources": "ec2-instances"
    }
}
```
有关更多信息，请参阅《AWS 资源组用户指南》**中的[管理标签](https://docs.aws.amazon.com/ARG/latest/userguide/tagging-resources.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [Tag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/tag.html)。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例向指定的资源组 arn 添加标签键“Instances”，其值为“workboxes”**  

```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**输出**：  

```
Arn                                                            Tags
---                                                            ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+  有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》**中的 [Tag](https://docs.aws.amazon.com/powershell/v4/reference)。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例向指定的资源组 arn 添加标签键“Instances”，其值为“workboxes”**  

```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**输出**：  

```
Arn                                                            Tags
---                                                            ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+  有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V5)》**中的 [Tag](https://docs.aws.amazon.com/powershell/v5/reference)。

------

# 将 `Untag` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_Untag_section"></a>

以下代码示例演示如何使用 `Untag`。

------
#### [ CLI ]

**AWS CLI**  
**从资源中删除标签**  
以下 `untags` 示例从资源组（而非其成员）中删除具有指定键的所有标签。  

```
aws resource-groups untag \
    --arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer \
    --keys QueryType
```
输出：  

```
{
    "Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
    "Keys": [
        "QueryType"
    ]
}
```
有关更多信息，请参阅《AWS 资源组用户指南》**中的[管理标签](https://docs.aws.amazon.com/ARG/latest/userguide/tagging-resources.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [Untag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/untag.html)。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例从资源组中移除提到的标签**  

```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**输出**：  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGResourceTag (Untag)" on target "arn:aws:resource-groups:eu-west-1:933303704102:group/workboxes".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

Arn                                                            Keys
---                                                            ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {Instances}
```
+  有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》**中的 [Untag](https://docs.aws.amazon.com/powershell/v4/reference)。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例从资源组中移除提到的标签**  

```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**输出**：  

```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGResourceTag (Untag)" on target "arn:aws:resource-groups:eu-west-1:933303704102:group/workboxes".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

Arn                                                            Keys
---                                                            ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {Instances}
```
+  有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V5)》**中的 [Untag](https://docs.aws.amazon.com/powershell/v5/reference)。

------

# 将 `UpdateGroup` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_UpdateGroup_section"></a>

以下代码示例演示如何使用 `UpdateGroup`。

------
#### [ CLI ]

**AWS CLI**  
**更新资源组的描述**  
以下 `update-group` 示例更新指定资源组的描述。  

```
aws resource-groups update-group \
    --group-name tbq-WebServer \
    --description "Resource group for all web server resources."
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
        "Description": "Resource group for all web server resources."
    }
}
```
有关更多信息，请参阅《AWS 资源组用户指南》**中的[更新组](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/update-group.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例更新组的描述**  

```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**输出**：  

```
Description             GroupArn                                                      Name
-----------             --------                                                      ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [UpdateGroup](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例更新组的描述**  

```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**输出**：  

```
Description             GroupArn                                                      Name
-----------             --------                                                      ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------

# 将 `UpdateGroupQuery` 与 CLI 配合使用
<a name="resource-groups_example_resource-groups_UpdateGroupQuery_section"></a>

以下代码示例演示如何使用 `UpdateGroupQuery`。

------
#### [ CLI ]

**AWS CLI**  
**示例 1：更新基于标签的资源组的查询**  
以下 `update-group-query` 示例更新了附加到基于指定标签的资源组的查询。  

```
aws resource-groups update-group-query \
    --group-name tbq-WebServer \
    --resource-query '{"Type":"TAG_FILTERS_1_0", "Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"}'
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}
```
有关更多信息，请参阅《AWS 资源组用户指南》**中的[更新组](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html)。  
**示例 2：更新 CloudFormation 基于堆栈的资源组的查询**  
以下`update-group-query`示例更新了附加到指定 AWS CloudFormation 基于堆栈的资源组的查询。  

```
aws resource-groups update-group-query \
    --group-name cbq-CFNstackgroup \
    --resource-query '{"Type": "CLOUDFORMATION_STACK_1_0", "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'
```
输出：  

```
{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
    }
}
```
有关更多信息，请参阅《AWS 资源组用户指南》**中的[更新组](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html)。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[UpdateGroupQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/update-group-query.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1：此示例创建一个查询对象并更新组的查询。**  

```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = @{
  ResourceTypeFilters = @('AWS::EC2::Instance')
  TagFilters = @(@{
  Key='Environment'
  Values='Build600.11'
  })
} | ConvertTo-Json -Compress -Depth 4

Update-RGGroupQuery -GroupName build600 -ResourceQuery $query
```
**输出**：  

```
GroupName ResourceQuery
--------- -------------
build600  Amazon.ResourceGroups.Model.ResourceQuery
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例创建一个查询对象并更新组的查询。**  

```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = @{
  ResourceTypeFilters = @('AWS::EC2::Instance')
  TagFilters = @(@{
  Key='Environment'
  Values='Build600.11'
  })
} | ConvertTo-Json -Compress -Depth 4

Update-RGGroupQuery -GroupName build600 -ResourceQuery $query
```
**输出**：  

```
GroupName ResourceQuery
--------- -------------
build600  Amazon.ResourceGroups.Model.ResourceQuery
```
+  有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------