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

***************************
get_metadata_generation_run
***************************



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

  

  Gets a metadata generation run in Amazon DataZone.

   

  Prerequisites:

   

  
  * Valid domain and run identifier.
   
  * The metadata generation run must exist.
   
  * User must have read access to the metadata run.
  

  

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


  **Request Syntax**
  ::

    response = client.get_metadata_generation_run(
        domainIdentifier='string',
        identifier='string',
        type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

    

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

    The identifier of the metadata generation run.

    

  
  :type type: string
  :param type: 

    The type of the metadata generation run.

    

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

    
    ::

      {
          'domainId': 'string',
          'id': 'string',
          'target': {
              'type': 'ASSET',
              'identifier': 'string',
              'revision': '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',
          'typeStats': [
              {
                  'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
                  'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED'|'PARTIALLY_SUCCEEDED',
                  'errorMessage': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

        
      

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

        The ID of the metadata generation run.

        
      

      - **target** *(dict) --* 

        The asset for which you're generating metadata.

        
        

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

          The type of the asset for which metadata was generated.

          
        

        - **identifier** *(string) --* 

          The ID of the metadata generation run's target.

          
        

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

          The revision of the asset for which metadata was generated.

          
    
      

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

        The status of the metadata generation run.

        
      

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

        The type of metadata generation run.

        
      

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

        The types of the metadata generation run.

        
        

        - *(string) --* 
    
      

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

        The timestamp of when the metadata generation run was start.

        
      

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

        The Amazon DataZone user who started the metadata generation run.

        
      

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

        The ID of the project that owns the assets for which you're running metadata generation.

        
      

      - **typeStats** *(list) --* 

        The type stats included in the metadata generation run output details.

        
        

        - *(dict) --* 

          The statistics of the metadata generation run type.

          
          

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

            The type of the metadata generation run type statistics.

            
          

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

            The status of the metadata generation run type statistics.

            
          

          - **errorMessage** *(string) --* 

            The error message displayed if the action fails to run.

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

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

  