Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ModifyDataMigration

Modifies an existing AWS DMS data migration.

Request Syntax


{
   "DataMigrationIdentifier": "string",
   "DataMigrationName": "string",
   "DataMigrationType": "string",
   "EnableCloudwatchLogs": boolean,
   "NumberOfJobs": number,
   "SelectionRules": "string",
   "ServiceAccessRoleArn": "string",
   "SourceDataSettings": [ 
      { 
         "CDCStartPosition": "string",
         "CDCStartTime": "string",
         "CDCStopTime": "string",
         "SlotName": "string"
      }
   ],
   "TargetDataSettings": [ 
      { 
         "TablePreparationMode": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DataMigrationIdentifier

The identifier (name or ARN) of the data migration to modify.

Type: String

Required: Yes

DataMigrationName

The new name for the data migration.

Type: String

Required: No

DataMigrationType

The new migration type for the data migration.

Type: String

Valid Values: full-load | cdc | full-load-and-cdc

Required: No

EnableCloudwatchLogs

Whether to enable Cloudwatch logs for the data migration.

Type: Boolean

Required: No

NumberOfJobs

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

Type: Integer

Required: No

SelectionRules

A JSON-formatted string that defines what objects to include and exclude from the migration.

Type: String

Required: No

ServiceAccessRoleArn

The new service access role ARN for the data migration.

Type: String

Required: No

SourceDataSettings

The new information about the source data provider for the data migration.

Type: Array of SourceDataSetting objects

Required: No

TargetDataSettings

The new information about the target data provider for the data migration.

Type: Array of TargetDataSetting objects

Required: No

Response Syntax


{
   "DataMigration": { 
      "DataMigrationArn": "string",
      "DataMigrationCidrBlocks": [ "string" ],
      "DataMigrationCreateTime": "string",
      "DataMigrationEndTime": "string",
      "DataMigrationName": "string",
      "DataMigrationSettings": { 
         "CloudwatchLogsEnabled": boolean,
         "NumberOfJobs": number,
         "SelectionRules": "string"
      },
      "DataMigrationStartTime": "string",
      "DataMigrationStatistics": { 
         "CDCLatency": number,
         "ElapsedTimeMillis": number,
         "FullLoadPercentage": number,
         "StartTime": "string",
         "StopTime": "string",
         "TablesErrored": number,
         "TablesLoaded": number,
         "TablesLoading": number,
         "TablesQueued": number
      },
      "DataMigrationStatus": "string",
      "DataMigrationType": "string",
      "LastFailureMessage": "string",
      "MigrationProjectArn": "string",
      "PublicIpAddresses": [ "string" ],
      "ServiceAccessRoleArn": "string",
      "SourceDataSettings": [ 
         { 
            "CDCStartPosition": "string",
            "CDCStartTime": "string",
            "CDCStopTime": "string",
            "SlotName": "string"
         }
      ],
      "StopReason": "string",
      "TargetDataSettings": [ 
         { 
            "TablePreparationMode": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DataMigration

Information about the modified data migration.

Type: DataMigration object

Errors

For information about the errors that are common to all actions, see Common Errors.

FailedDependencyFault

A dependency threw an exception.

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

message

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400