glossaries

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

Overview

Name	glossaries
Type	Resource
Id	aws.datazone.glossaries

Fields

The following fields are returned by SELECT queries:

get_glossary

Name	Datatype	Description
id	string	The ID of the business glossary. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the business glossary.
created_at	string (date-time)	The timestamp of when this business glossary was created.
created_by	string	The Amazon DataZone user who created this business glossary.
description	string	The description of the business glossary.
domain_id	string	The ID of the Amazon DataZone domain in which this business glossary exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
owning_project_id	string	The ID of the project that owns this business glossary. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
status	string	The status of the business glossary. (DISABLED, ENABLED)
updated_at	string (date-time)	The timestamp of when the business glossary was updated.
updated_by	string	The Amazon DataZone user who updated the business glossary.
usage_restrictions	array	The usage restriction of the restricted glossary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_glossary	select	domain_identifier, identifier, region		Gets a business glossary in Amazon DataZone. Prerequisites: The specified glossary ID must exist and be associated with the given domain. The caller must have the datazone:GetGlossary permission on the domain.
create_glossary	insert	domain_identifier, region, name, owningProjectIdentifier		Creates an Amazon DataZone business glossary. Specifies that this is a create glossary policy. A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly. Prerequisites: Domain must exist and be in an active state. Owning project must exist and be accessible by the caller. The glossary name must be unique within the domain.
update_glossary	update	domain_identifier, identifier, region		Updates the business glossary in Amazon DataZone. Prerequisites: The glossary must exist in the given domain. The caller must have the datazone:UpdateGlossary permission to update it. When updating the name, the new name must be unique within the domain. The glossary must not be deleted or in a terminal state.
delete_glossary	delete	domain_identifier, identifier, region		Deletes a business glossary in Amazon DataZone. Prerequisites: The glossary must be in DISABLED state. The glossary must not have any glossary terms associated with it. The glossary must exist in the specified domain. The caller must have the datazone:DeleteGlossary permission in the domain and glossary. Glossary should not be linked to any active metadata forms.

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

SELECT examples

get_glossary

Gets a business glossary in Amazon DataZone. Prerequisites: The specified glossary ID must exist and be associated with the given domain. The caller must have the datazone:GetGlossary permission on the domain.

SELECT
id,
name,
created_at,
created_by,
description,
domain_id,
owning_project_id,
status,
updated_at,
updated_by,
usage_restrictions
FROM aws.datazone.glossaries
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_glossary

Creates an Amazon DataZone business glossary. Specifies that this is a create glossary policy. A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly. Prerequisites: Domain must exist and be in an active state. Owning project must exist and be accessible by the caller. The glossary name must be unique within the domain.

INSERT INTO aws.datazone.glossaries (
name,
owningProjectIdentifier,
description,
status,
usageRestrictions,
clientToken,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ owningProjectIdentifier }}' /* required */,
'{{ description }}',
'{{ status }}',
'{{ usageRestrictions }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
description,
domain_id,
owning_project_id,
status,
usage_restrictions
;

Manifest

# Description fields are for documentation purposes
- name: glossaries
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the glossaries resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the glossaries resource.
  - name: name
    value: "{{ name }}"
  - name: owningProjectIdentifier
    value: "{{ owningProjectIdentifier }}"
  - name: description
    value: "{{ description }}"
  - name: status
    value: "{{ status }}"
    valid_values: ['DISABLED', 'ENABLED']
  - name: usageRestrictions
    value:
      - "{{ usageRestrictions }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_glossary

Updates the business glossary in Amazon DataZone. Prerequisites: The glossary must exist in the given domain. The caller must have the datazone:UpdateGlossary permission to update it. When updating the name, the new name must be unique within the domain. The glossary must not be deleted or in a terminal state.

UPDATE aws.datazone.glossaries
SET 
name = '{{ name }}',
description = '{{ description }}',
status = '{{ status }}',
clientToken = '{{ clientToken }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
description,
domain_id,
owning_project_id,
status,
usage_restrictions;

DELETE examples

delete_glossary

Deletes a business glossary in Amazon DataZone. Prerequisites: The glossary must be in DISABLED state. The glossary must not have any glossary terms associated with it. The glossary must exist in the specified domain. The caller must have the datazone:DeleteGlossary permission in the domain and glossary. Glossary should not be linked to any active metadata forms.

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