Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDKs を使用するリソースグループの基本的な例
次のコード例は、 SDKs AWS Resource Groups で AWS の基本を使用する方法を示しています。
**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)
# AWS SDKs を使用したリソースグループのアクション
次のコード例は、 AWS SDKs で個々の Resource Groups アクションを実行する方法を示しています。それぞれの例には、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)
# CLI で `CreateGroup` を使用する
次のサンプルコードは、`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`。クエリには、Resource Groups でサポートされている指定された CloudFormation スタック内のすべての AWS リソースが含まれます。
```
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 Resource Groups ユーザーガイド*」の「[グループの作成](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 ]
**Tools for PowerShell V4**
**例 1: この例では、TestPowerShellGroup という名前の新しいタグベースの AWS Resource Groups リソースグループを作成します。グループには、タグキー「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 コマンドレットリファレンス (V4)*」の「[CreateGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、TestPowerShellGroup という名前の新しいタグベースの AWS Resource Groups リソースグループを作成します。グループには、タグキー「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 コマンドレットリファレンス (V5)*」の「[CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeleteGroup` を使用する
次のサンプルコードは、`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 Resource Groups ユーザーガイド*」の「[グループの削除](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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[DeleteGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetGroup` を使用する
次のサンプルコードは、`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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[GetGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetGroupQuery` を使用する
次のサンプルコードは、`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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[GetGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetTags` を使用する
次のサンプルコードは、`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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[GetTags](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[GetTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListGroupResources` を使用する
次のサンプルコードは、`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: 次の例では、'AWS::EC2::Instance' の 'resource-type' も持つグループ内のすべてのリソースを一覧表示します。
aws resource-groups list-group-resources --group-name tbq-WebServer --filters Name=resource-type,Values=AWS::EC2::Instance
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-groups/list-group-resources.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[ListGroupResources](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ListGroups` を使用する
次のサンプルコードは、`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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[ListGroups](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5) の「[ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
------
# CLI で `SearchResources` を使用する
次のサンプルコードは、`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 ]
**Tools for PowerShell V4**
**例 1: この例では、タグフィルターを使用してインスタンスリソースタイプの ResourceQuery を作成し、リソースを検索します。**
```
$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 コマンドレットリファレンス (V4)*」の「[SearchResources](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、タグフィルターを使用してインスタンスリソースタイプの ResourceQuery を作成し、リソースを検索します。**
```
$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 コマンドレットリファレンス (V5)*」の「[SearchResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `Tag` を使用する
次のサンプルコードは、`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 Resource Groups ユーザーガイド*」の「[タグの管理](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 ]
**Tools for PowerShell V4**
**例 1: この例では、指定されたリソースグループ ARN に値「workboxes」を持つタグキー「Instances」を追加します。**
```
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 コマンドレットリファレンス (V4)*」の「[Tag](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースグループ ARN に値「workboxes」を持つタグキー「Instances」を追加します。**
```
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 コマンドレットリファレンス (V5)*」の「[Tag](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `Untag` を使用する
次のサンプルコードは、`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 Resource Groups ユーザーガイド*」の「[タグの管理](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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[Untag](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[Untag](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `UpdateGroup` を使用する
次のサンプルコードは、`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 Resource Groups ユーザーガイド*」の「[グループの更新](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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[UpdateGroup](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5)*」の「[UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `UpdateGroupQuery` を使用する
次のサンプルコードは、`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 Resource Groups ユーザーガイド*」の「[グループの更新](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 Resource Groups ユーザーガイド*」の「[グループの更新](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 ]
**Tools for 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 コマンドレットリファレンス (V4)*」の「[UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for 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 コマンドレットリファレンス (V5) の「[UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
------