DatabaseMigrationService / Client / describe_metadata_model

describe_metadata_model¶

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.

Request Syntax

response = client.describe_metadata_model(
    SelectionRules='string',
    MigrationProjectIdentifier='string',
    Origin='SOURCE'|'TARGET'
)

Parameters:

SelectionRules (string) –
[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 in the DMS User Guide.
MigrationProjectIdentifier (string) –
[REQUIRED]

The migration project name or Amazon Resource Name (ARN).
Origin (string) –
[REQUIRED]

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

Return type:

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

DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault
DatabaseMigrationService.Client.exceptions.AccessDeniedFault