There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for Resource Groups using AWS SDKs
The following code examples show you how to use AWS Resource Groups with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
**More resources**
+ **[ Resource Groups User Guide](https://docs.aws.amazon.com/ARG/latest/userguide/resource-groups.html)** – More information about Resource Groups.
+ **[Resource Groups API Reference](https://docs.aws.amazon.com/ARG/latest/APIReference/Welcome.html)** – Details about all available Resource Groups actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](resource-groups_code_examples_basics.md)
+ [Actions](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)
# Basic examples for Resource Groups using AWS SDKs
The following code examples show how to use the basics of AWS Resource Groups with AWS SDKs.
**Contents**
+ [Actions](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)
# Actions for Resource Groups using AWS SDKs
The following code examples demonstrate how to perform individual Resource Groups actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [AWS Resource Groups API Reference](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)
# Use `CreateGroup` with a CLI
The following code examples show how to use `CreateGroup`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a tag-based resource group**
The following `create-group` example creates a tag-based resource group of Amazon EC2 instances in the current region. It's based on a query for resources that are tagged with the key `Name`, and the value `WebServers`. The group name is `tbq-WebServer`. The query is in a separate JSON file that is passed to the command.
```
aws resource-groups create-group \
--name tbq-WebServer \
--resource-query file://query.json
```
Contents of `query.json`:
```
{
"Type": "TAG_FILTERS_1_0",
"Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}
```
Output:
```
{
"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\"]}]}"
}
}
```
**Example 2: To create a CloudFormation stack-based resource group**
The following `create-group` example creates an AWS CloudFormation stack-based resource group named `sampleCFNstackgroup`. The query includes all resources in the specified CloudFormation stack that are supported by AWS Resource Groups.
```
aws resource-groups create-group \
--name cbq-CFNstackgroup \
--resource-query file://query.json
```
Contents of `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\"}"
}
```
Output:
```
{
"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\"}"}'
}
}
```
For more information, see [Create Groups](https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/create-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a new tag-based AWS Resource Groups resource group named TestPowerShellGroup. The group includes Amazon EC2 instances in the current region that are tagged with the tag key "Name", and tag value "test2". The command returns the query and type of group, and the results of the operation.**
```
$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."
```
**Output:**
```
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
```
+ For API details, see [CreateGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a new tag-based AWS Resource Groups resource group named TestPowerShellGroup. The group includes Amazon EC2 instances in the current region that are tagged with the tag key "Name", and tag value "test2". The command returns the query and type of group, and the results of the operation.**
```
$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."
```
**Output:**
```
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
```
+ For API details, see [CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteGroup` with a CLI
The following code examples show how to use `DeleteGroup`.
------
#### [ CLI ]
**AWS CLI**
**To update the description for a resource group**
The following `delete-group` example updates the specified resource group.
```
aws resource-groups delete-group \
--group-name tbq-WebServer
```
Output:
```
{
"Group": {
"GroupArn": "arn:aws:resource-groups:us-west-2:1234567890:group/tbq-WebServer",
"Name": "tbq-WebServer"
}
}
```
For more information, see [Delete Groups](https://docs.aws.amazon.com/ARG/latest/userguide/deleting-resource-groups.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/delete-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example removes the named resource group**
```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**Output:**
```
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
```
+ For API details, see [DeleteGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example removes the named resource group**
```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**Output:**
```
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
```
+ For API details, see [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetGroup` with a CLI
The following code examples show how to use `GetGroup`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a resource group**
The following `get-group` example displays details about the specified resource group. To get the query attached to the group, use `get-group-query`.
```
aws resource-groups get-group \
--group-name tbq-WebServer
```
Output:
```
{
"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."
}
}
```
+ For API details, see [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example retrieves resource group as per the group name**
```
Get-RGGroup -GroupName auto-no
```
**Output:**
```
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+ For API details, see [GetGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example retrieves resource group as per the group name**
```
Get-RGGroup -GroupName auto-no
```
**Output:**
```
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+ For API details, see [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetGroupQuery` with a CLI
The following code examples show how to use `GetGroupQuery`.
------
#### [ CLI ]
**AWS CLI**
**To get the query attached to a resource group**
The following `get-group-query` example displays query attached to the specified resource group.
```
aws resource-groups get-group-query \
--group-name tbq-WebServer
```
Output:
```
{
"GroupQuery": {
"GroupName": "tbq-WebServer",
"ResourceQuery": {
"Type": "TAG_FILTERS_1_0",
"Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}
}
}
```
+ For API details, see [GetGroupQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-group-query.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example fetches the resource query for the given resource group**
```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**Output:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+ For API details, see [GetGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example fetches the resource query for the given resource group**
```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**Output:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+ For API details, see [GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetTags` with a CLI
The following code examples show how to use `GetTags`.
------
#### [ CLI ]
**AWS CLI**
**To retrieve the tags attached to a resource group**
The following `get-tags` example displays the tag key and value pairs attached to the specified resource group (the group itself, not its members).
```
aws resource-groups get-tags \
--arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer
```
Output:
```
{
"Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
"Tags": {
"QueryType": "tags",
"QueryResources": "ec2-instances"
}
}
```
+ For API details, see [GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/get-tags.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists tags for the given resource group arn**
```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Output:**
```
Key Value
--- -----
Instances workboxes
```
+ For API details, see [GetTags](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists tags for the given resource group arn**
```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Output:**
```
Key Value
--- -----
Instances workboxes
```
+ For API details, see [GetTags](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListGroupResources` with a CLI
The following code examples show how to use `ListGroupResources`.
------
#### [ CLI ]
**AWS CLI**
**To list all of the resources in a resource group**
Example 1: The following `list-resource-groups` example lists all of the resources that are part of the specified resource group.
```
aws resource-groups list-group-resources \
--group-name tbq-WebServer
```
Output:
```
{
"ResourceIdentifiers": [
{
"ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-09f77fa38c12345ab",
"ResourceType": "AWS::EC2::Instance"
}
]
}
```
Example 2: The following example lists all of the resources in the group that also have a 'resource-type' of the 'AWS::EC2::Instance'. :
aws resource-groups list-group-resources --group-name tbq-WebServer --filters Name=resource-type,Values=AWS::EC2::Instance
+ For API details, see [ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/list-group-resources.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists group resources on the basis of filtered by resource type**
```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**Output:**
```
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
```
+ For API details, see [ListGroupResources](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists group resources on the basis of filtered by resource type**
```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**Output:**
```
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
```
+ For API details, see [ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListGroups` with a CLI
The following code examples show how to use `ListGroups`.
------
#### [ CLI ]
**AWS CLI**
**To list the available resource groups**
The following `list-groups` example displays a list of all of the resource groups.
```
aws resource-groups list-groups
```
Output:
```
{
"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"
}
]
}
```
+ For API details, see [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/list-groups.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists resource group already created.**
```
Get-RGGroupList
```
**Output:**
```
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
```
+ For API details, see [ListGroups](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists resource group already created.**
```
Get-RGGroupList
```
**Output:**
```
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
```
+ For API details, see [ListGroups](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `SearchResources` with a CLI
The following code examples show how to use `SearchResources`.
------
#### [ CLI ]
**AWS CLI**
**To find resources that match a query**
The following `search-resources` example retrieves a list of all AWS resources that match the specified query.
```
aws resource-groups search-resources \
--resource-query file://query.json
```
Contents of `query.json`:
```
{
"Type": "TAG_FILTERS_1_0",
"Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Patch Group\", \"Values\":[\"Dev\"]}]}"
}
```
Output:
```
{
"ResourceIdentifiers": [
{
"ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a23bc45d67890ef",
"ResourceType": "AWS::EC2::Instance"
}
]
}
```
+ For API details, see [SearchResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/search-resources.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a ResourceQuery for Instance resource types with tag filters and finds resources. **
```
$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
```
**Output:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+ For API details, see [SearchResources](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a ResourceQuery for Instance resource types with tag filters and finds resources. **
```
$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
```
**Output:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+ For API details, see [SearchResources](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `Tag` with a CLI
The following code examples show how to use `Tag`.
------
#### [ CLI ]
**AWS CLI**
**To attach a tag to a resource group**
The following `tag` example attaches the specified tag key and value pairs to the specified resource group (the group itself, not its members).
```
aws resource-groups tag \
--tags QueryType=tags,QueryResources=ec2-instances \
--arn arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer
```
Output:
```
{
"Arn": "arn:aws:resource-groups:us-west-2:128716708097:group/tbq-WebServer",
"Tags": {
"QueryType": "tags",
"QueryResources": "ec2-instances"
}
}
```
For more information, see [Manage tags](https://docs.aws.amazon.com/ARG/latest/userguide/tagging-resources.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [Tag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/tag.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example adds tag key 'Instances' with value 'workboxes' to the given resource group arn**
```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Output:**
```
Arn Tags
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+ For API details, see [Tag](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example adds tag key 'Instances' with value 'workboxes' to the given resource group arn**
```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Output:**
```
Arn Tags
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+ For API details, see [Tag](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `Untag` with a CLI
The following code examples show how to use `Untag`.
------
#### [ CLI ]
**AWS CLI**
**To remove tags from a resource group**
The following `untags` example removes any tag with the specified key from the resource group itself, not its members.
```
aws resource-groups untag \
--arn arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer \
--keys QueryType
```
Output:
```
{
"Arn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
"Keys": [
"QueryType"
]
}
```
For more information, see [Manage tags](https://docs.aws.amazon.com/ARG/latest/userguide/tagging-resources.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [Untag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/untag.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example removes mentioned tag from the resource group**
```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**Output:**
```
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}
```
+ For API details, see [Untag](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example removes mentioned tag from the resource group**
```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**Output:**
```
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}
```
+ For API details, see [Untag](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateGroup` with a CLI
The following code examples show how to use `UpdateGroup`.
------
#### [ CLI ]
**AWS CLI**
**To update the description for a resource group**
The following `update-group` example updates the description for the specified resource group.
```
aws resource-groups update-group \
--group-name tbq-WebServer \
--description "Resource group for all web server resources."
```
Output:
```
{
"Group": {
"GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
"Name": "tbq-WebServer"
"Description": "Resource group for all web server resources."
}
}
```
For more information, see [Update Groups](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/update-group.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example updates the description of the group**
```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**Output:**
```
Description GroupArn Name
----------- -------- ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+ For API details, see [UpdateGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example updates the description of the group**
```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**Output:**
```
Description GroupArn Name
----------- -------- ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+ For API details, see [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateGroupQuery` with a CLI
The following code examples show how to use `UpdateGroupQuery`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To update the query for a tag-based resource group**
The following `update-group-query` example updates the query attached to the specified tag-based resource group.
```
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\"]}]}"}'
```
Output:
```
{
"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\"]}]}"
}
}
```
For more information, see [Update Groups](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html) in the *AWS Resource Groups User Guide*.
**Example 2: To update the query for a CloudFormation stack-based resource group**
The following `update-group-query` example updates the query attached to the specified AWS CloudFormation stack-based resource group.
```
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\"}"}'
```
Output:
```
{
"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\"}"
}
}
```
For more information, see [Update Groups](https://docs.aws.amazon.com/ARG/latest/userguide/updating-resource-groups.html) in the *AWS Resource Groups User Guide*.
+ For API details, see [UpdateGroupQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/update-group-query.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a query object and updates the query for the group.**
```
$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
```
**Output:**
```
GroupName ResourceQuery
--------- -------------
build600 Amazon.ResourceGroups.Model.ResourceQuery
```
+ For API details, see [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a query object and updates the query for the group.**
```
$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
```
**Output:**
```
GroupName ResourceQuery
--------- -------------
build600 Amazon.ResourceGroups.Model.ResourceQuery
```
+ For API details, see [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------