AWS API Changes

2024/10/10 - AWS Database Migration Service - 6 new api methods

Changes Introduces DescribeDataMigrations, CreateDataMigration, ModifyDataMigration, DeleteDataMigration, StartDataMigration, StopDataMigration operations to SDK. Provides FailedDependencyFault error message.

StartDataMigration (new)

Link ¶

Starts the specified data migration.

See also: AWS API Documentation

Request Syntax

client.start_data_migration(
    DataMigrationIdentifier='string',
    StartType='reload-target'|'resume-processing'|'start-replication'
)

type DataMigrationIdentifier

string

param DataMigrationIdentifier

[REQUIRED]

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

type StartType

string

param StartType

[REQUIRED]

Specifies the start type for the data migration. Valid values include start-replication , reload-target , and resume-processing .

rtype

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',
        ],
        'LastFailureMessage': 'string',
        'StopReason': 'string'
    }
}

Response Structure

(dict) --
- DataMigration (dict) --
  
  The data migration that DMS started.
  - 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) --
  - LastFailureMessage (string) --
    
    Information about the data migration's most recent error or failure.
  - StopReason (string) --
    
    The reason the data migration last stopped.

DescribeDataMigrations (new)

Link ¶

Returns information about data migrations.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

Filters applied to the data migrations.

(dict) --

Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
- 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.

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).

type WithoutStatistics

boolean

param WithoutStatistics

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

rtype

dict

returns

Response Syntax

{
    'DataMigrations': [
        {
            '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',
            ],
            'LastFailureMessage': 'string',
            'StopReason': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- DataMigrations (list) --
  
  Returns information about the data migrations used in the project.
  - (dict) --
    
    This object provides information about a DMS data migration.
    - 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) --
    - LastFailureMessage (string) --
      
      Information about the data migration's most recent error or failure.
    - StopReason (string) --
      
      The reason the data migration last stopped.
- 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 .

StopDataMigration (new)

Link ¶

Stops the specified data migration.

See also: AWS API Documentation

Request Syntax

client.stop_data_migration(
    DataMigrationIdentifier='string'
)

type DataMigrationIdentifier

string

param DataMigrationIdentifier

[REQUIRED]

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

rtype

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',
        ],
        '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) --
  - LastFailureMessage (string) --
    
    Information about the data migration's most recent error or failure.
  - StopReason (string) --
    
    The reason the data migration last stopped.

DeleteDataMigration (new)

Link ¶

Deletes the specified data migration.

See also: AWS API Documentation

Request Syntax

client.delete_data_migration(
    DataMigrationIdentifier='string'
)

type DataMigrationIdentifier

string

param DataMigrationIdentifier

[REQUIRED]

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

rtype

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',
        ],
        'LastFailureMessage': 'string',
        'StopReason': 'string'
    }
}

Response Structure

(dict) --
- DataMigration (dict) --
  
  The deleted data migration.
  - 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) --
  - LastFailureMessage (string) --
    
    Information about the data migration's most recent error or failure.
  - StopReason (string) --
    
    The reason the data migration last stopped.

ModifyDataMigration (new)

Link ¶

Modifies an existing DMS data migration.

See also: AWS API Documentation

Request Syntax

client.modify_data_migration(
    DataMigrationIdentifier='string',
    DataMigrationName='string',
    EnableCloudwatchLogs=True|False,
    ServiceAccessRoleArn='string',
    DataMigrationType='full-load'|'cdc'|'full-load-and-cdc',
    SourceDataSettings=[
        {
            'CDCStartPosition': 'string',
            'CDCStartTime': datetime(2015, 1, 1),
            'CDCStopTime': datetime(2015, 1, 1),
            'SlotName': 'string'
        },
    ],
    NumberOfJobs=123,
    SelectionRules='string'
)

type DataMigrationIdentifier

string

param DataMigrationIdentifier

[REQUIRED]

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

type DataMigrationName

string

param DataMigrationName

The new name for the data migration.

type EnableCloudwatchLogs

boolean

param EnableCloudwatchLogs

Whether to enable Cloudwatch logs for the data migration.

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

The new service access role ARN for the data migration.

type DataMigrationType

string

param DataMigrationType

The new migration type for the data migration.

type SourceDataSettings

list

param SourceDataSettings

The new information about the source data provider for the data migration.

(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.

type NumberOfJobs

integer

param NumberOfJobs

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

type SelectionRules

string

param SelectionRules

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

rtype

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',
        ],
        'LastFailureMessage': 'string',
        'StopReason': 'string'
    }
}

Response Structure

(dict) --
- DataMigration (dict) --
  
  Information about the modified data migration.
  - 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) --
  - LastFailureMessage (string) --
    
    Information about the data migration's most recent error or failure.
  - StopReason (string) --
    
    The reason the data migration last stopped.

CreateDataMigration (new)

Link ¶

Creates a data migration using the provided settings.

See also: AWS API Documentation

Request Syntax

client.create_data_migration(
    DataMigrationName='string',
    MigrationProjectIdentifier='string',
    DataMigrationType='full-load'|'cdc'|'full-load-and-cdc',
    ServiceAccessRoleArn='string',
    EnableCloudwatchLogs=True|False,
    SourceDataSettings=[
        {
            'CDCStartPosition': 'string',
            'CDCStartTime': datetime(2015, 1, 1),
            'CDCStopTime': datetime(2015, 1, 1),
            'SlotName': 'string'
        },
    ],
    NumberOfJobs=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string',
            'ResourceArn': 'string'
        },
    ],
    SelectionRules='string'
)

type DataMigrationName

string

param DataMigrationName

A user-friendly name for the data migration. Data migration names have the following constraints:

Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
Can't end with a hyphen or contain two consecutive hyphens.
Length must be from 1 to 255 characters.

type MigrationProjectIdentifier

string

param MigrationProjectIdentifier

[REQUIRED]

An identifier for the migration project.

type DataMigrationType

string

param DataMigrationType

[REQUIRED]

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

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.

type EnableCloudwatchLogs

boolean

param EnableCloudwatchLogs

Specifies whether to enable CloudWatch logs for the data migration.

type SourceDataSettings

list

param SourceDataSettings

Specifies information about the 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.

type NumberOfJobs

integer

param NumberOfJobs

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

type Tags

list

param Tags

One or more tags to be assigned to the data migration.

(dict) --

A user-defined key-value pair that describes metadata added to an 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}_.:/=+\-]*)$").
- ResourceArn (string) --
  
  The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

type SelectionRules

string

param SelectionRules

An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.

rtype

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',
        ],
        'LastFailureMessage': 'string',
        'StopReason': 'string'
    }
}

Response Structure

(dict) --
- DataMigration (dict) --
  
  Information about the created data migration.
  - 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) --
  - LastFailureMessage (string) --
    
    Information about the data migration's most recent error or failure.
  - StopReason (string) --
    
    The reason the data migration last stopped.