glossary_terms

Creates, updates, deletes, gets or lists a glossary_terms resource.

Overview

Name	glossary_terms
Type	Resource
Id	aws.glue.glossary_terms

Fields

The following fields are returned by SELECT queries:

get_glossary_term

Name	Datatype	Description
glossary_id	string	The unique identifier of the glossary containing this term.
id	string	The unique identifier of the glossary term.
long_description	string	The long description of the glossary term.
name	string	The name of the glossary term.
short_description	string	The short description of the glossary term.

list_glossary_terms

Name	Datatype	Description
id	string	The unique identifier of the glossary term.
name	string	The name of the glossary term.
short_description	string	The short description of the glossary term.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_glossary_term	select	region		Retrieves a glossary term in Glue Data Catalog by its identifier.
list_glossary_terms	select	region		Lists glossary terms within a business glossary in Glue Data Catalog.
create_glossary_term	insert	region, GlossaryIdentifier		Creates a glossary term within a business glossary in Glue Data Catalog.
associate_glossary_terms	update	region, AssetIdentifier, GlossaryTermIdentifiers		Associates one or more glossary terms with an asset in Glue Data Catalog.
update_glossary_term	update	region, Identifier		Updates a glossary term in Glue Data Catalog.
delete_glossary_term	delete	region		Deletes a glossary term from Glue Data Catalog.
disassociate_glossary_terms	exec	region, AssetIdentifier, GlossaryTermIdentifiers		Removes the association of one or more glossary terms from an asset in 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_glossary_term

Retrieves a glossary term in Glue Data Catalog by its identifier.

SELECT
glossary_id,
id,
long_description,
name,
short_description
FROM aws.glue.glossary_terms
WHERE region = '{{ region }}' -- required
;

list_glossary_terms

Lists glossary terms within a business glossary in Glue Data Catalog.

SELECT
id,
name,
short_description
FROM aws.glue.glossary_terms
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_glossary_term

Creates a glossary term within a business glossary in Glue Data Catalog.

INSERT INTO aws.glue.glossary_terms (
GlossaryIdentifier,
Name,
ShortDescription,
LongDescription,
ClientToken,
region
)
SELECT 
'{{ GlossaryIdentifier }}' /* required */,
'{{ Name }}',
'{{ ShortDescription }}',
'{{ LongDescription }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
glossary_id,
id,
long_description,
name,
short_description
;

Manifest

# Description fields are for documentation purposes
- name: glossary_terms
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the glossary_terms resource.
  - name: GlossaryIdentifier
    value: "{{ GlossaryIdentifier }}"
    description: |
      The unique identifier of the glossary in which to create the term.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the glossary term.
  - name: ShortDescription
    value: "{{ ShortDescription }}"
    description: |
      A short description of the glossary term.
  - name: LongDescription
    value: "{{ LongDescription }}"
    description: |
      A long description of the glossary term.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

UPDATE examples

associate_glossary_terms

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

UPDATE aws.glue.glossary_terms
SET 
AssetIdentifier = '{{ AssetIdentifier }}',
IterableFormName = '{{ IterableFormName }}',
ItemIdentifier = '{{ ItemIdentifier }}',
GlossaryTermIdentifiers = '{{ GlossaryTermIdentifiers }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND AssetIdentifier = '{{ AssetIdentifier }}' --required
AND GlossaryTermIdentifiers = '{{ GlossaryTermIdentifiers }}' --required
RETURNING
asset_identifier,
glossary_terms,
item_identifier,
iterable_form_name;

update_glossary_term

Updates a glossary term in Glue Data Catalog.

UPDATE aws.glue.glossary_terms
SET 
Identifier = '{{ Identifier }}',
Name = '{{ Name }}',
ShortDescription = '{{ ShortDescription }}',
LongDescription = '{{ LongDescription }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND Identifier = '{{ Identifier }}' --required
RETURNING
glossary_id,
id,
long_description,
name,
short_description;

DELETE examples

delete_glossary_term

Deletes a glossary term from Glue Data Catalog.

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

Lifecycle Methods

disassociate_glossary_terms

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

EXEC aws.glue.glossary_terms.disassociate_glossary_terms 
@region='{{ region }}' --required 
@@json=
'{
"AssetIdentifier": "{{ AssetIdentifier }}", 
"IterableFormName": "{{ IterableFormName }}", 
"ItemIdentifier": "{{ ItemIdentifier }}", 
"GlossaryTermIdentifiers": "{{ GlossaryTermIdentifiers }}", 
"ClientToken": "{{ ClientToken }}"
}'
;