Skip to content

/AWS1/IF_DZN=>CREATEGLOSSARY()

About CreateGlossary

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.

Method Signature

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The ID of the Amazon DataZone domain in which this business glossary is created.

iv_name TYPE /AWS1/DZNGLOSSARYNAME /AWS1/DZNGLOSSARYNAME

The name of this business glossary.

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The ID of the project that currently owns business glossary.

Optional arguments:

iv_description TYPE /AWS1/DZNGLOSSARYDESCRIPTION /AWS1/DZNGLOSSARYDESCRIPTION

The description of this business glossary.

iv_status TYPE /AWS1/DZNGLOSSARYSTATUS /AWS1/DZNGLOSSARYSTATUS

The status of this business glossary.

it_usagerestrictions TYPE /AWS1/CL_DZNGLOSSARYUSAGERES00=>TT_GLOSSARYUSAGERESTRICTIONS TT_GLOSSARYUSAGERESTRICTIONS

The usage restriction of the restricted glossary.

iv_clienttoken TYPE /AWS1/DZNCLIENTTOKEN /AWS1/DZNCLIENTTOKEN

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_dzncreateglossaryout /AWS1/CL_DZNCREATEGLOSSARYOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_dzn~createglossary(
  it_usagerestrictions = VALUE /aws1/cl_dznglossaryusageres00=>tt_glossaryusagerestrictions(
    ( new /aws1/cl_dznglossaryusageres00( |string| ) )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_domainidentifier = |string|
  iv_name = |string|
  iv_owningprojectidentifier = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_domainid = lo_result->get_domainid( ).
  lv_glossaryid = lo_result->get_id( ).
  lv_glossaryname = lo_result->get_name( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_glossarydescription = lo_result->get_description( ).
  lv_glossarystatus = lo_result->get_status( ).
  LOOP AT lo_result->get_usagerestrictions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_glossaryusagerestrictio = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.