AWS Database Migration Service

2017/10/12 - AWS Database Migration Service - 1 updated api methods

Changes  This change includes addition of new optional parameter to an existing API

DescribeTableStatistics (updated) Link ΒΆ
Changes (request)
{'Filters': [{'Name': 'string', 'Values': ['string']}]}

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

See also: AWS API Documentation

Request Syntax

client.describe_table_statistics(
    ReplicationTaskArn='string',
    MaxRecords=123,
    Marker='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
type ReplicationTaskArn

string

param ReplicationTaskArn

[REQUIRED]

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

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

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 Filters

list

param Filters

Filters applied to the describe table statistics action.

Valid filter names: schema-name | table-name | table-state

A combination of filters creates an AND condition where each record matches all specified filters.

  • (dict) --

    • Name (string) -- [REQUIRED]

      The name of the filter.

    • Values (list) -- [REQUIRED]

      The filter value.

      • (string) --

rtype

dict

returns

Response Syntax

{
    'ReplicationTaskArn': 'string',
    'TableStatistics': [
        {
            'SchemaName': 'string',
            'TableName': 'string',
            'Inserts': 123,
            'Deletes': 123,
            'Updates': 123,
            'Ddls': 123,
            'FullLoadRows': 123,
            'FullLoadCondtnlChkFailedRows': 123,
            'FullLoadErrorRows': 123,
            'LastUpdateTime': datetime(2015, 1, 1),
            'TableState': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • ReplicationTaskArn (string) --

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

    • TableStatistics (list) --

      The table statistics.

      • (dict) --

        • SchemaName (string) --

          The schema name.

        • TableName (string) --

          The name of the table.

        • Inserts (integer) --

          The number of insert actions performed on a table.

        • Deletes (integer) --

          The number of delete actions performed on a table.

        • Updates (integer) --

          The number of update actions performed on a table.

        • Ddls (integer) --

          The Data Definition Language (DDL) used to build and modify the structure of your tables.

        • FullLoadRows (integer) --

          The number of rows added during the Full Load operation.

        • FullLoadCondtnlChkFailedRows (integer) --

          The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).

        • FullLoadErrorRows (integer) --

          The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).

        • LastUpdateTime (datetime) --

          The last time the table was updated.

        • TableState (string) --

          The state of the tables described.

          Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded

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