Skip to main content

replication_tasks

Creates, updates, deletes, gets or lists a replication_tasks resource.

Overview​

Namereplication_tasks
TypeResource
Idaws.dms.replication_tasks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
cdc_start_positionstringIndicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975👎2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
cdc_stop_positionstringIndicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“
last_failure_messagestringThe last error (failure) message generated for the replication task.
migration_typestringThe type of migration. (full-load, cdc, full-load-and-cdc)
recovery_checkpointstringIndicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
replication_instance_arnstringThe ARN of the replication instance.
replication_task_arnstringThe Amazon Resource Name (ARN) of the replication task.
replication_task_creation_datestring (date-time)The date the replication task was created.
replication_task_identifierstringThe user-assigned replication task identifier or name. Constraints: Must contain 1-255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
replication_task_settingsstringThe settings for the replication task.
replication_task_start_datestring (date-time)The date the replication task is scheduled to start.
replication_task_statsobjectThe statistics for the task, including elapsed time, tables loaded, and table errors.
source_endpoint_arnstringThe Amazon Resource Name (ARN) that uniquely identifies the endpoint.
statusstringThe status of the replication task. This response parameter can return one of the following values: "moving" – The task is being moved in response to running the MoveReplicationTask operation. "creating" – The task is being created in response to running the CreateReplicationTask operation. "deleting" – The task is being deleted in response to running the DeleteReplicationTask operation. "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation. "failed-move" – The task failed to move in response to running the MoveReplicationTask operation. "modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation. "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask . "running" – The task is performing a database migration in response to running the StartReplicationTask operation. "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation. "stopped" – The task has stopped in response to running the StopReplicationTask operation. "stopping" – The task is preparing to stop in response to running the StopReplicationTask operation. "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation. StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
stop_reasonstringThe reason the replication task was stopped. This response parameter can return one of the following values: "Stop Reason NORMAL" – The task completed successfully with no additional information returned. "Stop Reason RECOVERABLE_ERROR" "Stop Reason FATAL_ERROR" "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true. "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED" "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied "Stop Reason STOPPED_DUE_TO_LOW_MEMORY" "Stop Reason STOPPED_DUE_TO_LOW_DISK" "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task "Stop Reason RECONFIGURATION_RESTART" "Stop Reason RECYCLE_TASK"
table_mappingsstringTable mappings specified in the task.
target_endpoint_arnstringThe ARN that uniquely identifies the endpoint.
target_replication_instance_arnstringThe ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
task_datastringSupplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_replication_tasksselectregionReturns information about replication tasks for your account in the current region.
create_replication_taskinsertregion, ReplicationTaskIdentifier, SourceEndpointArn, TargetEndpointArn, ReplicationInstanceArn, MigrationType, TableMappingsCreates a replication task using the specified parameters.
modify_replication_taskupdateregion, ReplicationTaskArnModifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
delete_replication_taskdeleteregionDeletes the specified replication task.
cancel_replication_task_assessment_runexecregion, ReplicationTaskAssessmentRunArnCancels a single premigration assessment run. This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
reload_tablesexecregion, ReplicationTaskArn, TablesToReloadReloads the target database table with the source data. You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.
start_replication_task_assessmentexecregion, ReplicationTaskArnStarts the replication task assessment for unsupported data types in the source database. You can only use this operation for a task if the following conditions are true: The task must be in the stopped state. The task must have successful connections to the source and target. If either of these conditions are not met, an InvalidResourceStateFault error will result. For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
start_replication_task_assessment_runexecregion, ReplicationTaskArn, ServiceAccessRoleArn, ResultLocationBucket, AssessmentRunNameStarts a new premigration assessment run for one or more individual assessments of a migration task. The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about replication tasks for your account in the current region.

SELECT
cdc_start_position,
cdc_stop_position,
last_failure_message,
migration_type,
recovery_checkpoint,
replication_instance_arn,
replication_task_arn,
replication_task_creation_date,
replication_task_identifier,
replication_task_settings,
replication_task_start_date,
replication_task_stats,
source_endpoint_arn,
status,
stop_reason,
table_mappings,
target_endpoint_arn,
target_replication_instance_arn,
task_data
FROM aws.dms.replication_tasks
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a replication task using the specified parameters.

INSERT INTO aws.dms.replication_tasks (
ReplicationTaskIdentifier,
SourceEndpointArn,
TargetEndpointArn,
ReplicationInstanceArn,
MigrationType,
TableMappings,
ReplicationTaskSettings,
CdcStartTime,
CdcStartPosition,
CdcStopPosition,
Tags,
TaskData,
ResourceIdentifier,
region
)
SELECT 
'{{ ReplicationTaskIdentifier }}' /* required */,
'{{ SourceEndpointArn }}' /* required */,
'{{ TargetEndpointArn }}' /* required */,
'{{ ReplicationInstanceArn }}' /* required */,
'{{ MigrationType }}' /* required */,
'{{ TableMappings }}' /* required */,
'{{ ReplicationTaskSettings }}',
'{{ CdcStartTime }}',
'{{ CdcStartPosition }}',
'{{ CdcStopPosition }}',
'{{ Tags }}',
'{{ TaskData }}',
'{{ ResourceIdentifier }}',
'{{ region }}'
RETURNING
replication_task
;

UPDATE examples​

Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

UPDATE aws.dms.replication_tasks
SET 
ReplicationTaskArn = '{{ ReplicationTaskArn }}',
ReplicationTaskIdentifier = '{{ ReplicationTaskIdentifier }}',
MigrationType = '{{ MigrationType }}',
TableMappings = '{{ TableMappings }}',
ReplicationTaskSettings = '{{ ReplicationTaskSettings }}',
CdcStartTime = '{{ CdcStartTime }}',
CdcStartPosition = '{{ CdcStartPosition }}',
CdcStopPosition = '{{ CdcStopPosition }}',
TaskData = '{{ TaskData }}'
WHERE 
region = '{{ region }}' --required
AND ReplicationTaskArn = '{{ ReplicationTaskArn }}' --required
RETURNING
replication_task;

DELETE examples​

Deletes the specified replication task.

DELETE FROM aws.dms.replication_tasks
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Cancels a single premigration assessment run. This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.

EXEC aws.dms.replication_tasks.cancel_replication_task_assessment_run 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationTaskAssessmentRunArn": "{{ ReplicationTaskAssessmentRunArn }}"
}'
;
Last updated on