— データ型 —AssetFormEntry AssetTypeFormReference IterableFormEntry IterableFormItem IterableFormListItem SearchResultItem SearchSort SearchFilterClause SearchAttributeFilter SearchFilterValue ItemError GetAssetOutput SearchOutput — 操作 —GetAsset (get_asset)PutAsset (put_asset)DeleteAsset (delete_asset)PutAssetType (put_asset_type)GetAssetType (get_asset_type)DeleteAssetType (delete_asset_type)ListAssetTypes (list_asset_types)PutFormType (put_form_type)GetFormType (get_form_type)DeleteFormType (delete_form_type)ListFormTypes (list_form_types)PutAttachment (put_attachment)DeleteAttachment (delete_attachment)ListIterableForms (list_iterable_forms)BatchGetIterableForms (batch_get_iterable_forms)CreateGlossary (create_glossary)GetGlossary (get_glossary)UpdateGlossary (update_glossary)DeleteGlossary (delete_glossary)ListGlossaries (list_glossaries)CreateGlossaryTerm (create_glossary_term)GetGlossaryTerm (get_glossary_term)UpdateGlossaryTerm (update_glossary_term)DeleteGlossaryTerm (delete_glossary_term)ListGlossaryTerms (list_glossary_terms)AssociateGlossaryTerms (associate_glossary_terms)DisassociateGlossaryTerms (disassociate_glossary_terms)Search (検索)

ビジネスコンテキストの API

ビジネスコンテキスト API は、アセット、アセットタイプ、フォームタイプ、用語集、用語集の用語、アタッチメント、および AWS Glue Data Catalog での検索を管理するためのデータ型とオペレーションについて説明します。

AssetFormEntry 構造

アセット上のフォーム。フォームタイプ識別子とその JSON コンテンツで構成されます。

フィールド

FormTypeId - UTF-8 文字列。1～256 バイト長。

このフォームのスキーマを定義するフォームタイプの識別子。
Content – UTF–8 文字列。

指定されたフォームタイプのスキーマに準拠するフォームの JSON コンテンツ。

AssetTypeFormReference 構造

アセットタイプに含まれるフォームタイプの参照。

フィールド

FormTypeIdentifier – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

参照されるフォームタイプの識別子。

IterableFormEntry 構造

アセットで使用可能な反復可能なフォーム。フォームタイプによって識別されます。

フィールド

FormTypeId - UTF-8 文字列。1～256 バイト長。

ListIterableForms または BatchGetIterableForms を介して項目を取得するために使用される、反復可能な形式のフォームタイプ識別子 (例: columns)。

IterableFormItem 構造

完全かつ反復可能なフォーム項目とそのフォーム。

フィールド

ItemId – UTF-8 文字列。

項目の一意の識別子。
ItemName – UTF–8 文字列。

項目の名前。
GlossaryTerms – UTF-8 文字列の配列、1～10 個の文字列。

項目に関連付けられた用語集の用語の識別子。
Forms – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

項目上のフォーム。フォーム名をキーにして識別されます。
Attachments – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

コンテキストを増やすための項目に追加されるアタッチメント。アタッチメント名をキーにして識別されます。

IterableFormListItem 構造

反復可能な形式の項目の概要。

フィールド

ItemId – UTF-8 文字列。

項目の一意の識別子。
ItemName – UTF–8 文字列。

項目の名前。
Description – UTF–8 文字列。

項目の説明。
GlossaryTerms – UTF-8 文字列の配列、1～10 個の文字列。

項目に関連付けられた用語集の用語の識別子。

SearchResultItem 構造

一致したアセットを表す単一の検索結果項目。

フィールド

Id – UTF-8 文字列。1～1087 バイト長。String に一致。

一致したアセットの一意の識別子。
AssetName – UTF–8 文字列。

一致したアセットの名前。
AssetDescription – UTF–8 文字列。

一致したアセットの説明。
UpdatedAt – タイムスタンプ。

一致したアセットが最後に更新されたタイムスタンプ。
AssetTypeId - UTF-8 文字列。1～256 バイト長。

一致したアセットのアセットタイプの識別子。

SearchSort 構造

検索結果のソート条件。

フィールド

Attribute – 必須: UTF-8 文字列。1～128 バイト長。

ソートの基準となる属性。
Order – UTF-8 文字列 (有効な値: ASCENDING | DESCENDING)。

ソート順。有効な値は、ASCENDING および DESCENDING です。

SearchFilterClause 構造

ネストされたブールロジックをサポートするフィルター句。andAllFilters、orAnyFilters、attributeFilter、mapFilter のいずれか 1 つを指定する必要があります。

フィールド

AndAllFilters – SearchFilterClause オブジェクトの配列、1～10 個の構造。

すべて一致する必要があるフィルター句のリスト (論理 AND)。
OrAnyFilters – SearchFilterClause オブジェクトの配列、1～10 個の構造。

1 つ以上が一致する必要があるフィルター句のリスト (論理 OR)。
AttributeFilter – SearchAttributeFilter オブジェクト。

1 つの属性値のフィルター。
MapFilter – .

マップ属性のキーと値のペアに対するフィルター。

SearchAttributeFilter 構造

演算子を使用して属性値を比較するフィルター。

フィールド

Attribute – 必須: UTF-8 文字列。1～128 バイト長。

フィルタリングする属性名。
Operator – 必須: UTF-8 文字列 (有効な値: equals | greaterThan | greaterThanOrEquals | lessThan | lessThanOrEquals | notExists)。

比較演算子。有効な値は、equals、greaterThan、greaterThanOrEquals、lessThan、lessThanOrEquals および notExists です。
Value – SearchFilterValue オブジェクト。

比較する値。

SearchFilterValue 構造

フィルターの値。stringValue または longValue のいずれかを指定する必要があります。

フィールド

StringValue – UTF-8 文字列、256 バイト長以下。

文字列フィルター値。
LongValue – 数値 (long)。

長整数型のフィルター値

ItemError 構造

反復可能なフォーム項目の取得中に発生したエラー。

フィールド

ItemIdentifier – UTF-8 文字列。1～1087 バイト長。

エラーの原因となった項目の識別子。
Code – UTF–8 文字列。

エラーコードです。
Message – UTF–8 文字列。

エラーメッセージです。

GetAssetOutput 構造

GetAsset オペレーションのレスポンス構造。

フィールド

Id – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
Name – UTF–8 文字列。

アセットの名前。
Description – UTF–8 文字列。

アセットの説明。
CreatedAt – タイムスタンプ。

アセットが作成されたタイムスタンプ。
UpdatedAt – タイムスタンプ。

アセットが最後に更新されたタイムスタンプ。
CreatedBy – .

アセットを作成したプリンシパルの ID。
UpdatedBy – .

アセットを最後に更新したプリンシパルの ID。
AssetTypeId – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

このアセットのアセットタイプの識別子。
GlossaryTerms – UTF-8 文字列の配列、1～10 個の文字列。

アセットに関連付けられた用語集の用語の識別子。
Forms – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

アセット上のフォーム。フォーム名をキーにして識別されます。
Attachments – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

コンテキストを増やすためのアセットに追加されるアタッチメント。アタッチメント名をキーにして識別されます。
IterableForms – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A IterableFormEntry オブジェクトです。

アセットで使用可能な反復可能なフォーム。フォーム名をキーにして識別されます (例: columns)。ListIterableForms または BatchGetIterableForms でフォーム名を使用して、フォームの項目を取得します。

SearchOutput 構造

Search オペレーションのレスポンス構造。

フィールド

Items – SearchResultItem オブジェクトの配列。

検索条件に一致するアセットのリスト。
TotalCount – 数値 (整数)。

検索条件に一致するアセットの総数。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。
Aggregations – オブジェクトの配列。

リクエストされた属性の集計結果。

操作

GetAsset アクション (Python: get_asset)
PutAsset アクション (Python: put_asset)
DeleteAsset アクション (Python: delete_asset)
PutAssetType アクション (Python: put_asset_type)
GetAssetType アクション (Python: get_asset_type)
DeleteAssetType アクション (Python: delete_asset_type)
ListAssetTypes アクション (Python: list_asset_types)
PutFormType アクション (Python: put_form_type)
GetFormType アクション (Python: get_form_type)
DeleteFormType アクション (Python: delete_form_type)
ListFormTypes アクション (Python: list_form_types)
PutAttachment アクション (Python: put_attachment)
DeleteAttachment アクション (Python: delete_attachment)
ListIterableForms アクション (Python: list_iterable_forms)
BatchGetIterableForms アクション (Python: batch_get_iterable_forms)
CreateGlossary アクション (Python: create_glossary)
GetGlossary アクション (Python: get_glossary)
UpdateGlossary アクション (Python: update_glossary)
DeleteGlossary アクション (Python: delete_glossary)
ListGlossaries アクション (Python: list_glossaries)
CreateGlossaryTerm アクション (Python: create_glossary_term)
GetGlossaryTerm アクション (Python: get_glossary_term)
UpdateGlossaryTerm アクション (Python: update_glossary_term)
DeleteGlossaryTerm アクション (Python: delete_glossary_term)
ListGlossaryTerms アクション (Python: list_glossary_terms)
AssociateGlossaryTerms アクション (Python: associate_glossary_terms)
DisassociateGlossaryTerms アクション (Python: disassociate_glossary_terms)
Search アクション (Python: search)

GetAsset アクション (Python: get_asset)

フォーム、追加のアタッチメント、関連する用語集の用語など、AWS Glue Data Catalog 内のアセットのメタデータを取得します。

例

次の例では、識別子でアセットを取得します。


aws glue get-asset --identifier quarterly-sales-2026q1
    
    {
        "Id": "quarterly-sales-2026q1",
        "Name": "Quarterly Sales 2026 Q1",
        "Description": "Aggregated quarterly sales metrics",
        "CreatedAt": "2026-06-16T06:42:00.442Z",
        "AssetTypeId": "DataSet",
        "GlossaryTerms": [],
        "Forms": {
            "DataClassification": {
                "FormTypeId": "DataClassification",
                "Content": "{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}"
            }
        },
        "Attachments": {},
        "IterableForms": {}
    }

[リクエスト]

Identifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

取得するアセットの一意の識別子。

[応答]

GetAsset オペレーションのレスポンス構造。

GetAssetOutput – GetAssetOutput オブジェクト。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

PutAsset アクション (Python: put_asset)

AWS Glue Data Catalog でアセットを作成または更新します。アセットが既に存在する場合は、このオペレーションによってアセットが更新されます。存在しない場合は、新しいアセットが作成されます。

例

次の例では、フォームを持つアセットを作成します。


aws glue put-asset \
        --asset-type-id DataSet \
        --identifier quarterly-sales-2026q1 \
        --name "Quarterly Sales 2026 Q1" \
        --description "Aggregated quarterly sales metrics" \
        --forms '{"DataClassification":{"FormTypeId":"DataClassification","Content":"{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}"}}'
    
    {
        "Id": "quarterly-sales-2026q1",
        "Name": "Quarterly Sales 2026 Q1",
        "Description": "Aggregated quarterly sales metrics",
        "CreatedAt": "2026-06-16T06:42:00.442Z",
        "Forms": {
            "DataClassification": {
                "FormTypeId": "DataClassification",
                "Content": "{\"classification\":\"internal\",\"owner\":\"data-platform-team\"}"
            }
        }
    }

[リクエスト]

AssetTypeId – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

アセットのアセットタイプの識別子。
Identifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。この識別子を持つアセットが既に存在する場合は、更新されます。
Name – 必須: UTF–8 文字列。

アセットの名前。
Description – UTF–8 文字列。

アセットの説明。
Forms – 必須: キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

アセットに設定するフォーム。フォーム名をキーにして識別されます。各エントリは、フォームタイプとその JSON コンテンツを指定します。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
Name – 必須: UTF–8 文字列。

アセットの名前。
Description – UTF–8 文字列。

アセットの説明。
CreatedAt – タイムスタンプ。

アセットが作成されたタイムスタンプ。
Forms – キーバリューペアのマップ配列。

各キーは UTF-8 文字列。

各値は A AssetFormEntry オブジェクトです。

アセットにアタッチされたフォーム。フォーム名をキーにして識別されます。

エラー

AccessDeniedException
ConcurrentModificationException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteAsset アクション (Python: delete_asset)

AWS Glue Data Catalog からアセットを削除します。

例

次の例では、アセットを識別子で削除します。


aws glue delete-asset --identifier quarterly-sales-2026q1

[リクエスト]

Identifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

削除されるアセットの一意の識別子です。

[応答]

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

エラー

AccessDeniedException
ConcurrentModificationException
InternalServiceException
InvalidInputException
ThrottlingException

PutAssetType アクション (Python: put_asset_type)

AWS Glue Data Catalog でアセットタイプを作成または更新します。アセットタイプは、含めるフォームを指定してアセットの構造を定義します。指定された名前のアセットタイプが既に存在する場合は、更新されます。

例

次の例では、フォームタイプを参照するアセットタイプを作成します。


aws glue put-asset-type \
        --name DataSet \
        --forms '{"DataClassification":{"FormTypeIdentifier":"DataClassification"}}'
    
    {
        "Id": "DataSet",
        "Name": "DataSet",
        "Forms": {
            "DataClassification": {
                "FormTypeIdentifier": "DataClassification"
            }
        }
    }

[リクエスト]

Name – 必須: UTF-8 文字列。1～128 バイト長。String に一致。

アセットタイプの名前。
Forms – 必須: キーと値のペアのマップ配列。1～100 個のペア。

各キーは UTF-8 文字列、1～128 バイト長で、String に一致します。

各値は A AssetTypeFormReference オブジェクトです。

アセットタイプを構成するフォーム。フォーム名をキーにして識別されます。各エントリは、フォームのスキーマを定義するフォームタイプを参照します。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id - UTF-8 文字列。1～256 バイト長。

アセットタイプの識別子。
Name – UTF-8 文字列。1～128 バイト長。String に一致。

アセットタイプの名前。
Forms – キーと値のペアのマップ配列。1～100 個のペア。

各キーは UTF-8 文字列、1～128 バイト長で、String に一致します。

各値は A AssetTypeFormReference オブジェクトです。

アセットタイプを構成するフォーム。フォーム名をキーにして識別されます。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

GetAssetType アクション (Python: get_asset_type)

AWS Glue Data Catalog のアセットタイプを識別子で取得します。

例

次の例では、識別子でアセットタイプを取得します。


aws glue get-asset-type --identifier DataSet
    
    {
        "Id": "DataSet",
        "Name": "DataSet",
        "Forms": {
            "DataClassification": {
                "FormTypeIdentifier": "DataClassification"
            }
        }
    }

[リクエスト]

Identifier – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

取得するアセットタイプの識別子。

[応答]

Id - UTF-8 文字列。1～256 バイト長。

アセットタイプの識別子。
Name – UTF-8 文字列。1～128 バイト長。String に一致。

アセットタイプの名前。
Forms – キーと値のペアのマップ配列。1～100 個のペア。

各キーは UTF-8 文字列、1～128 バイト長で、String に一致します。

各値は A AssetTypeFormReference オブジェクトです。

アセットタイプを構成するフォーム。フォーム名をキーにして識別されます。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteAssetType アクション (Python: delete_asset_type)

AWS Glue Data Catalog からアセットタイプを削除します。

例

次の例では、アセットタイプを識別子で削除します。


aws glue delete-asset-type --identifier DataSet

[リクエスト]

Identifier – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

削除するアセットタイプの識別子。

[応答]

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

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListAssetTypes アクション (Python: list_asset_types)

AWS Glue Data Catalog で定義されているアセットタイプを一覧表示します。

例

次の例では、アカウント内のアセットタイプを一覧表示します。


aws glue list-asset-types --max-results 20
    
    {
        "Items": [
            {
                "Id": "DataSet",
                "Name": "DataSet"
            }
        ]
    }

[リクエスト]

MaxResults – 1～1000 の数値 (整数)。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。

応答

Items – オブジェクトの配列。

アセットタイプの項目のリスト。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

PutFormType アクション (Python: put_form_type)

AWS Glue Data Catalog でフォームタイプを作成または更新します。フォームタイプは、アセットにアタッチできる構造化メタデータのスキーマを定義します。

例

次の例では、Smithy スキーマを使用してフォームタイプを作成します。


aws glue put-form-type \
        --name DataClassification \
        --schema 'structure DataClassification {
        classification: String
        owner: String
    }'
    
    {
        "Id": "DataClassification",
        "Name": "DataClassification",
        "Schema": "structure DataClassification {\n    classification: String\n    owner: String\n}"
    }

[リクエスト]

Name – 必須: UTF-8 文字列。1～128 バイト長。String に一致。

フォームタイプの名前。大文字で始める必要があります。
Schema – 必須: UTF-8 文字列、1～100000 バイト長。

フォームタイプの Smithy IDL スキーマ定義。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id - UTF-8 文字列。1～256 バイト長。

フォームタイプの識別子。
Name – UTF-8 文字列。1～128 バイト長。String に一致。

フォームタイプの名前。
Schema – UTF-8 文字列。1～100000 バイト長。

フォームタイプの Smithy IDL スキーマ。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

GetFormType アクション (Python: get_form_type)

AWS Glue Data Catalog のフォームタイプを識別子で取得します。

例

次の例では、識別子でフォームタイプを取得します。


aws glue get-form-type --identifier DataClassification
    
    {
        "Id": "DataClassification",
        "Name": "DataClassification",
        "Schema": "structure DataClassification {\n    classification: String\n    owner: String\n}"
    }

[リクエスト]

Identifier – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

取得するフォームタイプの識別子。

[応答]

Id - UTF-8 文字列。1～256 バイト長。

フォームタイプの識別子。
Name – UTF-8 文字列。1～128 バイト長。String に一致。

フォームタイプの名前。
Schema – UTF-8 文字列。1～100000 バイト長。

フォームタイプの Smithy IDL スキーマ。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

DeleteFormType アクション (Python: delete_form_type)

AWS Glue Data Catalog からフォームタイプを削除します。フォームタイプは、アセットタイプによってまだ参照されている場合、削除できません。

例

次の例では、フォームタイプを識別子で削除します。


aws glue delete-form-type --identifier DataClassification

[リクエスト]

Identifier – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

削除するフォームタイプの識別子。

[応答]

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

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ConflictException
ThrottlingException

ListFormTypes アクション (Python: list_form_types)

AWS Glue Data Catalog で定義されているフォームタイプを一覧表示します。

例

次の例では、アカウント内のフォームタイプを一覧表示します。


aws glue list-form-types --max-results 20
    
    {
        "Items": [
            {
                "Id": "DataClassification",
                "Name": "DataClassification"
            }
        ]
    }

[リクエスト]

MaxResults – 1～1000 の数値 (整数)。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。

[応答]

Items – 必須: オブジェクトの配列。

フォームタイプの項目のリスト。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

PutAttachment アクション (Python: put_attachment)

AWS Glue Data Catalog のアセットまたは反復可能なフォーム項目にフォームをアタッチします。同じ名前のアタッチメントが既に存在する場合、上書きされます。

例

次の例では、フォームをアセットにアタッチしています。


aws glue put-attachment \
        --asset-identifier quarterly-sales-2026q1 \
        --attachment-name reviewNote \
        --form-type-id DataClassification \
        --content '{"classification":"internal","owner":"analytics-team"}'
    
    {
        "AssetId": "quarterly-sales-2026q1",
        "AttachmentName": "reviewNote",
        "FormTypeId": "DataClassification"
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

フォームをアタッチするアセットの一意の識別子。
IterableFormName – UTF-8 文字列。1～256 バイト長。String に一致。

反復可能なフォームの名前。itemIdentifier とともに指定すると、アタッチメントはアセット自体ではなく反復可能なフォームの項目をターゲットにします。
ItemIdentifier – UTF-8 文字列。1～1087 バイト長。

反復可能なフォーム内の項目の識別子。iterableFormName が指定されている場合は必須です。
AttachmentName – 必須: UTF-8 文字列、1～256 バイト長、「String」に一致。

アタッチメントの名前。
Content – 必須: UTF–8 文字列。

指定されたフォームタイプのスキーマに準拠するフォームの JSON コンテンツ。
FormTypeId – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

このアタッチメントのフォームタイプの識別子。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

AssetId – UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
IterableFormName – UTF-8 文字列。1～256 バイト長。String に一致。

アタッチメントが項目をターゲットにしている場合、反復可能なフォームの名前。
ItemIdentifier – UTF-8 文字列。1～1087 バイト長。

必要に応じて、反復可能なフォーム内の項目の識別子。
AttachmentName – UTF-8 文字列。1～256 バイト長。String に一致。

アタッチメントの名前。
FormTypeId - UTF-8 文字列。1～256 バイト長。

このアタッチメントのフォームタイプの識別子。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

DeleteAttachment アクション (Python: delete_attachment)

AWS Glue Data Catalog のアセットからフォームアタッチメントを削除します。

例

次の例では、アセットからアタッチメントを削除します。


aws glue delete-attachment \
        --identifier quarterly-sales-2026q1 \
        --attachment-name reviewNote
    
    {
        "Identifier": "quarterly-sales-2026q1"
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アタッチメントを削除するアセットの一意の識別子。
AttachmentName – 必須: UTF-8 文字列、1～256 バイト長、「String」に一致。

削除するアタッチメントの名前。

[応答]

Identifier – UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListIterableForms アクション (Python: list_iterable_forms)

AWS Glue Data Catalog のアセットの反復可能なフォームの項目を一覧表示します。たとえば、テーブルアセットの列を一覧表示します。

例

次の例では、アセットの列を一覧表示しています。


aws glue list-iterable-forms \
        --asset-identifier quarterly-sales-2026q1 \
        --iterable-form-name columns \
        --max-results 20
    
    {
        "AssetId": "quarterly-sales-2026q1",
        "IterableFormName": "columns",
        "Items": [
            {
                "ItemId": "quarterly-sales-2026q1#region",
                "ItemName": "region",
                "Description": "AWS region of the sales record",
                "GlossaryTerms": []
            },
            {
                "ItemId": "quarterly-sales-2026q1#amount",
                "ItemName": "amount",
                "Description": "Sales amount in USD",
                "GlossaryTerms": []
            }
        ]
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
IterableFormName – 必須: UTF-8 文字列、1～256 バイト長、「String」に一致。

項目を一覧表示する反復可能なフォームの名前。
MaxResults – 1～1000 の数値 (整数)。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。

[応答]

AssetId – UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
IterableFormName – UTF-8 文字列。1～256 バイト長。String に一致。

反復可能なフォームの名前。
Items – IterableFormListItem オブジェクトの配列。

反復可能なフォーム項目のリスト。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException
InvalidInputException

BatchGetIterableForms アクション (Python: batch_get_iterable_forms)

1 つのリクエストで AWS Glue Data Catalog のアセットの反復可能なフォームから複数の項目を取得します。

例

次の例では、識別子で特定の列を取得します。


aws glue batch-get-iterable-forms \
        --asset-identifier quarterly-sales-2026q1 \
        --iterable-form-name columns \
        --item-identifiers region amount
    
    {
        "Items": [
            {
                "ItemId": "quarterly-sales-2026q1#region",
                "ItemName": "region",
                "GlossaryTerms": [],
                "Forms": {
                    "columns": {
                        "FormTypeId": "amazon.glue::Column",
                        "Content": "{\"type\":\"string\"}"
                    }
                },
                "Attachments": {}
            },
            {
                "ItemId": "quarterly-sales-2026q1#amount",
                "ItemName": "amount",
                "GlossaryTerms": [],
                "Forms": {
                    "columns": {
                        "FormTypeId": "amazon.glue::Column",
                        "Content": "{\"type\":\"double\"}"
                    }
                },
                "Attachments": {}
            }
        ],
        "Errors": []
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
IterableFormName – 必須: UTF-8 文字列、1～256 バイト長、「String」に一致。

項目を取得する反復可能なフォームの名前。
ItemIdentifiers – 必須: UTF-8 文字列の配列、1～100 個の文字列。

取得する項目識別子のリスト。各識別子は、項目 ID または項目名にすることができます。

[応答]

Items – IterableFormItem オブジェクトの配列。

取得した反復可能なフォーム項目のリスト。
Errors – ItemError オブジェクトの配列。

取得できなかった項目のエラーのリスト。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ThrottlingException

CreateGlossary アクション (Python: create_glossary)

AWS Glue Data Catalog でビジネス用語集を作成します。用語集は、ビジネス概念を定義する用語集の用語のコンテナです。

例

次の例では、ビジネス用語集を作成します。


aws glue create-glossary \
        --name "Sales Terms" \
        --description "Glossary of sales-domain business terms"
    
    {
        "Id": "6n5f21s641nbjb",
        "Name": "Sales Terms",
        "Description": "Glossary of sales-domain business terms"
    }

[リクエスト]

Name – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

用語集の名前。
Description – UTF-8 文字列。1～2,048 バイト長。

用語集の説明。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id – UTF-8 文字列。

用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の名前。
Description – UTF-8 文字列。1～2,048 バイト長。

用語集の説明。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

GetGlossary アクション (Python: get_glossary)

AWS Glue Data Catalog のビジネス用語集を識別子で取得します。

例

次の例では、識別子で用語集を取得します。


aws glue get-glossary --identifier 6n5f21s641nbjb
    
    {
        "Id": "6n5f21s641nbjb",
        "Name": "Sales Terms",
        "Description": "Glossary of sales-domain business terms"
    }

[リクエスト]

Identifier – 必須: UTF–8 文字列。

取得する用語集の一意の識別子。

[応答]

Id – UTF-8 文字列。

用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の名前。
Description – UTF-8 文字列。1～2,048 バイト長。

用語集の説明。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

UpdateGlossary アクション (Python: update_glossary)

AWS Glue Data Catalog のビジネス用語集を更新します。

例

次の例では、用語集の説明を更新します。


aws glue update-glossary \
        --identifier 6n5f21s641nbjb \
        --name "Sales Terms" \
        --description "Glossary of sales and revenue business terms"
    
    {
        "Id": "6n5f21s641nbjb",
        "Name": "Sales Terms",
        "Description": "Glossary of sales and revenue business terms"
    }

[リクエスト]

Identifier – 必須: UTF–8 文字列。

更新される用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の更新された名前。
Description – UTF-8 文字列。1～2,048 バイト長。

用語集の更新された説明。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id – UTF-8 文字列。

用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の名前。
Description – UTF-8 文字列。1～2,048 バイト長。

用語集の説明。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

DeleteGlossary アクション (Python: delete_glossary)

AWS Glue Data Catalog からビジネス用語集を削除します。用語集の用語がまだ含まれている場合、用語集を削除することはできません。

例

次の例では、用語集を識別子で削除します。


aws glue delete-glossary --identifier 6n5f21s641nbjb

[リクエスト]

Identifier – 必須: UTF–8 文字列。

削除される用語集の一意の識別子。

[応答]

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

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConflictException
ConcurrentModificationException
ThrottlingException

ListGlossaries アクション (Python: list_glossaries)

AWS Glue Data Catalog のビジネス用語集を一覧表示します。

例

次の例では、アカウント内の用語集を一覧表示します。


aws glue list-glossaries --max-results 20
    
    {
        "Items": [
            {
                "Id": "6n5f21s641nbjb",
                "Name": "Sales Terms",
                "Description": "Glossary of sales and revenue business terms"
            }
        ]
    }

[リクエスト]

MaxResults – 1～1000 の数値 (整数)。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。

応答

Items – オブジェクトの配列。

用語集項目のリスト。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

CreateGlossaryTerm アクション (Python: create_glossary_term)

AWS Glue Data Catalog のビジネス用語集内に用語集の用語を作成します。

例

次の例では、用語集の用語を作成します。


aws glue create-glossary-term \
        --glossary-identifier 6n5f21s641nbjb \
        --name "Net Revenue" \
        --short-description "Revenue after returns, allowances, and discounts." \
        --long-description "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period."
    
    {
        "Id": "avugvxvsul6izr",
        "GlossaryId": "6n5f21s641nbjb",
        "Name": "Net Revenue",
        "ShortDescription": "Revenue after returns, allowances, and discounts.",
        "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period."
    }

[リクエスト]

GlossaryIdentifier – 必須: UTF–8 文字列。

用語を作成する用語集の一意の識別子。
Name – 必須:UTF-8 文字列。1 バイト以上 256 バイト未満。

用語集の用語の名前。
ShortDescription – UTF-8 文字列。1～1024 バイト長。

用語集の用語の簡単な説明。
LongDescription – UTF-8 文字列。1～4096 バイト長。

用語集の用語の長い説明。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id – UTF-8 文字列。

用語集の用語の一意の識別子。
GlossaryId – UTF–8 文字列。

この用語を含む用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の用語の名前。
ShortDescription – UTF-8 文字列。1～1024 バイト長。

用語集の用語の簡単な説明。
LongDescription – UTF-8 文字列。1～4096 バイト長。

用語集の用語の長い説明。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

GetGlossaryTerm アクション (Python: get_glossary_term)

AWS Glue Data Catalog の用語集の用語を識別子で取得します。

例

次の例では、識別子で用語集の用語を取得します。


aws glue get-glossary-term --identifier avugvxvsul6izr
    
    {
        "Id": "avugvxvsul6izr",
        "GlossaryId": "6n5f21s641nbjb",
        "Name": "Net Revenue",
        "ShortDescription": "Revenue after returns, allowances, and discounts.",
        "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period."
    }

[リクエスト]

Identifier – 必須: UTF–8 文字列。

取得する用語集の用語の一意の識別子。

[応答]

Id – UTF-8 文字列。

用語集の用語の一意の識別子。
GlossaryId – UTF–8 文字列。

この用語を含む用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の用語の名前。
ShortDescription – UTF-8 文字列。1～1024 バイト長。

用語集の用語の簡単な説明。
LongDescription – UTF-8 文字列。1～4096 バイト長。

用語集の用語の長い説明。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
ThrottlingException

UpdateGlossaryTerm アクション (Python: update_glossary_term)

AWS Glue Data Catalog の用語集の用語を更新します。

例

次の例では、用語集の用語の短い説明を更新します。


aws glue update-glossary-term \
        --identifier avugvxvsul6izr \
        --name "Net Revenue" \
        --short-description "Gross revenue minus returns, allowances, and discounts." \
        --long-description "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period."
    
    {
        "Id": "avugvxvsul6izr",
        "GlossaryId": "6n5f21s641nbjb",
        "Name": "Net Revenue",
        "ShortDescription": "Gross revenue minus returns, allowances, and discounts.",
        "LongDescription": "Net revenue is gross revenue minus returns, allowances, and discounts over a reporting period."
    }

[リクエスト]

Identifier – 必須: UTF–8 文字列。

更新される用語集の用語の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の用語の更新された名前。
ShortDescription – UTF-8 文字列。1～1024 バイト長。

用語集の用語の更新された簡単な説明。
LongDescription – UTF-8 文字列。1～4096 バイト長。

用語集の用語の更新された長い説明。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Id – UTF-8 文字列。

用語集の用語の一意の識別子。
GlossaryId – UTF–8 文字列。

この用語を含む用語集の一意の識別子。
Name - UTF-8 文字列。1～256 バイト長。

用語集の用語の名前。
ShortDescription – UTF-8 文字列。1～1024 バイト長。

用語集の用語の簡単な説明。
LongDescription – UTF-8 文字列。1～4096 バイト長。

用語集の用語の長い説明。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException
AlreadyExistsException

DeleteGlossaryTerm アクション (Python: delete_glossary_term)

AWS Glue Data Catalog から用語集の用語を削除します。

例

次の例では、用語集の用語を識別子で削除します。


aws glue delete-glossary-term --identifier avugvxvsul6izr

[リクエスト]

Identifier – 必須: UTF–8 文字列。

削除される用語集の用語の一意の識別子。

[応答]

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

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

ListGlossaryTerms アクション (Python: list_glossary_terms)

AWS Glue Data Catalog のビジネス用語集内の用語集の用語を一覧表示します。

例

次の例では、用語集の用語を一覧表示します。


aws glue list-glossary-terms \
        --glossary-identifier 6n5f21s641nbjb \
        --max-results 20
    
    {
        "Items": [
            {
                "Id": "avugvxvsul6izr",
                "Name": "Net Revenue",
                "ShortDescription": "Gross revenue minus returns, allowances, and discounts."
            }
        ]
    }

[リクエスト]

GlossaryIdentifier – 必須: UTF–8 文字列。

一覧表示する用語がある用語集の一意の識別子。
MaxResults – 1～1000 の数値 (整数)。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。

[応答]

GlossaryId – UTF-8 文字列。

用語集の一意の識別子。
Items – オブジェクトの配列。

用語集の用語の項目のリスト。
NextToken – UTF–8 文字列。

継続トークン (現在のセグメントが最後ではない場合に表示されます)。

エラー

AccessDeniedException
InternalServiceException
InvalidInputException
ThrottlingException

AssociateGlossaryTerms アクション (Python: associate_glossary_terms)

1 つ以上の用語集の用語を AWS Glue Data Catalog のアセットに関連付けます。

例

次の例では、用語集の用語をアセットに関連付けます。


aws glue associate-glossary-terms \
        --identifier quarterly-sales-2026q1 \
        --glossary-term-identifiers avugvxvsul6izr
    
    {
        "Identifier": "quarterly-sales-2026q1",
        "GlossaryTerms": [
            "avugvxvsul6izr"
        ]
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

用語集の用語を関連付けるアセットの一意の識別子。
GlossaryTermIdentifiers – 必須: UTF-8 文字列の配列、1～10 個の文字列。

アセットに関連付ける用語集の用語の識別子のリスト。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Identifier – UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
GlossaryTerms – UTF-8 文字列の配列、1～10 個の文字列。

アセットに関連付けられている用語集の用語。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

DisassociateGlossaryTerms アクション (Python: disassociate_glossary_terms)

AWS Glue Data Catalog のアセットから 1 つ以上の用語集の用語の関連付けを削除します。

例

次の例では、アセットから用語集の用語を削除します。


aws glue disassociate-glossary-terms \
        --identifier quarterly-sales-2026q1 \
        --glossary-term-identifiers avugvxvsul6izr
    
    {
        "Identifier": "quarterly-sales-2026q1",
        "GlossaryTerms": []
    }

[リクエスト]

AssetIdentifier – 必須: UTF-8 文字列。1～1087 バイト長。String に一致。

用語集の用語の関連付けを解除するアセットの一意の識別子。
GlossaryTermIdentifiers – 必須: UTF-8 文字列の配列、1～10 個の文字列。

アセットとの関連付けを解除する用語集の用語の識別子のリスト。
ClientToken – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別)。

[応答]

Identifier – UTF-8 文字列。1～1087 バイト長。String に一致。

アセットの一意の識別子。
GlossaryTerms – UTF-8 文字列の配列、1～10 個の文字列。

アセットに関連付けられた残りの用語集の用語。

エラー

AccessDeniedException
EntityNotFoundException
InternalServiceException
InvalidInputException
ConcurrentModificationException
ThrottlingException

Search アクション (Python: search)

全文検索、フィルター、ソート、集計を使用して、AWS Glue Data Catalog 内のアセットを検索します。関連性ランクの結果を持つ一致するアセットを返します。

例

次の例では、アセットの全文検索を実行します。


aws glue search --search-text "sales" --max-results 10
    
    {
        "Items": [
            {
                "Id": "quarterly-sales-2026q1",
                "AssetName": "Quarterly Sales 2026 Q1",
                "AssetDescription": "Aggregated quarterly sales metrics",
                "UpdatedAt": "2026-06-16T06:42:00.442Z",
                "AssetTypeId": "DataSet"
            }
        ]
    }

例

次の例では、フィルター句とソート順で検索します。


aws glue search \
        --search-text "sales" \
        --max-results 10 \
        --filter-clause '{"AttributeFilter":{"Attribute":"AssetTypeId","Operator":"equals","Value":{"StringValue":"DataSet"}}}' \
        --sort '{"Attribute":"name","Order":"ASCENDING"}'
    
    {
        "Items": [
            {
                "Id": "quarterly-sales-2026q1",
                "AssetName": "Quarterly Sales 2026 Q1",
                "AssetDescription": "Aggregated quarterly sales metrics",
                "UpdatedAt": "2026-06-16T06:42:00.442Z",
                "AssetTypeId": "DataSet"
            }
        ]
    }

例

次の例では、フォームで定義されたフィールドをフィルタリングします。フォームフィールドは、フォームのアセットタイプ識別子とフィールド名によって参照され、ドットで結合されます。ここでは amazon.glue::GlueTable フォームの databaseName フィールドです。組み込みタイプのアセットタイプの識別子には、各結果の AssetTypeId に示されている :: プレフィックスが付きます。


aws glue search \
        --filter-clause '{"AttributeFilter":{"Attribute":"amazon.glue::GlueTable.databaseName","Operator":"equals","Value":{"StringValue":"sales"}}}' \
        --max-results 10
    
    {
        "Items": [
            {
                "Id": "arn:aws:glue:us-east-1:123456789012:table/sales/transactions",
                "AssetName": "transactions",
                "AssetDescription": "Raw sales transactions",
                "UpdatedAt": "2026-06-16T06:42:00.442Z",
                "AssetTypeId": "amazon.glue::GlueTable"
            }
        ]
    }

例

次の例では、共通アセットフィールドとフォームフィールドを論理 AND と組み合わせています。name、type、region、catalogId などの共通アセットフィールドは直接参照されます。フォームで定義されるフィールドは assetTypeId.fieldName 表記を使用します。


aws glue search \
        --filter-clause '{"AndAllFilters":[{"AttributeFilter":{"Attribute":"type","Operator":"equals","Value":{"StringValue":"Table"}}},{"AttributeFilter":{"Attribute":"amazon.glue::GlueTable.databaseName","Operator":"equals","Value":{"StringValue":"sales"}}}]}' \
        --max-results 10
    
    {
        "Items": [
            {
                "Id": "arn:aws:glue:us-east-1:123456789012:table/sales/transactions",
                "AssetName": "transactions",
                "AssetDescription": "Raw sales transactions",
                "UpdatedAt": "2026-06-16T06:42:00.442Z",
                "AssetTypeId": "amazon.glue::GlueTable"
            }
        ]
    }

[リクエスト]

SearchText – UTF-8 文字列。1～1000 バイト長。

検索するテキスト。少なくとも 1 つ以上の searchText または filterClause を指定する必要があります。
MaxResults – 数値 (integer)。1～100。

レスポンスとして返す結果の最大数。
NextToken – UTF-8 文字列。

継続トークン (これが継続呼び出しの場合)。
Sort – SearchSort オブジェクト。

検索結果のソート条件。
FilterClause – SearchFilterClause オブジェクト。

検索に適用するフィルター句。属性レベルおよびマップレベルのフィルターでネストされた AND/OR ロジックをサポートします。

[応答]

Search オペレーションのレスポンス構造。

SearchOutput – SearchOutput オブジェクト。

エラー

AccessDeniedException
InvalidInputException
InternalServiceException
ThrottlingException

ドキュメントの表記規則

カタログ

データベース