Skip to content

/AWS1/IF_DZN=>UPDATEGLOSSARY()

About UpdateGlossary

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.

Method Signature

METHODS /AWS1/IF_DZN~UPDATEGLOSSARY
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/DZNGLOSSARYID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNGLOSSARYNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DZNGLOSSARYDESCRIPTION OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNGLOSSARYSTATUS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznupdglossaryoutput
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

iv_identifier TYPE /AWS1/DZNGLOSSARYID /AWS1/DZNGLOSSARYID

The identifier of the business glossary to be updated.

Optional arguments:

iv_name TYPE /AWS1/DZNGLOSSARYNAME /AWS1/DZNGLOSSARYNAME

The name to be updated as part of the UpdateGlossary action.

iv_description TYPE /AWS1/DZNGLOSSARYDESCRIPTION /AWS1/DZNGLOSSARYDESCRIPTION

The description to be updated as part of the UpdateGlossary action.

iv_status TYPE /AWS1/DZNGLOSSARYSTATUS /AWS1/DZNGLOSSARYSTATUS

The status to be updated as part of the UpdateGlossary action.

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_dznupdglossaryoutput /AWS1/CL_DZNUPDGLOSSARYOUTPUT

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->updateglossary(
  iv_clienttoken = |string|
  iv_description = |string|
  iv_domainidentifier = |string|
  iv_identifier = |string|
  iv_name = |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.