startMetadataModelCreation

Queues the creation of a metadata model in the source metadata tree. If other requests created by Start* operations are already in the migration project's queue, the creation begins after they complete.

This operation supports only Microsoft SQL Server to Aurora PostgreSQL and Microsoft SQL Server to Amazon RDS for PostgreSQL conversion paths.

To check the status of the creation request, call DescribeMetadataModelCreations using the returned RequestIdentifier as a filter.

To cancel a queued or in-progress request, call CancelMetadataModelCreation with the returned RequestIdentifier.

Calling StartMetadataModelImport with Refresh deletes metadata models created by this operation.

After the creation completes successfully:

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

Samples

// The following example queues the creation of a metadata model for a SQL statement. The selection
// rule specifies the schema where the metadata model is placed, and MetadataModelName provides a unique
// identifier for use in subsequent operations.
val resp = databaseMigrationClient.startMetadataModelCreation {
    migrationProjectIdentifier = "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
    selectionRules = "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"database-name\": \"ExampleDatabase\", \"schema-name\": \"ExampleSchema\"}, \"rule-action\": \"explicit\"}]}"
    metadataModelName = "ExampleStatement"
    properties = MetadataModelProperties.StatementProperties(StatementProperties {
        definition = "SELECT * FROM ExampleTable;"
    }
    )
}