metadata_models
Creates, updates, deletes, gets or lists a metadata_models resource.
Overview
| Name | metadata_models |
| Type | Resource |
| Id | aws.dms.metadata_models |
Fields
The following fields are returned by SELECT queries:
- describe_metadata_model
| Name | Datatype | Description |
|---|---|---|
definition | string | The SQL text of the metadata model. This field might not be populated for some metadata models. |
metadata_model_name | string | The name of the metadata model. |
metadata_model_type | string | The type of the metadata model. |
target_metadata_models | array | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_metadata_model | select | region | 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. | |
cancel_metadata_model_conversion | exec | region, MigrationProjectIdentifier, RequestIdentifier | Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion. Required permissions: dms:CancelMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
cancel_metadata_model_creation | exec | region, MigrationProjectIdentifier, RequestIdentifier | Cancels a single metadata model creation operation that was started with StartMetadataModelCreation. Required permissions: dms:CancelMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
export_metadata_model_assessment | exec | region, MigrationProjectIdentifier, SelectionRules | Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file. Required permissions: dms:ExportMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_assessment | exec | region, MigrationProjectIdentifier, SelectionRules | Queues an assessment of the selected source metadata models (database objects such as tables, views, and procedures) to evaluate conversion complexity to the target database format. If other requests created by Start* operations are already in the migration project's queue, the assessment begins after they complete. The assessment request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. To check the status of the assessment request, call DescribeMetadataModelAssessments using the returned RequestIdentifier as a filter. To export the conversion assessment report after the request completes successfully, call ExportMetadataModelAssessment. Required permissions: dms:StartMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_conversion | exec | region, MigrationProjectIdentifier, SelectionRules | Queues a conversion of the selected source metadata models (database objects such as tables, views, and procedures) to the target database format. If other requests created by Start* operations are already in the migration project's queue, the conversion begins after they complete. The conversion request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. If converted objects already exist in the target metadata tree, the conversion overwrites them, including any manual edits. To check the status of the conversion request, call DescribeMetadataModelConversions using the returned RequestIdentifier as a filter. To cancel a queued or in-progress request, call CancelMetadataModelConversion with the returned RequestIdentifier. After the conversion completes successfully: To export a post-conversion assessment report, call ExportMetadataModelAssessment. To retrieve converted code, use any of the following options: DescribeMetadataModel and DescribeMetadataModelChildren – navigate the target metadata tree and retrieve converted definitions. StartMetadataModelExportAsScript – export as data definition language (DDL) scripts to your Amazon S3 bucket. StartMetadataModelExportToTarget – apply directly to your target database. Required permissions: dms:StartMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_creation | exec | region, MigrationProjectIdentifier, SelectionRules, MetadataModelName, Properties | 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: To evaluate conversion complexity, call StartMetadataModelAssessment. To convert to the target database format, call StartMetadataModelConversion. Required permissions: dms:StartMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_export_as_script | exec | region, MigrationProjectIdentifier, SelectionRules, Origin | Queues an export of metadata models (database objects such as tables, views, and procedures) as a data definition language (DDL) script. The script is stored as a ZIP archive in the Amazon S3 bucket associated with the migration project. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. When exporting from the target metadata tree, the export applies only to metadata models created by conversion. Metadata models imported from the database are skipped. To check the status of the export request, call DescribeMetadataModelExportsAsScript using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportAsScripts. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_export_to_target | exec | region, MigrationProjectIdentifier, SelectionRules | Queues an export of the selected converted metadata models (database objects such as tables, views, and procedures) to your target database. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. This operation requires a non-virtual target data provider. The export applies only metadata models created by conversion. Metadata models imported from the database are skipped. If objects with the same name already exist on the target database, the export overwrites them. The operation installs the extension pack on the target database. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the export request, call DescribeMetadataModelExportsToTarget using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportToTarget. For more information, see Actions, resources, and condition keys for Database Migration Service. | |
start_metadata_model_import | exec | region, MigrationProjectIdentifier, SelectionRules, Origin | Queues an import of metadata models (database objects such as tables, views, and procedures) from your data provider into the metadata tree. If other requests created by Start* operations are already in the migration project's queue, the import begins after they complete. To check the status of the import request, call DescribeMetadataModelImports using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelImport. For more information, see Actions, resources, and condition keys for Database Migration Service. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_metadata_model
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.
SELECT
definition,
metadata_model_name,
metadata_model_type,
target_metadata_models
FROM aws.dms.metadata_models
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- cancel_metadata_model_conversion
- cancel_metadata_model_creation
- export_metadata_model_assessment
- start_metadata_model_assessment
- start_metadata_model_conversion
- start_metadata_model_creation
- start_metadata_model_export_as_script
- start_metadata_model_export_to_target
- start_metadata_model_import
Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion. Required permissions: dms:CancelMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.cancel_metadata_model_conversion
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"RequestIdentifier": "{{ RequestIdentifier }}"
}'
;
Cancels a single metadata model creation operation that was started with StartMetadataModelCreation. Required permissions: dms:CancelMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.cancel_metadata_model_creation
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"RequestIdentifier": "{{ RequestIdentifier }}"
}'
;
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file. Required permissions: dms:ExportMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.export_metadata_model_assessment
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}",
"FileName": "{{ FileName }}",
"AssessmentReportTypes": "{{ AssessmentReportTypes }}"
}'
;
Queues an assessment of the selected source metadata models (database objects such as tables, views, and procedures) to evaluate conversion complexity to the target database format. If other requests created by Start* operations are already in the migration project's queue, the assessment begins after they complete. The assessment request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. To check the status of the assessment request, call DescribeMetadataModelAssessments using the returned RequestIdentifier as a filter. To export the conversion assessment report after the request completes successfully, call ExportMetadataModelAssessment. Required permissions: dms:StartMetadataModelAssessment. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_assessment
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}"
}'
;
Queues a conversion of the selected source metadata models (database objects such as tables, views, and procedures) to the target database format. If other requests created by Start* operations are already in the migration project's queue, the conversion begins after they complete. The conversion request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation. If converted objects already exist in the target metadata tree, the conversion overwrites them, including any manual edits. To check the status of the conversion request, call DescribeMetadataModelConversions using the returned RequestIdentifier as a filter. To cancel a queued or in-progress request, call CancelMetadataModelConversion with the returned RequestIdentifier. After the conversion completes successfully: To export a post-conversion assessment report, call ExportMetadataModelAssessment. To retrieve converted code, use any of the following options: DescribeMetadataModel and DescribeMetadataModelChildren – navigate the target metadata tree and retrieve converted definitions. StartMetadataModelExportAsScript – export as data definition language (DDL) scripts to your Amazon S3 bucket. StartMetadataModelExportToTarget – apply directly to your target database. Required permissions: dms:StartMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_conversion
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}"
}'
;
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: To evaluate conversion complexity, call StartMetadataModelAssessment. To convert to the target database format, call StartMetadataModelConversion. Required permissions: dms:StartMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_creation
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}",
"MetadataModelName": "{{ MetadataModelName }}",
"Properties": "{{ Properties }}"
}'
;
Queues an export of metadata models (database objects such as tables, views, and procedures) as a data definition language (DDL) script. The script is stored as a ZIP archive in the Amazon S3 bucket associated with the migration project. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. When exporting from the target metadata tree, the export applies only to metadata models created by conversion. Metadata models imported from the database are skipped. To check the status of the export request, call DescribeMetadataModelExportsAsScript using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportAsScripts. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_export_as_script
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}",
"Origin": "{{ Origin }}",
"FileName": "{{ FileName }}"
}'
;
Queues an export of the selected converted metadata models (database objects such as tables, views, and procedures) to your target database. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete. This operation requires a non-virtual target data provider. The export applies only metadata models created by conversion. Metadata models imported from the database are skipped. If objects with the same name already exist on the target database, the export overwrites them. The operation installs the extension pack on the target database. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the export request, call DescribeMetadataModelExportsToTarget using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelExportToTarget. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_export_to_target
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}",
"OverwriteExtensionPack": {{ OverwriteExtensionPack }}
}'
;
Queues an import of metadata models (database objects such as tables, views, and procedures) from your data provider into the metadata tree. If other requests created by Start* operations are already in the migration project's queue, the import begins after they complete. To check the status of the import request, call DescribeMetadataModelImports using the returned RequestIdentifier as a filter. Required permissions: dms:StartMetadataModelImport. For more information, see Actions, resources, and condition keys for Database Migration Service.
EXEC aws.dms.metadata_models.start_metadata_model_import
@region='{{ region }}' --required
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}",
"SelectionRules": "{{ SelectionRules }}",
"Origin": "{{ Origin }}",
"Refresh": {{ Refresh }}
}'
;