:doc:`DatabaseMigrationService <../../dms>` / Client / describe_metadata_model

***********************
describe_metadata_model
***********************



.. py:method:: DatabaseMigrationService.Client.describe_metadata_model(**kwargs)

  

  Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeMetadataModel>`_  


  **Request Syntax**
  ::

    response = client.describe_metadata_model(
        SelectionRules='string',
        MigrationProjectIdentifier='string',
        Origin='SOURCE'|'TARGET'
    )
    
  :type SelectionRules: string
  :param SelectionRules: **[REQUIRED]** 

    The JSON string that specifies which metadata model to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see `Selection Rules <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.Selections.html>`__ in the DMS User Guide.

    

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

    The migration project name or Amazon Resource Name (ARN).

    

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

    Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

    

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

    
    ::

      {
          'MetadataModelName': 'string',
          'MetadataModelType': 'string',
          'TargetMetadataModels': [
              {
                  'MetadataModelName': 'string',
                  'SelectionRules': 'string'
              },
          ],
          'Definition': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **MetadataModelName** *(string) --* 

        The name of the metadata model.

        
      

      - **MetadataModelType** *(string) --* 

        The type of the metadata model.

        
      

      - **TargetMetadataModels** *(list) --* 

        A list of counterpart metadata models in the target. This field is populated only when Origin is SOURCE and after the object has been converted by DMS Schema Conversion.

        
        

        - *(dict) --* 

          A reference to a metadata model, including its name and selection rules for location identification.

          
          

          - **MetadataModelName** *(string) --* 

            The name of the metadata model.

            
          

          - **SelectionRules** *(string) --* 

            The JSON string representing metadata model location.

            
      
    
      

      - **Definition** *(string) --* 

        The SQL text of the metadata model. This field might not be populated for some metadata models.

        
  
  **Exceptions**
  
  *   :py:class:`DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault`

  
  *   :py:class:`DatabaseMigrationService.Client.exceptions.AccessDeniedFault`

  