View a markdown version of this page

业务上下文 API - AWS Glue
 —  数据类型  —AssetFormentryAssetTypeFormReferenceIterableFormEntryIterableFormItemIterableFormListItemSearchResultItemSearchSortSearchFilterClauseSearchAttributeFilterSearchFilterValueItemErrorGetAssetOutputSearchOutput —  操作  —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 (search)

业务上下文 API

业务上下文 API 描述了用于管理资产、资产类型、表单类型、术语表条目、附件和在 AWS Glue Data Catalog 中搜索的数据类型和操作。

数据类型

AssetFormEntry 结构

资产上的表单，由表单类型标识符及其 JSON 内容组成。

字段

  • FormTypeId – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节。

    定义此表单架构的表单类型的标识符。

  • Content – UTF-8 字符串。

    表单的 JSON 内容，符合指定表单类型的架构。

AsetTypeForm 结构

对资产类型中包含的表单类型的引用。

字段

  • FormTypeIdentifier：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 256 个字节。

    所引用的表单类型的标识符。

IterableFormEntry 结构

资产上可用的可迭代表单，由其表单类型标识。

字段

  • FormTypeId – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节。

    可迭代表单（例如 columns）的表单类型标识符，用于通过 ListIterableForms 或 BatchGetIterableForms 检索其项目。

IterableFormItem 结构

一个完整的可迭代表单项及其表单。

字段

  • ItemId – UTF-8 字符串。

    项目的唯一标识符。

  • ItemName – UTF-8 字符串。

    物品的名称。

  • GlossaryTerms – UTF-8 字符串数组，不少于 1 个字符串，不超过 10 个字符串。

    与项目关联的术语表条目的标识符。

  • Forms – 键值对的映射数组。

    每个键是一个 UTF-8 字符串。

    每个值都是一个 AssetFormentry 对象。

    项目上的表单，按表单名称键入。

  • Attachments – 键值对的映射数组。

    每个键是一个 UTF-8 字符串。

    每个值都是一个 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。

字段

  • AndAllFilters – SearchFilterClause 对象的数组，长度不少于 1 个结构，不超过 10 个结构。

    必须全部匹配的筛选子句列表（逻辑与）。

  • OrAnyFilters – SearchFilterClause 对象的数组，长度不少于 1 个结构，不超过 10 个结构。

    筛选子句列表，其中至少有一个必须匹配（逻辑或）。

  • AttributeFilter – 一个 SearchAttributeFilter 对象。

    单个属性值的筛选器。

  • 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 – 数字（长型）。

    长整数筛选器值。

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 – .

    创建资产的主体的身份。

  • UpdatedBy – .

    上次更新资产的主体的身份。

  • AssetTypeId：必需：UTF-8 字符串，长度不少于 1 个字节，不超过 256 个字节。

    该资产的资产类型的标识符。

  • GlossaryTerms – UTF-8 字符串数组，不少于 1 个字符串，不超过 10 个字符串。

    与资产相关的术语表条目的标识符。

  • Forms – 键值对的映射数组。

    每个键是一个 UTF-8 字符串。

    每个值都是一个 AssetFormentry 对象。

    资产上的表单，按表单名称键入。

  • Attachments – 键值对的映射数组。

    每个键是一个 UTF-8 字符串。

    每个值都是一个 AssetFormentry 对象。

    资产上的附加附件，按附件名称键入，以提供更多上下文信息。

  • IterableForms – 键值对的映射数组。

    每个键是一个 UTF-8 字符串。

    每个值都是一个 IterableFormEntry 对象。

    资产上可用的可迭代表单，按表单名称键入（例如 columns）。使用表单名称和 ListIterableForms 或 BatchGetIterableForms 检索表单的项目。

SearchOutput 结构

Search 操作的响应结构。

字段

  • Items – SearchResultItem 对象的数组。

    符合搜索条件的资产列表。

  • TotalCount – 数字（整数）。

    符合搜索条件的资产总数。

  • NextToken – UTF-8 字符串。

    延续令牌，如果当前片段不是最后一个片段则呈现。

  • Aggregations–对象的数组。

    请求属性的聚合结果。

操作

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 操作的响应结构。

错误

  • 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 字符串。

    每个值都是一个 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 字符串。

    每个值都是一个 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 匹配。

    每个值都是一个 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 匹配。

    每个值都是一个 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 匹配。

    每个值都是一个 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)

在单个请求中检索 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 个字节，不超过 2048 个字节。

    术语表的描述。

  • ClientToken – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

    用于确保请求的幂等性而提供的唯一、区分大小写的标识符。

响应

  • Id – UTF-8 字符串。

    术语表的唯一标识符。

  • Name – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节。

    术语表的名称。

  • Description：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

    术语表的描述。

错误

  • 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 个字节，不超过 2048 个字节。

    术语表的描述。

错误

  • 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 个字节，不超过 2048 个字节。

    术语表的更新描述。

  • ClientToken – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

    用于确保请求的幂等性而提供的唯一、区分大小写的标识符。

响应

  • Id – UTF-8 字符串。

    术语表的唯一标识符。

  • Name – UTF-8 字符串，长度不少于 1 个字节或超过 256 个字节。

    术语表的名称。

  • Description：UTF-8 字符串，长度不少于 1 个字节，不超过 2048 个字节。

    术语表的描述。

错误

  • 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)

将一个或多个术语表条目与 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 中的资产中移除一个或多个术语表条目的关联。

例

以下示例从资产中删除术语表条目。

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

使用全文搜索、筛选器、排序和聚合在 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"
            }
        ]
    }
例

以下示例将常见资产字段和表单字段与逻辑与组合在一起。诸如 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 个字节。

    要搜索的文本。必须至少提供 searchText 或 filterClause 之一。

  • MaxResults – 数字（整数），不小于 1 或大于 100。

    要在响应中返回的结果数量上限。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

  • Sort – 一个 SearchSort 对象。

    搜索结果的排序条件。

  • FilterClause – 一个 SearchFilterClause 对象。

    要应用于搜索的筛选子句。支持带有属性级和地图级筛选器的嵌套与/或逻辑。

响应

Search 操作的响应结构。

错误

  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

  • ThrottlingException