@aws-sdk/client-database-migration-service 3.1097.0 → 3.1099.0

package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts

@@ -24,9 +24,20 @@ declare const StartExtensionPackAssociationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Applies the extension pack to your target database. An extension pack is an add-on
- *          module that emulates functions present in a source database that are required when
- *          converting objects to the target database. </p>
+ * <p>Queues the installation of the extension pack on your target database. If other
+ *          requests created by <code>Start*</code> operations are already in the migration project's
+ *          queue, the installation begins after they complete.</p>
+ *          <p>This operation requires a non-virtual target data provider.</p>
+ *          <p>If the extension pack already exists, the operation reinstalls it. To ensure
+ *          compatibility, reconvert your database objects if the version has changed since your last
+ *          conversion. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html">Using extension packs in DMS Schema Conversion</a>.</p>
+ *          <p>To check the status of the request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeExtensionPackAssociations.html">DescribeExtensionPackAssociations</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:AssociateExtensionPack</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -82,17 +93,17 @@ declare const StartExtensionPackAssociationCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Extension Pack Association
+ * @example Install the extension pack on the target database
  * ```javascript
- * // Applies the extension pack to your target database.
+ * // The following example queues the installation of the extension pack on the target database.
  * const input = {
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
  * };
  * const command = new StartExtensionPackAssociationCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```

package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts

@@ -24,10 +24,23 @@ declare const StartMetadataModelAssessmentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a database migration assessment report by assessing the migration complexity for
- *          your source database. A database migration assessment report summarizes all of the schema
- *          conversion tasks. It also details the action items for database objects that can't be
- *          converted to the database engine of your target database instance. </p>
+ * <p>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 <code>Start*</code> operations are already in the
+ *          migration project's queue, the assessment begins after they complete.</p>
+ *          <p>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
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html">StartMetadataModelImport</a> before calling this operation.</p>
+ *          <p>To check the status of the assessment request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelAssessments.html">DescribeMetadataModelAssessments</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>To export the conversion assessment report after the request completes successfully,
+ *          call <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ExportMetadataModelAssessment.html">ExportMetadataModelAssessment</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelAssessment</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -84,19 +97,18 @@ declare const StartMetadataModelAssessmentCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Metadata Model Assessment
+ * @example Assess all objects in a schema
  * ```javascript
- * // Creates a database migration assessment report by assessing the migration complexity for
- *          your source database.
+ * // The following example queues an assessment of the conversion complexity for all objects in the ExampleSchema schema.
  * const input = {
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", "schema-name": "schema1", "table-name": "Cities"},"rule-action": "explicit"} ]}`
+ *   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", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}`
  * };
  * const command = new StartMetadataModelAssessmentCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```

package/dist-types/commands/StartMetadataModelConversionCommand.d.ts

@@ -24,7 +24,57 @@ declare const StartMetadataModelConversionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Converts your source database objects to a format compatible with the target database. </p>
+ * <p>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 <code>Start*</code> operations are already in the migration project's queue, the
+ *          conversion begins after they complete.</p>
+ *          <p>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
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html">StartMetadataModelImport</a> before calling this operation.</p>
+ *          <note>
+ *             <p>If converted objects already exist in the target metadata tree, the conversion
+ *             overwrites them, including any manual edits.</p>
+ *          </note>
+ *          <p>To check the status of the conversion request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelConversions.html">DescribeMetadataModelConversions</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>To cancel a queued or in-progress request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelConversion.html">CancelMetadataModelConversion</a> with the returned
+ *          <code>RequestIdentifier</code>.</p>
+ *          <p>After the conversion completes successfully:</p>
+ *          <ul>
+ *             <li>
+ *                <p>To export a post-conversion assessment report, call
+ *             <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ExportMetadataModelAssessment.html">ExportMetadataModelAssessment</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>To retrieve converted code, use any of the following
+ *             options:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModel.html">DescribeMetadataModel</a> and
+ *                   <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelChildren.html">DescribeMetadataModelChildren</a> – navigate the target metadata
+ *                   tree and retrieve converted definitions.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportAsScript.html">StartMetadataModelExportAsScript</a> – export as data definition
+ *                   language (DDL) scripts to your Amazon S3 bucket.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportToTarget.html">StartMetadataModelExportToTarget</a> – apply directly to your
+ *                   target database.</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelConversion</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -81,18 +131,18 @@ declare const StartMetadataModelConversionCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Metadata Model Conversion
+ * @example Convert all objects in a schema
  * ```javascript
- * // Converts your source database objects to a format compatible with the target database.
+ * // The following example queues a conversion of all objects in the ExampleSchema schema to the target database format.
  * const input = {
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", "schema-name": "schema1", "table-name": "Cities"},"rule-action": "explicit"} ]}`
+ *   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", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}`
  * };
  * const command = new StartMetadataModelConversionCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```

package/dist-types/commands/StartMetadataModelCreationCommand.d.ts

@@ -24,10 +24,39 @@ declare const StartMetadataModelCreationCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Creates source metadata model of the given type with the specified properties for schema conversion operations.</p>
+ * <p>Queues the creation of a metadata model in the source metadata tree. If other requests
+ *          created by <code>Start*</code> operations are already in the migration project's queue, the
+ *          creation begins after they complete.</p>
  *          <note>
- *             <p>This action supports only these directions: from SQL Server to Aurora PostgreSQL, or from SQL Server to RDS for PostgreSQL.</p>
+ *             <p>This operation supports only Microsoft SQL Server to Aurora PostgreSQL and
+ *          Microsoft SQL Server to Amazon RDS for PostgreSQL conversion paths.</p>
  *          </note>
+ *          <p>To check the status of the creation request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelCreations.html">DescribeMetadataModelCreations</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>To cancel a queued or in-progress request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelCreation.html">CancelMetadataModelCreation</a> with the returned
+ *          <code>RequestIdentifier</code>.</p>
+ *          <important>
+ *             <p>Calling
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html">StartMetadataModelImport</a> with <code>Refresh</code> deletes metadata models
+ *          created by this operation.</p>
+ *          </important>
+ *          <p>After the creation completes successfully:</p>
+ *          <ul>
+ *             <li>
+ *                <p>To evaluate conversion complexity, call
+ *             <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelAssessment.html">StartMetadataModelAssessment</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>To convert to the target database format, call
+ *             <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelConversion.html">StartMetadataModelConversion</a>.</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelCreation</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -77,6 +106,28 @@ declare const StartMetadataModelCreationCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
+ * @example Create a metadata model for a SQL statement
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   MetadataModelName: "ExampleStatement",
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *   Properties: {
+ *     StatementProperties: {
+ *       Definition: "SELECT * FROM ExampleTable;"
+ *     }
+ *   },
+ *   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"}]}`
+ * };
+ * const command = new StartMetadataModelCreationCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class StartMetadataModelCreationCommand extends StartMetadataModelCreationCommand_base {

package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts

@@ -24,8 +24,21 @@ declare const StartMetadataModelExportAsScriptCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3
- *          bucket.</p>
+ * <p>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 <code>Start*</code> operations are already in the migration project's queue,
+ *          the export begins after they complete.</p>
+ *          <p>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.</p>
+ *          <p>To check the status of the export request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelExportsAsScript.html">DescribeMetadataModelExportsAsScript</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelExportAsScripts</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -84,20 +97,20 @@ declare const StartMetadataModelExportAsScriptCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Metadata Model Export As Script
+ * @example Export converted metadata models as DDL scripts
  * ```javascript
- * // Saves your converted code to a file as a SQL script, and stores this file on your S3 bucket.
+ * // The following example queues an export of converted metadata models for all objects in the ExampleSchema schema as data definition language (DDL) scripts to the S3 bucket associated with the migration project.
  * const input = {
- *   FileName: "FILE",
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *   Origin: "SOURCE",
- *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", "schema-name": "schema1", "table-name": "Cities"},"rule-action": "explicit"} ]}`
+ *   FileName: "ExampleScript",
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *   Origin: "TARGET",
+ *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "example-target-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}`
  * };
  * const command = new StartMetadataModelExportAsScriptCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```

package/dist-types/commands/StartMetadataModelExportToTargetCommand.d.ts

@@ -24,7 +24,26 @@ declare const StartMetadataModelExportToTargetCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Applies converted database objects to your target database. </p>
+ * <p>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
+ *          <code>Start*</code> operations are already in the migration project's queue, the export
+ *          begins after they complete.</p>
+ *          <p>This operation requires a non-virtual target data provider.</p>
+ *          <p>The export applies only metadata models created by conversion. Metadata models
+ *          imported from the database are skipped.</p>
+ *          <note>
+ *             <p>If objects with the same name already exist on the target database, the export
+ *             overwrites them.</p>
+ *          </note>
+ *          <p>The operation installs the extension pack on the target database. For more
+ *          information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html">Using extension packs in DMS Schema Conversion</a>.</p>
+ *          <p>To check the status of the export request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelExportsToTarget.html">DescribeMetadataModelExportsToTarget</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelExportToTarget</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -82,19 +101,19 @@ declare const StartMetadataModelExportToTargetCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Metadata Model Export To Target
+ * @example Export converted metadata models to the target database
  * ```javascript
- * // Applies converted database objects to your target database.
+ * // The following example queues an export of converted metadata models for all objects in the ExampleSchema schema to the target database.
  * const input = {
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
  *   OverwriteExtensionPack: true,
- *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com", "schema-name": "schema1", "table-name": "Cities"},"rule-action": "explicit"} ]}`
+ *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "example-target-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}`
  * };
  * const command = new StartMetadataModelExportToTargetCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```

package/dist-types/commands/StartMetadataModelImportCommand.d.ts

@@ -24,9 +24,17 @@ declare const StartMetadataModelImportCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Loads the metadata for all the dependent database objects of the parent object.</p>
- *          <p>This operation uses your project's Amazon S3 bucket as a metadata cache to improve
- *          performance.</p>
+ * <p>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 <code>Start*</code> operations are already in the migration project's queue, the
+ *          import begins after they complete.</p>
+ *          <p>To check the status of the import request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelImports.html">DescribeMetadataModelImports</a> using the returned
+ *          <code>RequestIdentifier</code> as a filter.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:StartMetadataModelImport</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -85,20 +93,20 @@ declare const StartMetadataModelImportCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Start Metadata Model Import
+ * @example Import metadata from the source database
  * ```javascript
- * // Loads the metadata for all the dependent database objects of the parent object.
+ * // The following example queues a metadata import for all objects in the ExampleSchema schema from the source database.
  * const input = {
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
  *   Origin: "SOURCE",
  *   Refresh: false,
- *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", "schema-name": "schema1", "table-name": "Cities"},"rule-action": "explicit"} ]}`
+ *   SelectionRules: `{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}`
  * };
  * const command = new StartMetadataModelImportCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef"
+ *   RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
  * ```