AWS Database Migration Service

2020/11/16 - AWS Database Migration Service - 1 new 7 updated api methods

Changes  Adding MoveReplicationTask feature to move replication tasks between instances

MoveReplicationTask (new) Link ¶

Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later AWS DMS version as the current replication instance.

See also: AWS API Documentation

Request Syntax

client.move_replication_task(
    ReplicationTaskArn='string',
    TargetReplicationInstanceArn='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name (ARN) of the task that you want to move.

type TargetReplicationInstanceArn

string

param TargetReplicationInstanceArn

[REQUIRED]

The ARN of the replication instance where you want to move the task to.

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task that was moved.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

CreateReplicationTask (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

Creates a replication task using the specified parameters.

See also: AWS API Documentation

Request Syntax

client.create_replication_task(
    ReplicationTaskIdentifier='string',
    SourceEndpointArn='string',
    TargetEndpointArn='string',
    ReplicationInstanceArn='string',
    MigrationType='full-load'|'cdc'|'full-load-and-cdc',
    TableMappings='string',
    ReplicationTaskSettings='string',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TaskData='string',
    ResourceIdentifier='string'
)
type ReplicationTaskIdentifier

string

param ReplicationTaskIdentifier

[REQUIRED]

An identifier for the replication task.

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.

type SourceEndpointArn

string

param SourceEndpointArn

[REQUIRED]

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

type TargetEndpointArn

string

param TargetEndpointArn

[REQUIRED]

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

type ReplicationInstanceArn

string

param ReplicationInstanceArn

[REQUIRED]

The Amazon Resource Name (ARN) of a replication instance.

type MigrationType

string

param MigrationType

[REQUIRED]

The migration type. Valid values: full-load | cdc | full-load-and-cdc

type TableMappings

string

param TableMappings

[REQUIRED]

The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.

type ReplicationTaskSettings

string

param ReplicationTaskSettings

Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.

type CdcStartTime

datetime

param CdcStartTime

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”

type CdcStartPosition

string

param CdcStartPosition

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 the slotName 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 AWS DMS .

type CdcStopPosition

string

param CdcStopPosition

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 “

type Tags

list

param Tags

One or more tags to be assigned to the replication task.

  • (dict) --

    A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:

    • AddTagsToResource

    • ListTagsForResource

    • RemoveTagsFromResource

    • Key (string) --

      A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

    • Value (string) --

      A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type TaskData

string

param TaskData

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 AWS Database Migration Service User Guide.

type ResourceIdentifier

string

param ResourceIdentifier

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 . For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task that was created.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

DeleteReplicationTask (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

Deletes the specified replication task.

See also: AWS API Documentation

Request Syntax

client.delete_replication_task(
    ReplicationTaskArn='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task to be deleted.

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The deleted replication task.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

DescribeReplicationTasks (updated) Link ¶
Changes (response) 
{'ReplicationTasks': {'TargetReplicationInstanceArn': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_replication_tasks(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WithoutSettings=True|False
)
type Filters

list

param Filters

Filters applied to replication tasks.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

  • (dict) --

    Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter to the following APIs.

    • Name (string) -- [REQUIRED]

      The name of the filter as specified for a Describe* or similar operation.

    • Values (list) -- [REQUIRED]

      The filter value, which can specify one or more values used to narrow the returned results.

      • (string) --

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

type WithoutSettings

boolean

param WithoutSettings

An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true ; otherwise, choose false (the default).

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'ReplicationTasks': [
        {
            'ReplicationTaskIdentifier': 'string',
            'SourceEndpointArn': 'string',
            'TargetEndpointArn': 'string',
            'ReplicationInstanceArn': 'string',
            'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
            'TableMappings': 'string',
            'ReplicationTaskSettings': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'StopReason': 'string',
            'ReplicationTaskCreationDate': datetime(2015, 1, 1),
            'ReplicationTaskStartDate': datetime(2015, 1, 1),
            'CdcStartPosition': 'string',
            'CdcStopPosition': 'string',
            'RecoveryCheckpoint': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskStats': {
                'FullLoadProgressPercent': 123,
                'ElapsedTimeMillis': 123,
                'TablesLoaded': 123,
                'TablesLoading': 123,
                'TablesQueued': 123,
                'TablesErrored': 123,
                'FreshStartDate': datetime(2015, 1, 1),
                'StartDate': datetime(2015, 1, 1),
                'StopDate': datetime(2015, 1, 1),
                'FullLoadStartDate': datetime(2015, 1, 1),
                'FullLoadFinishDate': datetime(2015, 1, 1)
            },
            'TaskData': 'string',
            'TargetReplicationInstanceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Marker (string) --

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    • ReplicationTasks (list) --

      A description of the replication tasks.

      • (dict) --

        Provides information that describes a replication task created by the CreateReplicationTask operation.

        • 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:

          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_FULL_LOAD_COMPLETED" – Full-load migration completed.

          • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

          • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

          • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

        • ReplicationTaskCreationDate (datetime) --

          The date the replication task was created.

        • ReplicationTaskStartDate (datetime) --

          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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

        • ReplicationTaskArn (string) --

          The Amazon Resource Name (ARN) of the replication task.

        • ReplicationTaskStats (dict) --

          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 (integer) --

            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 (datetime) --

            The date the replication task was started either with a fresh start or a target reload.

          • StartDate (datetime) --

            The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

          • StopDate (datetime) --

            The date the replication task was stopped.

          • FullLoadStartDate (datetime) --

            The date the replication task full load was started.

          • FullLoadFinishDate (datetime) --

            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 AWS 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 the ReplicationTask object.

ModifyReplicationTask (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

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 AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide .

See also: AWS API Documentation

Request Syntax

client.modify_replication_task(
    ReplicationTaskArn='string',
    ReplicationTaskIdentifier='string',
    MigrationType='full-load'|'cdc'|'full-load-and-cdc',
    TableMappings='string',
    ReplicationTaskSettings='string',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string',
    TaskData='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task.

type ReplicationTaskIdentifier

string

param ReplicationTaskIdentifier

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.

type MigrationType

string

param MigrationType

The migration type. Valid values: full-load | cdc | full-load-and-cdc

type TableMappings

string

param TableMappings

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file:// . When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

type ReplicationTaskSettings

string

param ReplicationTaskSettings

JSON file that contains settings for the task, such as task metadata settings.

type CdcStartTime

datetime

param CdcStartTime

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”

type CdcStartPosition

string

param CdcStartPosition

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 the slotName 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 AWS DMS .

type CdcStopPosition

string

param CdcStopPosition

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 “

type TaskData

string

param TaskData

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 AWS Database Migration Service User Guide.

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

StartReplicationTask (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

Starts the replication task.

For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.

See also: AWS API Documentation

Request Syntax

client.start_replication_task(
    ReplicationTaskArn='string',
    StartReplicationTaskType='start-replication'|'resume-processing'|'reload-target',
    CdcStartTime=datetime(2015, 1, 1),
    CdcStartPosition='string',
    CdcStopPosition='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task to be started.

type StartReplicationTaskType

string

param StartReplicationTaskType

[REQUIRED]

A type of replication task.

type CdcStartTime

datetime

param CdcStartTime

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”

type CdcStartPosition

string

param CdcStartPosition

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 the slotName 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 AWS DMS .

type CdcStopPosition

string

param CdcStopPosition

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 “

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task started.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

StartReplicationTaskAssessment (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

Starts the replication task assessment for unsupported data types in the source database.

See also: AWS API Documentation

Request Syntax

client.start_replication_task_assessment(
    ReplicationTaskArn='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name (ARN) of the replication task.

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The assessed replication task.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.

StopReplicationTask (updated) Link ¶
Changes (response) 
{'ReplicationTask': {'TargetReplicationInstanceArn': 'string'}}

Stops the replication task.

See also: AWS API Documentation

Request Syntax

client.stop_replication_task(
    ReplicationTaskArn='string'
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

The Amazon Resource Name(ARN) of the replication task to be stopped.

rtype

dict

returns

Response Syntax

{
    'ReplicationTask': {
        'ReplicationTaskIdentifier': 'string',
        'SourceEndpointArn': 'string',
        'TargetEndpointArn': 'string',
        'ReplicationInstanceArn': 'string',
        'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'TableMappings': 'string',
        'ReplicationTaskSettings': 'string',
        'Status': 'string',
        'LastFailureMessage': 'string',
        'StopReason': 'string',
        'ReplicationTaskCreationDate': datetime(2015, 1, 1),
        'ReplicationTaskStartDate': datetime(2015, 1, 1),
        'CdcStartPosition': 'string',
        'CdcStopPosition': 'string',
        'RecoveryCheckpoint': 'string',
        'ReplicationTaskArn': 'string',
        'ReplicationTaskStats': {
            'FullLoadProgressPercent': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoaded': 123,
            'TablesLoading': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'FreshStartDate': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'StopDate': datetime(2015, 1, 1),
            'FullLoadStartDate': datetime(2015, 1, 1),
            'FullLoadFinishDate': datetime(2015, 1, 1)
        },
        'TaskData': 'string',
        'TargetReplicationInstanceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • ReplicationTask (dict) --

      The replication task stopped.

      • 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:

        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_FULL_LOAD_COMPLETED" – Full-load migration completed.

        • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

        • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

        • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        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 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:-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 the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        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 (integer) --

          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 (datetime) --

          The date the replication task was started either with a fresh start or a target reload.

        • StartDate (datetime) --

          The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

        • StopDate (datetime) --

          The date the replication task was stopped.

        • FullLoadStartDate (datetime) --

          The date the replication task full load was started.

        • FullLoadFinishDate (datetime) --

          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 AWS 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 the ReplicationTask object.