AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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 .
See also: AWS API Documentation
modify-replication-task
--replication-task-arn <value>
[--replication-task-identifier <value>]
[--migration-type <value>]
[--table-mappings <value>]
[--replication-task-settings <value>]
[--cdc-start-time <value>]
[--cdc-start-position <value>]
[--cdc-stop-position <value>]
[--task-data <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--replication-task-arn
(string)
The Amazon Resource Name (ARN) of the replication task.
--replication-task-identifier
(string)
The replication task identifier.
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.
--migration-type
(string)
The migration type. Valid values:
full-load
|cdc
|full-load-and-cdc
Possible values:
full-load
cdc
full-load-and-cdc
--table-mappings
(string)
When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path withfile://
. For example,--table-mappings file://mappingfile.json
. When working with the DMS API, provide the JSON as the parameter value.
--replication-task-settings
(string)
JSON file that contains settings for the task, such as task metadata settings.
--cdc-start-time
(timestamp)
Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
--cdc-start-position
(string)
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a 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:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
Note
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting theslotName
extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS .
--cdc-stop-position
(string)
Indicates 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“
--task-data
(string)
Supplemental 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.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To modify a replication task
The following modify-replication-task
example changes the table mappings for a task.
aws dms modify-replication-task \
--replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \
--table-mappings file://table-mappings.json
Contents of table-mappings.json
:
{
"rules": [
{
"rule-type": "selection",
"rule-id": "1",
"rule-name": "1",
"object-locator": {
"schema-name": "prodrep",
"table-name": "ACCT_%"
},
"rule-action": "include",
"filters": []
}
]
}
Output:
{
"ReplicationTask": {
"ReplicationTaskIdentifier": "moveit2",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"MigrationType": "full-load",
"TableMappings": ...output omitted...,
"ReplicationTaskSettings": ...output omitted...,
"Status": "modifying",
"StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
"ReplicationTaskCreationDate": 1590524772.505,
"ReplicationTaskStartDate": 1590789424.653,
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
}
}
For more information, see Working with AWS DMS Tasks in the AWS Database Migration Service User Guide.
ReplicationTask -> (structure)
The replication task that was modified.
ReplicationTaskIdentifier -> (string)
The 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.
SourceEndpointArn -> (string)
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.TargetEndpointArn -> (string)
The ARN that uniquely identifies the endpoint.ReplicationInstanceArn -> (string)
The ARN of the replication instance.MigrationType -> (string)
The type of migration.TableMappings -> (string)
Table mappings specified in the task.ReplicationTaskSettings -> (string)
The settings for the replication task.Status -> (string)
The 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
https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation."creating"
– The task is being created in response to running the `CreateReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html`__ operation."deleting"
– The task is being deleted in response to running the `DeleteReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__ operation."failed"
– The task failed to successfully complete the database migration in response to running the `StartReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ operation."failed-move"
– The task failed to move in response to running the `MoveReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation."modifying"
– The task definition is being modified in response to running the `ModifyReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html`__ operation."ready"
– The task is in aready
state where it can respond to other task operations, such as `StartReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ or `DeleteReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__ ."running"
– The task is performing a database migration in response to running the `StartReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ operation."starting"
– The task is preparing to perform a database migration in response to running the `StartReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ operation."stopped"
– The task has stopped in response to running the `StopReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__ operation."stopping"
– The task is preparing to stop in response to running the `StopReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__ operation."testing"
– The database migration specified for this task is being tested in response to running either the `StartReplicationTaskAssessmentRun
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ or the `StartReplicationTaskAssessment
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation.Note
`StartReplicationTaskAssessmentRun
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The `StartReplicationTaskAssessment
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, `StartReplicationTaskAssessmentRun
https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ 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.LastFailureMessage -> (string)
The last error (failure) message generated for the replication task.StopReason -> (string)
The 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 setStopTaskCachedChangesApplied
totrue
."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"
ReplicationTaskCreationDate -> (timestamp)
The date the replication task was created.ReplicationTaskStartDate -> (timestamp)
The date the replication task is scheduled to start.CdcStartPosition -> (string)
Indicates when you want a change data capture (CDC) operation to start. Use either
CdcStartPosition
orCdcStartTime
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:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
CdcStopPosition -> (string)
Indicates 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“
RecoveryCheckpoint -> (string)
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to theCdcStartPosition
parameter to start a CDC operation that begins at that checkpoint.ReplicationTaskArn -> (string)
The Amazon Resource Name (ARN) of the replication task.ReplicationTaskStats -> (structure)
The statistics for the task, including elapsed time, tables loaded, and table errors.
FullLoadProgressPercent -> (integer)
The percent complete for the full load migration task.ElapsedTimeMillis -> (long)
The elapsed time of the task, in milliseconds.TablesLoaded -> (integer)
The number of tables loaded for this task.TablesLoading -> (integer)
The number of tables currently loading for this task.TablesQueued -> (integer)
The number of tables queued for this task.TablesErrored -> (integer)
The number of errors that have occurred during this task.FreshStartDate -> (timestamp)
The date the replication task was started either with a fresh start or a target reload.StartDate -> (timestamp)
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .StopDate -> (timestamp)
The date the replication task was stopped.FullLoadStartDate -> (timestamp)
The date the replication task full load was started.FullLoadFinishDate -> (timestamp)
The date the replication task full load was completed.TaskData -> (string)
Supplemental 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.TargetReplicationInstanceArn -> (string)
The ARN of the replication instance to which this task is moved in response to running the `MoveReplicationTask
https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn't a member of theReplicationTask
object.