assets

Creates, updates, deletes, gets or lists an assets resource.

Overview

Name	assets
Type	Resource
Id	aws.glue.assets

Fields

The following fields are returned by SELECT queries:

get_asset

Name	Datatype	Description
asset_type_id	string	The identifier of the asset type for this asset.
attachments	object	Additional attachments on the asset for more context, keyed by attachment name.
created_at	string (date-time)	The timestamp at which the asset was created.
description	string	The description of the asset.
forms	object	The forms on the asset, keyed by form name.
glossary_terms	array	The identifiers of the glossary terms associated with the asset.
id	string	The unique identifier of the asset. (pattern: <code>[a-zA-Z0-9-:/._*]+</code>)
iterable_forms	object	The iterable forms available on the asset, keyed by form name (for example, columns). Use the form name with ListIterableForms or BatchGetIterableForms to retrieve the form's items.
name	string	The name of the asset.
updated_at	string (date-time)	The timestamp at which the asset was last updated.

search_assets

Name	Datatype	Description
asset_description	string	The description of the matched asset.
asset_name	string	The name of the matched asset.
asset_type_id	string	The identifier of the asset type for the matched asset.
id	string	The unique identifier of the matched asset. (pattern: <code>[a-zA-Z0-9-:/._*]+</code>)
updated_at	string (date-time)	The timestamp at which the matched asset was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_asset	select	region		Retrieves the metadata for an asset in Glue Data Catalog, including its forms, additional attachments, and associated glossary terms.
search_assets	select	region		Searches for assets in Glue Data Catalog using full-text search, filters, sorting, and aggregations. Returns matching assets with relevance-ranked results.
update_asset	update	region, Identifier		Updates the name and description of an existing asset in Glue Data Catalog. Only the fields that you provide are updated.
put_attachment	replace	region, AssetIdentifier, AttachmentName, Content, FormTypeId		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.
put_asset	replace	region, AssetTypeId, Identifier		Creates or updates an asset in Glue Data Catalog. If the asset already exists, this operation updates it; otherwise, a new asset is created.
delete_attachment	delete	region		Deletes a form attachment from an asset in Glue Data Catalog.
delete_asset	delete	region		Deletes an asset from Glue Data Catalog.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_asset

Retrieves the metadata for an asset in Glue Data Catalog, including its forms, additional attachments, and associated glossary terms.

SELECT
asset_type_id,
attachments,
created_at,
description,
forms,
glossary_terms,
id,
iterable_forms,
name,
updated_at
FROM aws.glue.assets
WHERE region = '{{ region }}' -- required
;

search_assets

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

SELECT
asset_description,
asset_name,
asset_type_id,
id,
updated_at
FROM aws.glue.assets
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_asset

Updates the name and description of an existing asset in Glue Data Catalog. Only the fields that you provide are updated.

UPDATE aws.glue.assets
SET 
Identifier = '{{ Identifier }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND Identifier = '{{ Identifier }}' --required
RETURNING
description,
id,
name,
updated_at;

REPLACE examples

put_attachment

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.

REPLACE aws.glue.assets
SET 
AssetIdentifier = '{{ AssetIdentifier }}',
IterableFormName = '{{ IterableFormName }}',
ItemIdentifier = '{{ ItemIdentifier }}',
AttachmentName = '{{ AttachmentName }}',
Content = '{{ Content }}',
FormTypeId = '{{ FormTypeId }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND AssetIdentifier = '{{ AssetIdentifier }}' --required
AND AttachmentName = '{{ AttachmentName }}' --required
AND Content = '{{ Content }}' --required
AND FormTypeId = '{{ FormTypeId }}' --required
RETURNING
asset_identifier,
attachment_name,
form_type_id,
item_identifier,
iterable_form_name;

put_asset

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

REPLACE aws.glue.assets
SET 
AssetTypeId = '{{ AssetTypeId }}',
Identifier = '{{ Identifier }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
Forms = '{{ Forms }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND AssetTypeId = '{{ AssetTypeId }}' --required
AND Identifier = '{{ Identifier }}' --required
RETURNING
created_at,
description,
forms,
id,
name;

DELETE examples

delete_attachment

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

DELETE FROM aws.glue.assets
WHERE region = '{{ region }}' --required
;

delete_asset

Deletes an asset from Glue Data Catalog.

DELETE FROM aws.glue.assets
WHERE region = '{{ region }}' --required
;