Creates a data migration using the provided settings.
Request Syntax
{
"DataMigrationName": "string",
"DataMigrationType": "string",
"EnableCloudwatchLogs": boolean,
"MigrationProjectIdentifier": "string",
"NumberOfJobs": number,
"SelectionRules": "string",
"ServiceAccessRoleArn": "string",
"SourceDataSettings": [
{
"CDCStartPosition": "string",
"CDCStartTime": "string",
"CDCStopTime": "string",
"SlotName": "string"
}
],
"Tags": [
{
"Key": "string",
"ResourceArn": "string",
"Value": "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.
- DataMigrationName
-
A user-friendly name for the data migration. Data migration names have the following constraints:
-
Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
-
Can't end with a hyphen or contain two consecutive hyphens.
-
Length must be from 1 to 255 characters.
Type: String
Required: No
-
- DataMigrationType
-
Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
Type: String
Valid Values:
full-load | cdc | full-load-and-cdcRequired: Yes
- EnableCloudwatchLogs
-
Specifies whether to enable CloudWatch logs for the data migration.
Type: Boolean
Required: No
- MigrationProjectIdentifier
-
An identifier for the migration project.
Type: String
Required: Yes
- 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
-
An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.
Type: String
Required: No
- ServiceAccessRoleArn
-
The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.
Type: String
Required: Yes
- SourceDataSettings
-
Specifies information about the source data provider.
Type: Array of SourceDataSetting objects
Required: No
- Tags
-
One or more tags to be assigned to the data migration.
Type: Array of Tag objects
Required: No
- TargetDataSettings
-
Specifies information about the target data provider.
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 created 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
- InvalidOperationFault
-
The action or operation requested isn't valid.
HTTP Status Code: 400
- ResourceAlreadyExistsFault
-
The resource you are attempting to create already exists.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
