DatabaseMigrationService / Client / stop_data_migration

stop_data_migration#

DatabaseMigrationService.Client.stop_data_migration(**kwargs)#

Stops the specified data migration.

See also: AWS API Documentation

Request Syntax

response = client.stop_data_migration(
    DataMigrationIdentifier='string'
)
Parameters:

DataMigrationIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DataMigration': {
        'DataMigrationName': 'string',
        'DataMigrationArn': 'string',
        'DataMigrationCreateTime': datetime(2015, 1, 1),
        'DataMigrationStartTime': datetime(2015, 1, 1),
        'DataMigrationEndTime': datetime(2015, 1, 1),
        'ServiceAccessRoleArn': 'string',
        'MigrationProjectArn': 'string',
        'DataMigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
        'DataMigrationSettings': {
            'NumberOfJobs': 123,
            'CloudwatchLogsEnabled': True|False,
            'SelectionRules': 'string'
        },
        'SourceDataSettings': [
            {
                'CDCStartPosition': 'string',
                'CDCStartTime': datetime(2015, 1, 1),
                'CDCStopTime': datetime(2015, 1, 1),
                'SlotName': 'string'
            },
        ],
        'DataMigrationStatistics': {
            'TablesLoaded': 123,
            'ElapsedTimeMillis': 123,
            'TablesLoading': 123,
            'FullLoadPercentage': 123,
            'CDCLatency': 123,
            'TablesQueued': 123,
            'TablesErrored': 123,
            'StartTime': datetime(2015, 1, 1),
            'StopTime': datetime(2015, 1, 1)
        },
        'DataMigrationStatus': 'string',
        'PublicIpAddresses': [
            'string',
        ],
        'DataMigrationCidrBlocks': [
            'string',
        ],
        'LastFailureMessage': 'string',
        'StopReason': 'string'
    }
}

Response Structure

  • (dict) –

    • DataMigration (dict) –

      The data migration that DMS stopped.

      • DataMigrationName (string) –

        The user-friendly name for the data migration.

      • DataMigrationArn (string) –

        The Amazon Resource Name (ARN) that identifies this replication.

      • DataMigrationCreateTime (datetime) –

        The UTC time when DMS created the data migration.

      • DataMigrationStartTime (datetime) –

        The UTC time when DMS started the data migration.

      • DataMigrationEndTime (datetime) –

        The UTC time when data migration ended.

      • ServiceAccessRoleArn (string) –

        The IAM role that the data migration uses to access Amazon Web Services resources.

      • MigrationProjectArn (string) –

        The Amazon Resource Name (ARN) of the data migration’s associated migration project.

      • DataMigrationType (string) –

        Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

      • DataMigrationSettings (dict) –

        Specifies CloudWatch settings and selection rules for the data migration.

        • NumberOfJobs (integer) –

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

        • CloudwatchLogsEnabled (boolean) –

          Whether to enable CloudWatch logging for the data migration.

        • SelectionRules (string) –

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

      • SourceDataSettings (list) –

        Specifies information about the data migration’s source data provider.

        • (dict) –

          Defines settings for a source data provider for a data migration.

          • CDCStartPosition (string) –

            The change data capture (CDC) start position for the source data provider.

          • CDCStartTime (datetime) –

            The change data capture (CDC) start time for the source data provider.

          • CDCStopTime (datetime) –

            The change data capture (CDC) stop time for the source data provider.

          • SlotName (string) –

            The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.

      • DataMigrationStatistics (dict) –

        Provides information about the data migration’s run, including start and stop time, latency, and data migration progress.

        • TablesLoaded (integer) –

          The number of tables loaded in the current data migration run.

        • ElapsedTimeMillis (integer) –

          The elapsed duration of the data migration run.

        • TablesLoading (integer) –

          The data migration’s table loading progress.

        • FullLoadPercentage (integer) –

          The data migration’s progress in the full-load migration phase.

        • CDCLatency (integer) –

          The current latency of the change data capture (CDC) operation.

        • TablesQueued (integer) –

          The number of tables that are waiting for processing.

        • TablesErrored (integer) –

          The number of tables that DMS failed to process.

        • StartTime (datetime) –

          The time when the migration started.

        • StopTime (datetime) –

          The time when the migration stopped or failed.

      • DataMigrationStatus (string) –

        The current status of the data migration.

      • PublicIpAddresses (list) –

        The IP addresses of the endpoints for the data migration.

        • (string) –

      • DataMigrationCidrBlocks (list) –

        The CIDR blocks of the endpoints for the data migration.

        • (string) –

      • LastFailureMessage (string) –

        Information about the data migration’s most recent error or failure.

      • StopReason (string) –

        The reason the data migration last stopped.

Exceptions