glossaries

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

Overview

Name	glossaries
Type	Resource
Id	aws.glue.glossaries

Fields

The following fields are returned by SELECT queries:

get_glossary

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

list_glossaries

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_glossary	select	region		Retrieves a business glossary in Glue Data Catalog by its identifier.
list_glossaries	select	region		Lists business glossaries in Glue Data Catalog.
create_glossary	insert	region		Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts.
update_glossary	update	region, Identifier		Updates a business glossary in Glue Data Catalog.
delete_glossary	delete	region		Deletes a business glossary from Glue Data Catalog. A glossary cannot be deleted if it still contains glossary terms.

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

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

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

list_glossaries

Lists business glossaries in Glue Data Catalog.

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

INSERT examples

create_glossary

Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts.

INSERT INTO aws.glue.glossaries (
Name,
Description,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
description,
id,
name
;

Manifest

# Description fields are for documentation purposes
- name: glossaries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the glossaries resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the glossary.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the glossary.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

UPDATE examples

update_glossary

Updates a business glossary in Glue Data Catalog.

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

DELETE examples

delete_glossary

Deletes a business glossary from Glue Data Catalog. A glossary cannot be deleted if it still contains glossary terms.

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