# AWS Glue の API のタグ付け
<a name="aws-glue-api-tags"></a>

## データ型
<a name="aws-glue-api-tags-objects"></a>
+ [Tag 構造](#aws-glue-api-tags-Tag)

## Tag 構造
<a name="aws-glue-api-tags-Tag"></a>

`Tag` オブジェクトは、AWS リソースに割り当てることができるラベルを表します。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。

タグ、および AWS Glue 内のリソースへのアクセス制御に関する詳細は、開発者ガイドの「[AWS Tags in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html)」と「[Specifying AWS Glue Resource ARNs](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html)」を参照してください。

**フィールド**
+ `key` – UTF-8 文字列、1～128 バイト長。

  タグキー。オブジェクトにタグを作成するときにキーが必要です。キーでは大文字と小文字が区別され、プレフィックス aws を含めることはできません。
+ `value` - UTF-8 文字列、256 バイト長以下。

  タグ値。オブジェクトにタグを作成するときの値はオプションです。値では大文字と小文字が区別され、プレフィックス aws を含めることはできません。

## 操作
<a name="aws-glue-api-tags-actions"></a>
+ [TagResource アクション (Python: tag\_resource)](#aws-glue-api-tags-TagResource)
+ [UntagResource アクション (Python: untag\_resource)](#aws-glue-api-tags-UntagResource)
+ [GetTags アクション (Python: get\_tags)](#aws-glue-api-tags-GetTags)

## TagResource アクション (Python: tag\_resource)
<a name="aws-glue-api-tags-TagResource"></a>

リソースにタグを追加します。タグとは、AWS のリソースに付けることができるラベルです。AWS Glue では、特定のリソースにのみタグを付けることができます。どのリソースにタグを付けることができるかについては、[AWS Tags in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) を参照してください。

**リクエスト**
+ `ResourceArn` – *必須:* UTF-8 文字列。1～10,240 バイト長。[Custom string pattern #47](aws-glue-api-common.md#regex_47) に一致。

  タグを追加する AWS Glue リソースの ARN。AWS Glue リソースの ARN の詳細については、「[AWS Glue ARN string pattern](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id)」を参照してください。
+ `TagsToAdd` – *必須:* キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  このリソースに追加するタグ。

**応答**
+ *応答パラメータはありません。*

**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

## UntagResource アクション (Python: untag\_resource)
<a name="aws-glue-api-tags-UntagResource"></a>

統合リソースから指定したタグを削除します。

**リクエスト**
+ `ResourceArn` – *必須:* UTF-8 文字列。1～10,240 バイト長。[Custom string pattern #47](aws-glue-api-common.md#regex_47) に一致。

  統合リソースの Amazon リソースネーム (ARN)。
+ `TagsToRemove` – *必須:* UTF-8 文字列の配列。文字列 50 個以下。

  リソースから削除するメタデータタグのリスト。

**応答**
+ *応答パラメータはありません。*

**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`

## GetTags アクション (Python: get\_tags)
<a name="aws-glue-api-tags-GetTags"></a>

リソースに関連付けられているタグのリストを取得します。

**リクエスト**
+ `ResourceArn` – *必須:* UTF-8 文字列。1～10,240 バイト長。[Custom string pattern #47](aws-glue-api-common.md#regex_47) に一致。

  タグを取得する対象のリソースの Amazon リソースネーム (ARN)。

**応答**
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  リクエストされたタグ。

**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `EntityNotFoundException`