Resource Groups Tagging API examples using AWS CLI - AWS Command Line Interface
アクション

このドキュメントはバージョン 1 の AWS CLI のみを対象としています。

AWS CLI バージョン 1 のサポート終了を発表しました。AWS CLI バージョン 2 に移行することをお勧めします。日付、その他の詳細、移行方法については、「お知らせ」を参照してください。AWS CLI のバージョン 2 に関連するドキュメントについては、バージョン 2 用ユーザーガイドを参照してください。

Resource Groups Tagging API examples using AWS CLI

次のコードサンプルは、Resource Groups Tagging API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

次のコード例は、get-resources を使用する方法を示しています。

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」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「GetResources」を参照してください。

次のコード例は、get-tag-keys を使用する方法を示しています。

AWS CLI

すべてのタグキーのリストを取得するには

次の get-tag-keys の例では、 アカウントのリソースで使用されるすべてのタグキー名のリストを取得します。

aws resourcegroupstaggingapi get-tag-keys

出力:

{
    "TagKeys": [
        "Environment",
        "CostCenter",
        "Department"
    ]
}

詳細については、「Resource Groups Tagging API リファレンス」の「GetTagKeys」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「GetTagKeys」を参照してください。

次のコード例は、get-tag-values を使用する方法を示しています。

AWS CLI

すべてのタグ値のリストを取得するには

次の get-tag-values の例では、 内のすべてのリソースの指定されたキーに使用されるすべての値を表示します。

aws resourcegroupstaggingapi get-tag-values \
    --key=Environment

出力:

{
    "TagValues": [
        "Alpha",
        "Gamma",
        "Production"
    ]
}

詳細については、「Resource Groups Tagging API リファレンス」の「GetTagValues」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「GetTagValues」を参照してください。

次のコード例は、tag-resources を使用する方法を示しています。

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」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「TagResources」を参照してください。

次のコード例は、untag-resources を使用する方法を示しています。

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」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResources」を参照してください。