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.

Required permissions: dms:DescribeMetadataModel. For more information, see Actions, resources, and condition keys for Database Migration Service.

See also: AWS API Documentation

Request Syntax

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

  • SelectionRules (string) –

    [REQUIRED]

    A JSON string that identifies the metadata model to retrieve. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

    Usage:

    • Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

    • Supports only explicit rule actions.

    • Exactly one rule is allowed.

  • 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) –

          A JSON string that identifies this metadata model in the metadata tree. For the selection rule format, see Selection rules in DMS Schema Conversion.

          Usage:

          • You can pass this value as the SelectionRules parameter to any operation that accepts selection rules, such as DescribeMetadataModel, StartMetadataModelConversion, and others.

    • Definition (string) –

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

Exceptions