AWS Glue の API のタグ付け
データ型
Tag 構造
Tag オブジェクトは、AWS リソースに割り当てることができるラベルを表します。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。
リソース AWS Glue へのアクセス制御や、AWS タグ AWS Glue および指定 AWS Glue リソース ARN の詳細については、開発者ガイドを参照してください。
フィールド
-
key– UTF-8 文字列、1～128 バイト長。タグキー。オブジェクトにタグを作成するときにキーが必要です。キーでは大文字と小文字が区別され、プレフィックス aws を含めることはできません。
-
value- UTF-8 文字列、256 バイト長以下。タグ値。オブジェクトにタグを作成するときの値はオプションです。値では大文字と小文字が区別され、プレフィックス aws を含めることはできません。
操作
TagResource アクション (Python: tag_resource)
リソースにタグを追加します。タグとは、AWS のリソースに付けることができるラベルです。AWS Glue では、特定のリソースにのみタグを付けることができます。どのリソースにタグを付けることができるかについては、「AWS Tags in AWS Glue」を参照してください。
タグ関連の API を呼び出すためのタグ付けのアクセス許可に加えて、接続でタグ付け API を呼び出すための glue:GetConnection アクセス許可と、データベースでタグ付け API を呼び出すための glue:GetDatabase アクセス許可も必要です。
リクエスト
-
ResourceArn– 必須: UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。タグを追加する AWS Glue リソースの ARN。AWS Glue リソースの ARN の詳細については、「AWS Glue ARN string pattern」を参照してください。
-
TagsToAdd– 必須: キーと値のペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
このリソースに追加するタグ。
レスポンス
応答パラメータはありません。
エラー
InvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionEntityNotFoundException
UntagResource アクション (Python: untag_resource)
リソースからタグを削除します。
リクエスト
-
ResourceArn– 必須: UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。タグを削除するリソースの Amazon リソースネーム (ARN)。
-
TagsToRemove– 必須: UTF-8 文字列の配列。文字列 50 個以下。このリソースから削除するタグ。
レスポンス
応答パラメータはありません。
エラー
InvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionEntityNotFoundException
GetTags アクション (Python: get_tags)
リソースに関連付けられているタグのリストを取得します。
リクエスト
-
ResourceArn– 必須: UTF-8 文字列。1～10240 バイト長。Custom string pattern #22 に一致。タグを取得する対象のリソースの Amazon リソースネーム (ARN)。
レスポンス
-
Tags– キーと値のペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
リクエストされたタグ。
エラー
InvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionEntityNotFoundException
