DatabaseMigrationService / Client / describe_data_migrations

describe_data_migrations#

DatabaseMigrationService.Client.describe_data_migrations(**kwargs)#

Returns information about data migrations.

See also: AWS API Documentation

Request Syntax

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

  • Filters (list) –

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

  • MaxRecords (integer) – 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.

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

  • WithoutSettings (boolean) – 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).

  • WithoutStatistics (boolean) – 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).

Return type:

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',
            ],
            'DataMigrationCidrBlocks': [
                '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) –

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

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

Exceptions