View a markdown version of this page

Metadata Migration - Migration Assistant for Amazon OpenSearch Service

Metadata Migration

Metadata migration moves the Amazon OpenSearch Service domain or Amazon OpenSearch Serverless collection into a shape that can accept the incoming data and traffic. It handles mappings, templates, aliases, and other index-level definitions before document backfill or replay becomes meaningful. In the workflow model, metadata migration is a configured phase inside the migration workflow, not a separate manual tool run. When metadataMigrationConfig is present, the workflow runs two logical steps: evaluateMetadata (evaluates what would be applied) and migrateMetadata (writes those changes to the target). If approvals are enabled, the workflow can pause between these steps so you can inspect the result before continuing.

Metadata migration handles index settings, index mappings, legacy and composable templates, component templates, and aliases. It also applies built-in transformations to handle upgrades between version-specific behavior, including string to text and keyword, flattened to flat_object, and dense_vector to knn_vector (with additional vector compatibility transformations for newer Amazon OpenSearch Service and Amazon OpenSearch Serverless targets). Advanced users can also supply custom metadata transformers through transformerConfig, transformerConfigBase64, or transformerConfigFile.

Plan separate work for security configuration, ISM/ILM policies, ingest pipelines, OpenSearch Dashboards or Kibana saved objects, data streams, and cluster-level tuning — these are not migrated automatically.