:doc:`DataZone <../../datazone>` / Client / update_glossary_term

********************
update_glossary_term
********************



.. py:method:: DataZone.Client.update_glossary_term(**kwargs)

  

  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.
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateGlossaryTerm>`_  


  **Request Syntax**
  ::

    response = client.update_glossary_term(
        domainIdentifier='string',
        glossaryIdentifier='string',
        identifier='string',
        name='string',
        shortDescription='string',
        longDescription='string',
        termRelations={
            'isA': [
                'string',
            ],
            'classifies': [
                'string',
            ]
        },
        status='ENABLED'|'DISABLED'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

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

    

  
  :type glossaryIdentifier: string
  :param glossaryIdentifier: 

    The identifier of the business glossary in which a term is to be updated.

    

  
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The identifier of the business glossary term that is to be updated.

    

  
  :type name: string
  :param name: 

    The name to be updated as part of the ``UpdateGlossaryTerm`` action.

    

  
  :type shortDescription: string
  :param shortDescription: 

    The short description to be updated as part of the ``UpdateGlossaryTerm`` action.

    

  
  :type longDescription: string
  :param longDescription: 

    The long description to be updated as part of the ``UpdateGlossaryTerm`` action.

    

  
  :type termRelations: dict
  :param termRelations: 

    The term relations to be updated as part of the ``UpdateGlossaryTerm`` action.

    

  
    - **isA** *(list) --* 

      The ``isA`` property of the term relations.

      

    
      - *(string) --* 

      
  
    - **classifies** *(list) --* 

      The classifies of the term relations.

      

    
      - *(string) --* 

      
  
  
  :type status: string
  :param status: 

    The status to be updated as part of the ``UpdateGlossaryTerm`` action.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'id': 'string',
          'domainId': 'string',
          'glossaryId': 'string',
          'name': 'string',
          'status': 'ENABLED'|'DISABLED',
          'shortDescription': 'string',
          'longDescription': 'string',
          'termRelations': {
              'isA': [
                  'string',
              ],
              'classifies': [
                  'string',
              ]
          },
          'usageRestrictions': [
              'ASSET_GOVERNED_TERMS',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The identifier of the business glossary term that is to be updated.

        
      

      - **domainId** *(string) --* 

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

        
      

      - **glossaryId** *(string) --* 

        The identifier of the business glossary in which a term is to be updated.

        
      

      - **name** *(string) --* 

        The name to be updated as part of the ``UpdateGlossaryTerm`` action.

        
      

      - **status** *(string) --* 

        The status to be updated as part of the ``UpdateGlossaryTerm`` action.

        
      

      - **shortDescription** *(string) --* 

        The short description to be updated as part of the ``UpdateGlossaryTerm`` action.

        
      

      - **longDescription** *(string) --* 

        The long description to be updated as part of the ``UpdateGlossaryTerm`` action.

        
      

      - **termRelations** *(dict) --* 

        The term relations to be updated as part of the ``UpdateGlossaryTerm`` action.

        
        

        - **isA** *(list) --* 

          The ``isA`` property of the term relations.

          
          

          - *(string) --* 
      
        

        - **classifies** *(list) --* 

          The classifies of the term relations.

          
          

          - *(string) --* 
      
    
      

      - **usageRestrictions** *(list) --* 

        The usage restriction of a term within a restricted glossary.

        
        

        - *(string) --* 
    
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ConflictException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  