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

*****************************
start_metadata_generation_run
*****************************



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

  

  Starts the metadata generation run.

   

  Prerequisites:

   

  
  * Asset must be created and belong to the specified domain and project.
   
  * Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).
   
  * Asset must have a structured schema with valid rows and columns.
   
  * Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.
   
  * The user must have permission to run metadata generation in the domain/project.
  

  

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


  **Request Syntax**
  ::

    response = client.start_metadata_generation_run(
        domainIdentifier='string',
        type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
        types=[
            'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
        ],
        target={
            'type': 'ASSET',
            'identifier': 'string',
            'revision': 'string'
        },
        clientToken='string',
        owningProjectIdentifier='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The ID of the Amazon DataZone domain where you want to start a metadata generation run.

    

  
  :type type: string
  :param type: 

    The type of the metadata generation run.

    

  
  :type types: list
  :param types: 

    The types of the metadata generation run.

    

  
    - *(string) --* 

    

  :type target: dict
  :param target: **[REQUIRED]** 

    The asset for which you want to start a metadata generation run.

    

  
    - **type** *(string) --* **[REQUIRED]** 

      The type of the asset for which metadata was generated.

      

    
    - **identifier** *(string) --* **[REQUIRED]** 

      The ID of the metadata generation run's target.

      

    
    - **revision** *(string) --* 

      The revision of the asset for which metadata was generated.

      

    
  
  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    This field is autopopulated if not provided.

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

    The ID of the project that owns the asset for which you want to start a metadata generation run.

    

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

    
    ::

      {
          'domainId': 'string',
          'id': 'string',
          'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED'|'PARTIALLY_SUCCEEDED',
          'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
          'types': [
              'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
          ],
          'createdAt': datetime(2015, 1, 1),
          'createdBy': 'string',
          'owningProjectId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ID of the Amazon DataZone domain in which the metadata generation run was started.

        
      

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

        The ID of the metadata generation run.

        
      

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

        The status of the metadata generation run.

        
      

      - **type** *(string) --* 

        The type of the metadata generation run.

        
      

      - **types** *(list) --* 

        The types of the metadata generation run.

        
        

        - *(string) --* 
    
      

      - **createdAt** *(datetime) --* 

        The timestamp at which the metadata generation run was started.

        
      

      - **createdBy** *(string) --* 

        The ID of the user who started the metadata generation run.

        
      

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

        The ID of the project that owns the asset for which the metadata generation run was started.

        
  
  **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.ServiceQuotaExceededException`

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

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

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

  