AWS Resource Groups Tagging APIアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS Resource Groups Tagging APIアクションのリファレンスを提供します。これらのアクションを使用して、複数のサービスにわたるAWSリソースのタグを取得、追加、更新、削除します。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

ARNによるタグの取得

アクション識別子はaws.resourceGroupsTaggingApi.getResourceTagsです。

ARNで指定された1つ以上のAWSリソースのタグを返します。

重要

resourceArnListをtagFilters、resourceTypeFilters、またはページネーション入力と組み合わせることはできません。AWSは、その組み合わせをInvalidParameterExceptionで拒否します。タグまたはタイプでリソースを検索するには、代わりにaws.resourceGroupsTaggingApi.getResourcesByTagを使用してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。クエリするAWSリージョン。	`us-east-2`
`resourceArnList`	リスト	必須。タグを取得する1～100個のARNのリストです。AWSは存在しないARNを暗黙的に破棄します。	`["arn:aws:dynamodb:us-east-2:123456789012:table/my-table"]`
`includeComplianceDetails`	ブール値	オプション。レスポンスにタグポリシーのコンプライアンスの詳細を含めます。	`false`
`excludeCompliantResources`	ブール値	オプション。タグポリシーに準拠しているリソースを除外します。 `includeComplianceDetails` が `true` の場合にのみ意味があります。	`false`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "tags", "expression": ".response.ResourceTagMappingList"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	get_resources boto3リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (InvalidParameterException) when calling the GetResources operation: Only one of ResourceARNList or TagFilters can be specified"`

出力

タイプ

例

response

オブジェクト

get_resources boto3リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (InvalidParameterException) when calling the GetResources operation: Only one of ResourceARNList or TagFilters can be specified"

ワークフローの例

name: get-resource-tags-by-arn
description: 'Get tags for AWS resources by ARN'
steps:
  - name: getResourceTagsByArn
    type: action
    action: aws.resourceGroupsTaggingApi.getResourceTags
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      resourceArnList:
        - "arn:aws:dynamodb:us-east-2:123456789012:table/my-table"
      selectors:
        - name: tags
          expression: ".response.ResourceTagMappingList"
    next: end

タグによるリソースの取得

アクション識別子はaws.resourceGroupsTaggingApi.getResourcesByTagです。

タグのキーの値および/またはリソースタイプでAWSリソースを検索します。タグが付けられたリソースのみを返します。

重要

同じ呼び出しでtagFiltersまたはresourceTypeFiltersをresourceArnListと組み合わせることはできません。AWSはInvalidParameterExceptionでその組み合わせを拒否します。特定のARNのタグを取得するには、代わりにaws.resourceGroupsTaggingApi.getResourceTagsを使用してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。クエリするAWSリージョン。	`us-east-2`
`tagFilters`	リスト	オプション。タグのキーと値でフィルタリングします。最大50個のキー、それぞれ最大20個の値まで指定できます。	`[{"Key": "product", "Values": ["Workflow"]}]`
`resourceTypeFilters`	リスト	オプション。リソースタイプでフィルタリングします。最大100項目。	`["ec2:instance", "s3:bucket"]`
`resourcesPerPage`	整数	オプション。ページあたりの最大リソース数（1～100）。	`50`
`tagsPerPage`	整数	オプション。ページあたりのタグの最大数（100～500）。AWSは代わりに `resourcesPerPage` を使用することを推奨しています。	`100`
`paginationToken`	弦	オプション。結果の次のページを取得するための、以前のレスポンスからのトークン。初回のリクエストでは空のままにしてください。	`some-pagination-token`
`includeComplianceDetails`	ブール値	オプション。レスポンスにタグポリシーのコンプライアンスの詳細を含めます。	`false`
`excludeCompliantResources`	ブール値	オプション。タグポリシーに準拠しているリソースを除外します。 `includeComplianceDetails` が `true` の場合にのみ意味があります。	`false`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "resourceTagMappingList", "expression": ".response.ResourceTagMappingList"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	get_resources boto3リファレンスを参照してください。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (InvalidParameterException) when calling the GetResources operation: Only one of ResourceARNList or TagFilters can be specified"`

出力

タイプ

例

response

オブジェクト

get_resources boto3リファレンス

を参照してください。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (InvalidParameterException) when calling the GetResources operation: Only one of ResourceARNList or TagFilters can be specified"

ワークフローの例

name: find-resources-by-tag
description: 'Find AWS resources by tag'
steps:
  - name: findResourcesByTag
    type: action
    action: aws.resourceGroupsTaggingApi.getResourcesByTag
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      tagFilters:
        - Key: product
          Values:
            - Workflow
      resourcesPerPage: 50
      selectors:
        - name: resourceTagMappingList
          expression: ".response.ResourceTagMappingList"
    next: end

リソースにタグを追加または更新します

アクション識別子はaws.resourceGroupsTaggingApi.tagResourcesです。

1回の呼び出しで、複数のサービスにわたる1～20個のAWSリソースに最大50個のタグを追加または更新します。

重要

アクションは、トップレベルのエラーとしてではなく、response.FailedResourcesMapでARNごとの部分的な失敗を報告します。バッチ内の1つのARNが失敗しても呼び出し全体が失敗するわけではないため、successがtrueの場合でもresponse.FailedResourcesMapを確認してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットリソースのAWSリージョン。	`us-east-2`
`resourceArnList`	リスト	必須。タグ付けする1～20個のARNのリスト。	`["arn:aws:sqs:us-east-2:123456789012:my-queue"]`
`tags`	地図	必須。追加または更新するタグ。最大50個のタグ。各キーは1～128文字です。各値は0～256文字です。	`{"Environment": "production", "Team": "platform"}`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "failedResources", "expression": ".response.FailedResourcesMap"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	tag_resources boto3リファレンスを参照してください。完全に成功した場合、 `response.FailedResourcesMap` は空になります。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	認証エラーや権限エラーなどで失敗した場合、呼び出しによってここに値が入力されます。リソースごとの失敗は `response.FailedResourcesMap` に表示されます。

出力

タイプ

例

response

オブジェクト

tag_resources boto3リファレンス

を参照してください。完全に成功した場合、

response.FailedResourcesMap

は空になります。

success

ブール値

true

または

false

errorMessage

弦

認証エラーや権限エラーなどで失敗した場合、呼び出しによってここに値が入力されます。リソースごとの失敗は

response.FailedResourcesMap

に表示されます。

ワークフローの例

name: tag-aws-resources
description: 'Add or update tags on AWS resources'
steps:
  - name: tagResources
    type: action
    action: aws.resourceGroupsTaggingApi.tagResources
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      resourceArnList:
        - "arn:aws:sqs:us-east-2:123456789012:my-queue"
      tags:
        Environment: production
        Team: platform
      selectors:
        - name: failedResources
          expression: ".response.FailedResourcesMap"
    next: end

リソースからタグを削除

アクション識別子はaws.resourceGroupsTaggingApi.untagResourcesです。

1回の呼び出しで、複数のサービスにわたる最大20個のAWSリソースから1つ以上のタグを削除します。リソースに存在しないタグキーを削除しても、エラーなしで成功します。

重要

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットリソースのAWSリージョン。	`us-east-2`
`resourceArnList`	リスト	必須。タグを削除する1～20個のARNのリスト。	`["arn:aws:sqs:us-east-2:123456789012:my-queue"]`
`tagKeys`	リスト	必須。削除するタグキー。1～50個のキー。リソースに存在しないキーを削除しても、エラーなしで成功します。	`["Environment", "Team"]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "failedResources", "expression": ".response.FailedResourcesMap"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	untag_resources boto3リファレンスを参照してください。完全に成功した場合、 `response.FailedResourcesMap` は空になります。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	認証エラーや権限エラーなどで失敗した場合、呼び出しによってここに値が入力されます。リソースごとの失敗は `response.FailedResourcesMap` に表示されます。

出力

タイプ

例

response

オブジェクト

untag_resources boto3リファレンス

を参照してください。完全に成功した場合、

response.FailedResourcesMap

は空になります。

success

ブール値

true

または

false

errorMessage

弦

認証エラーや権限エラーなどで失敗した場合、呼び出しによってここに値が入力されます。リソースごとの失敗は

response.FailedResourcesMap

に表示されます。

ワークフローの例

name: remove-tags-from-resources
description: 'Remove tags from AWS resources'
steps:
  - name: untagResources
    type: action
    action: aws.resourceGroupsTaggingApi.untagResources
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      resourceArnList:
        - "arn:aws:sqs:us-east-2:123456789012:my-queue"
      tagKeys:
        - Environment
      selectors:
        - name: failedResources
          expression: ".response.FailedResourcesMap"
    next: end

この機械翻訳は、参考として提供されています。

AWS Resource Groups Tagging APIアクション

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

ARNによるタグの取得

重要

タグによるリソースの取得

重要

リソースにタグを追加または更新します

重要

リソースからタグを削除

重要

前提条件