glossary_terms

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

Overview

Name	glossary_terms
Type	Resource
Id	aws.datazone.glossary_terms

Fields

The following fields are returned by SELECT queries:

get_glossary_term

Name	Datatype	Description
id	string	The ID of the business glossary term. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the business glossary term.
created_at	string (date-time)	The timestamp of when the business glossary term was created.
created_by	string	The Amazon DataZone user who created the business glossary.
domain_id	string	The ID of the Amazon DataZone domain in which this business glossary term exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
glossary_id	string	The ID of the business glossary to which this term belongs. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
long_description	string	The long description of the business glossary term.
short_description	string	The short decription of the business glossary term.
status	string	The status of the business glossary term. (ENABLED, DISABLED)
term_relations	object	The details of the term relations.
updated_at	string (date-time)	The timestamp of when the business glossary term was updated.
updated_by	string	The Amazon DataZone user who updated the business glossary term.
usage_restrictions	array	The usage restriction of a term within a restricted glossary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_glossary_term	select	domain_identifier, identifier, region		Gets a business glossary term in Amazon DataZone. Prerequisites: Glossary term with identifier must exist in the domain. User must have permission on the glossary term. Domain must be accessible and active.
create_glossary_term	insert	domain_identifier, region, glossaryIdentifier, name		Creates a business glossary term. A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts. Prerequisites: Domain must exist. Glossary must exist. The term name must be unique within the glossary. Ensure term does not conflict with existing terms in hierarchy.
update_glossary_term	update	domain_identifier, identifier, region		Updates a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist in the specified domain. New name must not conflict with existing terms in the same glossary. User must have permissions on the term. The term must not be in DELETED status.
delete_glossary_term	delete	domain_identifier, identifier, region		Deletes a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist and be active. The term must not be linked to other assets or child terms. Caller must have delete permissions in the domain/glossary. Ensure all associations (such as to assets or parent terms) are removed before deletion.

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
domain_identifier	string	The ID of the Amazon DataZone domain in which the business glossary term is deleted.
identifier	string	The ID of the business glossary term that is deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

get_glossary_term

Gets a business glossary term in Amazon DataZone. Prerequisites: Glossary term with identifier must exist in the domain. User must have permission on the glossary term. Domain must be accessible and active.

SELECT
id,
name,
created_at,
created_by,
domain_id,
glossary_id,
long_description,
short_description,
status,
term_relations,
updated_at,
updated_by,
usage_restrictions
FROM aws.datazone.glossary_terms
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_glossary_term

Creates a business glossary term. A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts. Prerequisites: Domain must exist. Glossary must exist. The term name must be unique within the glossary. Ensure term does not conflict with existing terms in hierarchy.

INSERT INTO aws.datazone.glossary_terms (
glossaryIdentifier,
name,
status,
shortDescription,
longDescription,
termRelations,
clientToken,
domain_identifier,
region
)
SELECT 
'{{ glossaryIdentifier }}' /* required */,
'{{ name }}' /* required */,
'{{ status }}',
'{{ shortDescription }}',
'{{ longDescription }}',
'{{ termRelations }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
domain_id,
glossary_id,
long_description,
short_description,
status,
term_relations,
usage_restrictions
;

Manifest

# Description fields are for documentation purposes
- name: glossary_terms
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the glossary_terms resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the glossary_terms resource.
  - name: glossaryIdentifier
    value: "{{ glossaryIdentifier }}"
  - name: name
    value: "{{ name }}"
  - name: status
    value: "{{ status }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: shortDescription
    value: "{{ shortDescription }}"
  - name: longDescription
    value: "{{ longDescription }}"
  - name: termRelations
    description: |
      The details of the term relations.
    value:
      isA:
        - "{{ isA }}"
      classifies:
        - "{{ classifies }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_glossary_term

Updates a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist in the specified domain. New name must not conflict with existing terms in the same glossary. User must have permissions on the term. The term must not be in DELETED status.

UPDATE aws.datazone.glossary_terms
SET 
glossaryIdentifier = '{{ glossaryIdentifier }}',
name = '{{ name }}',
shortDescription = '{{ shortDescription }}',
longDescription = '{{ longDescription }}',
termRelations = '{{ termRelations }}',
status = '{{ status }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
domain_id,
glossary_id,
long_description,
short_description,
status,
term_relations,
usage_restrictions;

DELETE examples

delete_glossary_term

Deletes a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist and be active. The term must not be linked to other assets or child terms. Caller must have delete permissions in the domain/glossary. Ensure all associations (such as to assets or parent terms) are removed before deletion.

DELETE FROM aws.datazone.glossary_terms
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;