describeTableStatistics method

Future<DescribeTableStatisticsResponse> describeTableStatistics({ required String replicationTaskArn, List<Filter>? filters, String? marker, int? maxRecords, })

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.

May throw ResourceNotFoundFault. May throw InvalidResourceStateFault.

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

Parameter filters : Filters applied to table statistics.

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

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

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

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

Implementation

Future<DescribeTableStatisticsResponse> describeTableStatistics({
  required String replicationTaskArn,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  ArgumentError.checkNotNull(replicationTaskArn, 'replicationTaskArn');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.DescribeTableStatistics'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ReplicationTaskArn': replicationTaskArn,
      if (filters != null) 'Filters': filters,
      if (marker != null) 'Marker': marker,
      if (maxRecords != null) 'MaxRecords': maxRecords,
    },
  );

  return DescribeTableStatisticsResponse.fromJson(jsonResponse.body);
}