Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDKsコード例
次のコード例は、 AWS Software Development Kit (SDK) AWS Resource Groups Tagging API で を使用する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
**その他のリソース**
+ **[ Resource Groups Tagging API ユーザーガイド](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)** – Resource Groups Tagging API に関する詳細情報。
+ **[Resource Groups Tagging API リファレンス](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html)** – 使用可能なすべての Resource Groups Tagging API アクションに関する詳細。
+ **[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-tagging-api_code_examples_basics.md)
+ [アクション](resource-groups-tagging-api_code_examples_actions.md)
+ [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md)
+ [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md)
+ [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md)
+ [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md)
+ [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md)
# AWS SDKs基本的な例
次のコード例は、 SDKs AWS Resource Groups Tagging API で AWS の基本を使用する方法を示しています。
**Contents**
+ [アクション](resource-groups-tagging-api_code_examples_actions.md)
+ [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md)
+ [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md)
+ [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md)
+ [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md)
+ [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md)
# AWS SDKsアクション
次のコード例は、 AWS SDKs を使用して個々の Resource Groups Tagging API アクションを実行する方法を示しています。それぞれの例には、GitHub へのリンクがあり、そこにはコードの設定と実行に関する説明が記載されています。
以下の例には、最も一般的に使用されるアクションのみ含まれています。詳細な一覧については、「[AWS Resource Groups Tagging API API リファレンス](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html)」を参照してください。
**Topics**
+ [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md)
+ [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md)
+ [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md)
+ [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md)
+ [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md)
# CLI で `GetResources` を使用する
次のサンプルコードは、`GetResources` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**タグ付きリソースのリストを取得するには**
次の `get-resources` の例では、指定されたキー名と値でタグ付けされたアカウント内のリソースのリストを表示します。
```
aws resourcegroupstaggingapi get-resources \
--tag-filters Key=Environment,Values=Production \
--tags-per-page 100
```
出力:
```
{
"ResourceTagMappingList": [
{
"ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
"Tags": [
{
"Key": "Environment",
"Value": "Production"
}
]
}
]
}
```
詳細については、「*Resource Groups Tagging API リファレンス*」の「[GetResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-resources.html)」を参照してください。**
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: リージョン内のすべてのタグ付けされたリソースと、リソースに関連付けられたタグキーを返します。コマンドレットに -Region パラメータが指定されていない場合、シェルまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 2: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。各サービス名とリソースタイプの文字列は、リソースの Amazon リソースネーム (ARN) に埋め込まれている文字列と同じです。**
```
Get-RGTResource -ResourceType "s3"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 3: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。リソースタイプをコマンドレットにパイプすると、指定されたリソースタイプごとにサービスへの呼び出しが 1 回行われることに注意してください。**
```
"dynamodb","s3" | Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 4: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 5: 指定されたフィルターとリソースタイプに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
**例 6: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetResources](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: リージョン内のすべてのタグ付けされたリソースと、リソースに関連付けられたタグキーを返します。コマンドレットに -Region パラメータが指定されていない場合、シェルまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 2: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。各サービス名とリソースタイプの文字列は、リソースの Amazon リソースネーム (ARN) に埋め込まれている文字列と同じです。**
```
Get-RGTResource -ResourceType "s3"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 3: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。リソースタイプをコマンドレットにパイプすると、指定されたリソースタイプごとにサービスへの呼び出しが 1 回行われることに注意してください。**
```
"dynamodb","s3" | Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 4: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 5: 指定されたフィルターとリソースタイプに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
**例 6: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetTagKeys` を使用する
次のサンプルコードは、`GetTagKeys` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**すべてのタグキーのリストを取得するには**
次の `get-tag-keys` の例では、 アカウントのリソースで使用されるすべてのタグキー名のリストを取得します。
```
aws resourcegroupstaggingapi get-tag-keys
```
出力:
```
{
"TagKeys": [
"Environment",
"CostCenter",
"Department"
]
}
```
詳細については、「*Resource Groups Tagging API リファレンス*」の「[GetTagKeys](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagKeys.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTagKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-keys.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: 指定されたリージョンのすべてのタグキーを返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。タグキーは特定の順序では返されないことに注意してください。**
```
Get-RGTTagKey -region us-west-2
```
**出力:**
```
version
stage
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetTagKeys](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: 指定されたリージョンのすべてのタグキーを返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。タグキーは特定の順序では返されないことに注意してください。**
```
Get-RGTTagKey -region us-west-2
```
**出力:**
```
version
stage
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `GetTagValues` を使用する
次のサンプルコードは、`GetTagValues` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**すべてのタグ値のリストを取得するには**
次の `get-tag-values` の例では、 内のすべてのリソースの指定されたキーに使用されるすべての値を表示します。
```
aws resourcegroupstaggingapi get-tag-values \
--key=Environment
```
出力:
```
{
"TagValues": [
"Alpha",
"Gamma",
"Production"
]
}
```
詳細については、「*Resource Groups Tagging API リファレンス*」の「[GetTagValues](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagValues.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTagValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-values.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: リージョン内の指定されたタグの値を返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**出力:**
```
beta
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[GetTagValues](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: リージョン内の指定されたタグの値を返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**出力:**
```
beta
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `TagResources` を使用する
次のサンプルコードは、`TagResources` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**リソースにタグをアタッチするには**
次の `tag-resources` の例では、キー名と値付きの指定したリソースにタグを付けます。
```
aws resourcegroupstaggingapi tag-resources \
--resource-arn-list arn:aws:s3:::MyProductionBucket \
--tags Environment=Production,CostCenter=1234
```
出力:
```
{
"FailedResourcesMap": {}
}
```
詳細については、「*Resource Groups Tagging API リファレンス*」の「[TagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/tag-resources.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: この例では、値「beta」と「preprod\$1test」を含むタグキー「stage」と「version」を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。タグを適用するため、サービスが 1 回呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
**例 2: この例では、指定されたタグと値を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[TagResources](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: この例では、値「beta」と「preprod\$1test」を含むタグキー「stage」と「version」を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。タグを適用するため、サービスが 1 回呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
**例 2: この例では、指定されたタグと値を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[TagResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `UntagResources` を使用する
次のサンプルコードは、`UntagResources` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**リソースからタグを削除するには**
次の `untag-resources` の例では、指定されたリソースから指定されたタグキーと関連付けられた値を削除します。
```
aws resourcegroupstaggingapi untag-resources \
--resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \
--tag-keys Environment CostCenter
```
出力:
```
{
"FailedResourcesMap": {}
}
```
詳細については、「*Resource Groups Tagging API リファレンス*」の「[UntagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntagResources.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/untag-resources.html)」を参照してください。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**例 1: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。タグを削除するために、サービスが 1 回呼び出されます。タグを削除する前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version"
```
**例 2: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。各呼び出しの前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version"
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[UntagResources](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。タグを削除するために、サービスが 1 回呼び出されます。タグを削除する前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version"
```
**例 2: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。各呼び出しの前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
------