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

***************
update_glossary
***************



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

  

  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.
  

  

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


  **Request Syntax**
  ::

    response = client.update_glossary(
        domainIdentifier='string',
        identifier='string',
        name='string',
        description='string',
        status='DISABLED'|'ENABLED',
        clientToken='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

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

    

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

    The identifier of the business glossary to be updated.

    

  
  :type name: string
  :param name: 

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

    

  
  :type description: string
  :param description: 

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

    

  
  :type status: string
  :param status: 

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

    

  
  :type clientToken: string
  :param clientToken: 

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

    This field is autopopulated if not provided.

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

    
    ::

      {
          'domainId': 'string',
          'id': 'string',
          'name': 'string',
          'owningProjectId': 'string',
          'description': 'string',
          'status': 'DISABLED'|'ENABLED',
          'usageRestrictions': [
              'ASSET_GOVERNED_TERMS',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

        
      

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

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

        
      

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

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

        
      

      - **owningProjectId** *(string) --* 

        The identifier of the project in which to update a business glossary.

        
      

      - **description** *(string) --* 

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

        
      

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

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

        
      

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

        The usage restriction of the 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`

  