AWS Glue

2026/11/20 - AWS Glue - 9 updated api methods

Changes  Minor updates to the Glue Business Context APIs

AssociateGlossaryTerms (updated) Link ¶
Changes (response)
{'AssetId': 'string', 'ItemId': 'string'}

Associates one or more glossary terms with an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.associate_glossary_terms(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    GlossaryTermIdentifiers=[
        'string',
    ],
    ClientToken='string'
)
type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to associate glossary terms with.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the glossary terms are associated with an item within the iterable form rather than the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type GlossaryTermIdentifiers:

list

param GlossaryTermIdentifiers:

[REQUIRED]

The list of glossary term identifiers to associate with the asset.

  • (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetId': 'string',
    'IterableFormName': 'string',
    'ItemId': 'string',
    'GlossaryTerms': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • AssetId (string) --

      The unique identifier of the asset.

    • IterableFormName (string) --

      The name of the iterable form, if the association targets an item.

    • ItemId (string) --

      The identifier of the item within the iterable form, if applicable.

    • GlossaryTerms (list) --

      The glossary terms now associated with the asset.

      • (string) --

DeleteAttachment (updated) Link ¶
Changes (response)
{'AssetId': 'string', 'ItemId': 'string'}

Deletes a form attachment from an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.delete_attachment(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    AttachmentName='string'
)
type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset from which to delete the attachment.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the attachment is deleted from an item within the iterable form rather than from the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type AttachmentName:

string

param AttachmentName:

[REQUIRED]

The name of the attachment to delete.

rtype:

dict

returns:

Response Syntax

{
    'AssetId': 'string',
    'IterableFormName': 'string',
    'ItemId': 'string'
}

Response Structure

  • (dict) --

    • AssetId (string) --

      The unique identifier of the asset.

    • IterableFormName (string) --

      The name of the iterable form, if the deletion targets an item.

    • ItemId (string) --

      The identifier of the item within the iterable form, if applicable.

DisassociateGlossaryTerms (updated) Link ¶
Changes (response)
{'AssetId': 'string', 'ItemId': 'string'}

Removes the association of one or more glossary terms from an asset in Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.disassociate_glossary_terms(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    GlossaryTermIdentifiers=[
        'string',
    ],
    ClientToken='string'
)
type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to disassociate glossary terms from.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the glossary terms are disassociated from an item within the iterable form rather than the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type GlossaryTermIdentifiers:

list

param GlossaryTermIdentifiers:

[REQUIRED]

The list of glossary term identifiers to disassociate from the asset.

  • (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetId': 'string',
    'IterableFormName': 'string',
    'ItemId': 'string',
    'GlossaryTerms': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • AssetId (string) --

      The unique identifier of the asset.

    • IterableFormName (string) --

      The name of the iterable form, if the disassociation targets an item.

    • ItemId (string) --

      The identifier of the item within the iterable form, if applicable.

    • GlossaryTerms (list) --

      The remaining glossary terms associated with the asset.

      • (string) --

GetAssetType (updated) Link ¶
Changes (response)
{'Forms': {'FormTypeId': 'string'}}

Retrieves an asset type in Glue Data Catalog by its identifier.

See also: AWS API Documentation

Request Syntax

client.get_asset_type(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

The identifier of the asset type to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Name': 'string',
    'Forms': {
        'string': {
            'FormTypeId': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Id (string) --

      The identifier of the asset type.

    • Name (string) --

      The name of the asset type.

    • Forms (dict) --

      The forms that make up the asset type, keyed by form name.

      • (string) --

        • (dict) --

          A form that is included in an asset type, identified by the form type that defines its schema.

          • FormTypeId (string) --

            The identifier of the form type that defines the form's schema.

GetDataCatalogExportConfiguration (updated) Link ¶
Changes (response)
{'Assets': {'S3TablesExport': 'ENABLED | DISABLED',
            'S3TablesExportState': {'Status': 'ENABLING | ENABLED | DISABLING '
                                              '| DISABLED | FAILED'}},
 'S3TablesConfiguration': {'EncryptionConfiguration': {'KmsKeyArn': 'string',
                                                       'SseAlgorithm': 'string'},
                           'TableBucketArn': 'string'}}

Retrieves the current export configuration for the Glue Data Catalog. The export configuration controls whether catalog metadata is exported to S3 Tables.

See also: AWS API Documentation

Request Syntax

client.get_data_catalog_export_configuration()
rtype:

dict

returns:

Response Syntax

{
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'S3TablesConfiguration': {
        'TableBucketArn': 'string',
        'EncryptionConfiguration': {
            'SseAlgorithm': 'string',
            'KmsKeyArn': 'string'
        }
    },
    'Assets': {
        'S3TablesExport': 'ENABLED'|'DISABLED',
        'S3TablesExportState': {
            'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'FAILED'
        }
    }
}

Response Structure

  • (dict) --

    The export configuration returned by the GetDataCatalogExportConfiguration operation.

    • CreatedAt (datetime) --

      The timestamp at which the export configuration was created.

    • UpdatedAt (datetime) --

      The timestamp at which the export configuration was last updated.

    • S3TablesConfiguration (dict) --

      The S3 Tables configuration for the export, including the table bucket that holds the exported catalog metadata and its encryption configuration.

      • TableBucketArn (string) --

        The ARN of the S3 table bucket that holds the exported catalog metadata.

      • EncryptionConfiguration (dict) --

        The encryption configuration for the table bucket that holds the exported catalog metadata.

        • SseAlgorithm (string) --

          The server-side encryption algorithm used for the exported data. Valid values are AES256 and aws:kms.

        • KmsKeyArn (string) --

          The ARN of the KMS key used to encrypt the exported data.

    • Assets (dict) --

      The export setting and current export state for asset metadata.

      • S3TablesExport (string) --

        Whether asset metadata is exported to S3 Tables. Valid values are ENABLED and DISABLED.

      • S3TablesExportState (dict) --

        The current state of the asset metadata export to S3 Tables.

        • Status (string) --

          The current status of the export. Valid values are ENABLING, ENABLED, DISABLING, DISABLED, and FAILED.

PutAsset (updated) Link ¶
Changes (request, response)
Request
{'AssetTypeIdentifier': 'string', 'Forms': {'FormTypeIdentifier': 'string'}}
Response
{'AssetTypeId': 'string'}

Creates or updates an asset in Glue Data Catalog. If the asset already exists, this operation updates it; otherwise, a new asset is created.

See also: AWS API Documentation

Request Syntax

client.put_asset(
    AssetTypeIdentifier='string',
    Identifier='string',
    Name='string',
    Description='string',
    Forms={
        'string': {
            'FormTypeIdentifier': 'string',
            'Content': 'string'
        }
    },
    ClientToken='string'
)
type AssetTypeIdentifier:

string

param AssetTypeIdentifier:

The identifier of the asset type for the asset. This field is required.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the asset. If an asset with this identifier already exists, it is updated.

type Name:

string

param Name:

[REQUIRED]

The name of the asset.

type Description:

string

param Description:

The description of the asset.

type Forms:

dict

param Forms:

[REQUIRED]

The forms to set on the asset, keyed by form name. Each entry specifies the form type and its JSON content.

  • (string) --

    • (dict) --

      A form to set on an asset, consisting of the form type identifier and its JSON content.

      • FormTypeIdentifier (string) --

        The identifier of the form type that defines this form's schema. This field is required.

      • Content (string) --

        The JSON content of the form, conforming to the schema of the specified form type.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'AssetTypeId': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Forms': {
        'string': {
            'FormTypeId': 'string',
            'Content': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the asset.

    • Name (string) --

      The name of the asset.

    • Description (string) --

      The description of the asset.

    • AssetTypeId (string) --

      The identifier of the asset type for this asset.

    • CreatedAt (datetime) --

      The timestamp at which the asset was created.

    • Forms (dict) --

      The forms attached to the asset, keyed by form name.

      • (string) --

        • (dict) --

          A form on an asset, consisting of the form type identifier and its JSON content.

          • FormTypeId (string) --

            The identifier of the form type that defines this form's schema.

          • Content (string) --

            The JSON content of the form, conforming to the schema of the specified form type.

PutAttachment (updated) Link ¶
Changes (request, response)
Request
{'FormTypeIdentifier': 'string'}
Response
{'AssetId': 'string', 'ItemId': 'string'}

Attaches a form to an asset or an iterable form item in Glue Data Catalog. If an attachment with the same name already exists, it is overwritten.

See also: AWS API Documentation

Request Syntax

client.put_attachment(
    AssetIdentifier='string',
    IterableFormName='string',
    ItemIdentifier='string',
    AttachmentName='string',
    Content='string',
    FormTypeIdentifier='string',
    ClientToken='string'
)
type AssetIdentifier:

string

param AssetIdentifier:

[REQUIRED]

The unique identifier of the asset to attach the form to.

type IterableFormName:

string

param IterableFormName:

The name of the iterable form. When specified along with itemIdentifier, the attachment targets an item within the iterable form rather than the asset itself.

type ItemIdentifier:

string

param ItemIdentifier:

The identifier of the item within the iterable form. Required when iterableFormName is specified.

type AttachmentName:

string

param AttachmentName:

[REQUIRED]

The name of the attachment.

type Content:

string

param Content:

[REQUIRED]

The JSON content of the form, conforming to the schema of the specified form type.

type FormTypeIdentifier:

string

param FormTypeIdentifier:

The identifier of the form type for this attachment. This field is required.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'AssetId': 'string',
    'IterableFormName': 'string',
    'ItemId': 'string',
    'AttachmentName': 'string',
    'FormTypeId': 'string'
}

Response Structure

  • (dict) --

    • AssetId (string) --

      The unique identifier of the asset.

    • IterableFormName (string) --

      The name of the iterable form, if the attachment targets an item.

    • ItemId (string) --

      The identifier of the item within the iterable form, if applicable.

    • AttachmentName (string) --

      The name of the attachment.

    • FormTypeId (string) --

      The identifier of the form type for this attachment.

PutDataCatalogExportConfiguration (updated) Link ¶
Changes (both)
{'Assets': {'S3TablesExport': 'ENABLED | DISABLED'},
 'S3TablesConfiguration': {'EncryptionConfiguration': {'KmsKeyArn': 'string',
                                                       'SseAlgorithm': 'string'}}}

Creates or updates the export configuration for the Glue Data Catalog. Use this operation to enable or disable the export of catalog metadata to S3 Tables.

See also: AWS API Documentation

Request Syntax

client.put_data_catalog_export_configuration(
    ClientToken='string',
    S3TablesConfiguration={
        'EncryptionConfiguration': {
            'SseAlgorithm': 'string',
            'KmsKeyArn': 'string'
        }
    },
    Assets={
        'S3TablesExport': 'ENABLED'|'DISABLED'
    }
)
type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type S3TablesConfiguration:

dict

param S3TablesConfiguration:

The S3 Tables configuration for the export. The encryption configuration applies only when Glue creates the table bucket that holds the exported catalog metadata. If not specified, the default encryption settings are used.

  • EncryptionConfiguration (dict) --

    The encryption configuration for the table bucket that holds the exported catalog metadata. It applies only when Glue creates the table bucket.

    • SseAlgorithm (string) --

      The server-side encryption algorithm used for the exported data. Valid values are AES256 and aws:kms.

    • KmsKeyArn (string) --

      The ARN of the KMS key used to encrypt the exported data.

type Assets:

dict

param Assets:

The export setting for asset metadata. Set S3TablesExport to ENABLED to start exporting asset metadata to S3 Tables, or to DISABLED to stop exporting.

  • S3TablesExport (string) --

    Whether asset metadata is exported to S3 Tables. Valid values are ENABLED and DISABLED.

rtype:

dict

returns:

Response Syntax

{
    'S3TablesConfiguration': {
        'EncryptionConfiguration': {
            'SseAlgorithm': 'string',
            'KmsKeyArn': 'string'
        }
    },
    'Assets': {
        'S3TablesExport': 'ENABLED'|'DISABLED'
    }
}

Response Structure

  • (dict) --

    The export configuration returned by the PutDataCatalogExportConfiguration operation.

    • S3TablesConfiguration (dict) --

      The S3 Tables configuration for the export.

      • EncryptionConfiguration (dict) --

        The encryption configuration for the table bucket that holds the exported catalog metadata. It applies only when Glue creates the table bucket.

        • SseAlgorithm (string) --

          The server-side encryption algorithm used for the exported data. Valid values are AES256 and aws:kms.

        • KmsKeyArn (string) --

          The ARN of the KMS key used to encrypt the exported data.

    • Assets (dict) --

      The export setting for asset metadata.

      • S3TablesExport (string) --

        Whether asset metadata is exported to S3 Tables. Valid values are ENABLED and DISABLED.

SearchAssets (updated) Link ¶
Changes (request, response)
Request
{'FilterClause': {'AttributeFilter': {'Comparator': 'EQUALS | GREATER_THAN | '
                                                    'GREATER_THAN_OR_EQUALS | '
                                                    'LESS_THAN | '
                                                    'LESS_THAN_OR_EQUALS | '
                                                    'NOT_EXISTS'}}}
Response
{'Items': {'CreatedAt': 'timestamp', 'Description': 'string', 'Name': 'string'}}

Searches for assets in Glue Data Catalog using full-text search, filters, and sorting. Returns matching assets with relevance-ranked results.

See also: AWS API Documentation

Request Syntax

client.search_assets(
    SearchText='string',
    MaxResults=123,
    NextToken='string',
    Sort={
        'Attribute': 'string',
        'Order': 'ASCENDING'|'DESCENDING'
    },
    FilterClause={
        'AndAllFilters': [
            {'... recursive ...'},
        ],
        'OrAnyFilters': [
            {'... recursive ...'},
        ],
        'AttributeFilter': {
            'Attribute': 'string',
            'Comparator': 'EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'NOT_EXISTS',
            'Value': {
                'StringValue': 'string',
                'LongValue': 123
            }
        },
        'MapFilter': {
            'Attribute': 'string',
            'Key': 'string',
            'Value': {
                'StringValue': 'string'
            }
        }
    }
)
type SearchText:

string

param SearchText:

The text to search for. At least one of searchText or filterClause must be provided.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response.

type NextToken:

string

param NextToken:

A continuation token, if this is a continuation call.

type Sort:

dict

param Sort:

The sort criteria for the search results.

  • Attribute (string) -- [REQUIRED]

    The attribute to sort by.

  • Order (string) --

    The sort order. Valid values are ASCENDING and DESCENDING.

type FilterClause:

dict

param FilterClause:

The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

  • AndAllFilters (list) --

    A list of filter clauses that must all match (logical AND).

    • (dict) --

      A filter clause that supports nested boolean logic. Exactly one of andAllFilters, orAnyFilters, attributeFilter, or mapFilter must be specified.

  • OrAnyFilters (list) --

    A list of filter clauses where at least one must match (logical OR).

    • (dict) --

      A filter clause that supports nested boolean logic. Exactly one of andAllFilters, orAnyFilters, attributeFilter, or mapFilter must be specified.

  • AttributeFilter (dict) --

    A filter on a single attribute value.

    • Attribute (string) -- [REQUIRED]

      The attribute name to filter on.

    • Comparator (string) --

      The comparison operator. Valid values are EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, and NOT_EXISTS. This field is required.

    • Value (dict) --

      The value to compare against.

      • StringValue (string) --

        A string filter value.

      • LongValue (integer) --

        A long integer filter value.

  • MapFilter (dict) --

    A filter on a map attribute's key-value pair.

    • Attribute (string) -- [REQUIRED]

      The map attribute name to filter on.

    • Key (string) -- [REQUIRED]

      The key within the map attribute to filter on.

    • Value (dict) -- [REQUIRED]

      The value to compare against.

      • StringValue (string) --

        A string filter value.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'AssetTypeId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The search results returned by the SearchAssets operation.

    • Items (list) --

      The list of assets matching the search criteria.

      • (dict) --

        A single search result item representing a matched asset.

        • Id (string) --

          The unique identifier of the matched asset.

        • Name (string) --

          The name of the matched asset.

        • Description (string) --

          The description of the matched asset.

        • CreatedAt (datetime) --

          The timestamp at which the matched asset was created.

        • UpdatedAt (datetime) --

          The timestamp at which the matched asset was last updated.

        • AssetTypeId (string) --

          The identifier of the asset type for the matched asset.

    • NextToken (string) --

      A continuation token, present if the current segment is not the last.