CmdID / aws / aws dms

aws dms describe-metadata-model

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

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To describe a metadata model

The following describe-metadata-model example retrieves detailed information about the ExampleTable table in the ExampleSchema schema from the source metadata tree, including its SQL definition and references to the corresponding converted metadata models in the target database.

aws dms describe-metadata-model --migration-project-identifier arn:aws:dms:us-west-2:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS --selection-rules '{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-west-2.rds.amazonaws.com", "schema-name": "ExampleSchema", "table-name": "ExampleTable"}, "rule-action": "explicit"}]}' --origin SOURCE

Identify

--migration-project-identifierThe migration project name or Amazon Resource Name (ARN).

--selection-rulesA JSON string that identifies the metadata model to retrieve.

--originSpecifies whether to retrieve metadata from the source or target tree.

Its output

{
    "MetadataModelName": "ExampleTable",
    "MetadataModelType": "table",
    "TargetMetadataModels": [
        {
            "MetadataModelName": "exampletable",
            "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"example-target-server.us-west-2.rds.amazonaws.com\", \"schema-name\": \"exampleschema\", \"table-name\": \"exampletable\"}, \"rule-action\": \"explicit\"}]}"
        }
    ],
    "Definition": "CREATE TABLE ExampleTable (ExampleColumn INTEGER NOT NULL);"
}

For more information, see Navigating the metadata model tree in the AWS Database Migration Service User Guide.

Options

3 in the AWS CLI reference

--migration-project-identifierThe migration project name or Amazon Resource Name (ARN).

--originSpecifies whether to retrieve metadata from the source or target tree.

--selection-rulesA JSON string that identifies the metadata model to retrieve.