@aws-sdk/client-database-migration-service 3.414.0 → 3.419.0

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

@@ -80,6 +80,24 @@ export interface StartMetadataModelAssessmentCommandOutput extends StartMetadata
  * @throws {@link DatabaseMigrationServiceServiceException}
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
+ * @example Start Metadata Model Assessment
+ * ```javascript
+ * // Creates a database migration assessment report by assessing the migration complexity for
+ * //          your source database.
+ * 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\"} ]}"
+ * };
+ * const command = new StartMetadataModelAssessmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
+ * }
+ * *\/
+ * // example id: start-metadata-model-assessment-1689722322596
+ * ```
+ *
  */
 export declare class StartMetadataModelAssessmentCommand extends $Command<StartMetadataModelAssessmentCommandInput, StartMetadataModelAssessmentCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
     readonly input: StartMetadataModelAssessmentCommandInput;

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

@@ -77,6 +77,23 @@ export interface StartMetadataModelConversionCommandOutput extends StartMetadata
  * @throws {@link DatabaseMigrationServiceServiceException}
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
+ * @example Start Metadata Model Conversion
+ * ```javascript
+ * // Converts your source database objects to a format compatible with the target database.
+ * 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\"} ]}"
+ * };
+ * const command = new StartMetadataModelConversionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
+ * }
+ * *\/
+ * // example id: start-metadata-model-conversion-1689722427798
+ * ```
+ *
  */
 export declare class StartMetadataModelConversionCommand extends $Command<StartMetadataModelConversionCommandInput, StartMetadataModelConversionCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
     readonly input: StartMetadataModelConversionCommandInput;

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

@@ -79,6 +79,25 @@ export interface StartMetadataModelExportAsScriptCommandOutput extends StartMeta
  * @throws {@link DatabaseMigrationServiceServiceException}
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
+ * @example Start Metadata Model Export As Script
+ * ```javascript
+ * // Saves your converted code to a file as a SQL script, and stores this file on your S3 bucket.
+ * 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\"} ]}"
+ * };
+ * const command = new StartMetadataModelExportAsScriptCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
+ * }
+ * *\/
+ * // example id: start-metadata-model-export-as-script-1689722681469
+ * ```
+ *
  */
 export declare class StartMetadataModelExportAsScriptCommand extends $Command<StartMetadataModelExportAsScriptCommandInput, StartMetadataModelExportAsScriptCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
     readonly input: StartMetadataModelExportAsScriptCommandInput;

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

@@ -78,6 +78,24 @@ export interface StartMetadataModelExportToTargetCommandOutput extends StartMeta
  * @throws {@link DatabaseMigrationServiceServiceException}
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
+ * @example Start Metadata Model Export To Target
+ * ```javascript
+ * // Applies converted database objects to your target database.
+ * const input = {
+ *   "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
+ *   "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\"} ]}"
+ * };
+ * const command = new StartMetadataModelExportToTargetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
+ * }
+ * *\/
+ * // example id: start-metadata-model-export-to-target-1689783666835
+ * ```
+ *
  */
 export declare class StartMetadataModelExportToTargetCommand extends $Command<StartMetadataModelExportToTargetCommandInput, StartMetadataModelExportToTargetCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
     readonly input: StartMetadataModelExportToTargetCommandInput;

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

@@ -80,6 +80,25 @@ export interface StartMetadataModelImportCommandOutput extends StartMetadataMode
  * @throws {@link DatabaseMigrationServiceServiceException}
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
+ * @example Start Metadata Model Import
+ * ```javascript
+ * // Loads the metadata for all the dependent database objects of the parent object.
+ * const input = {
+ *   "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
+ *   "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\"} ]}"
+ * };
+ * const command = new StartMetadataModelImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef"
+ * }
+ * *\/
+ * // example id: start-metadata-model-import-1689723124259
+ * ```
+ *
  */
 export declare class StartMetadataModelImportCommand extends $Command<StartMetadataModelImportCommandInput, StartMetadataModelImportCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
     readonly input: StartMetadataModelImportCommandInput;

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

@@ -24,10 +24,10 @@ export interface UpdateSubscriptionsToEventBridgeCommandOutput extends UpdateSub
 /**
  * @public
  * <p>Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules.
- *          By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher.
- *          If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you
- *          to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the <code>Force</code>
- *          option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be
+ *          By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.5 or higher.
+ *          If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you
+ *          to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of version, set the <code>Force</code>
+ *          option to true. However, if you don't upgrade instances earlier than version 3.4.5, some types of events might not be
  *          available when you use Amazon EventBridge.</p>
  *          <p>To call this operation, make sure that you have certain permissions added to your user account.
  *          For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge">Migrating event subscriptions to Amazon EventBridge</a>