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

***************
create_glossary
***************



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

  

  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.
  

  

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


  **Request Syntax**
  ::

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

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

    

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

    The name of this business glossary.

    

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

    The ID of the project that currently owns business glossary.

    

  
  :type description: string
  :param description: 

    The description of this business glossary.

    

  
  :type status: string
  :param status: 

    The status of this business glossary.

    

  
  :type usageRestrictions: list
  :param usageRestrictions: 

    The usage restriction of the restricted glossary.

    

  
    - *(string) --* 

    

  :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 ID of the Amazon DataZone domain in which this business glossary is created.

        
      

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

        The ID of this business glossary.

        
      

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

        The name of this business glossary.

        
      

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

        The ID of the project that currently owns this business glossary.

        
      

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

        The description of this business glossary.

        
      

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

        The status of this business glossary.

        
      

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

        The usage restriction of the restricted glossary.

        
        

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

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

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

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

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

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

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

  