[ aws . dms ]

describe-table-statistics

Description

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

See ‘aws help’ for descriptions of global parameters.

describe-table-statistics is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: TableStatistics

Synopsis

  describe-table-statistics
--replication-task-arn <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--replication-task-arn (string)

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

--filters (list)

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.

(structure)

Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS 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)

The name of the filter as specified for a Describe* or similar operation.

Values -> (list)

The filter value, which can specify one or more values used to narrow the returned results.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ReplicationTaskArn -> (string)

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

TableStatistics -> (list)

The table statistics.

(structure)

Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.

SchemaName -> (string)

The schema name.

TableName -> (string)

The name of the table.

Inserts -> (long)

The number of insert actions performed on a table.

Deletes -> (long)

The number of delete actions performed on a table.

Updates -> (long)

The number of update actions performed on a table.

Ddls -> (long)

The data definition language (DDL) used to build and modify the structure of your tables.

FullLoadRows -> (long)

The number of rows added during the full load operation.

FullLoadCondtnlChkFailedRows -> (long)

The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).

FullLoadErrorRows -> (long)

The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).

FullLoadStartTime -> (timestamp)

The time when the full load operation started.

FullLoadEndTime -> (timestamp)

The time when the full load operation completed.

FullLoadReloaded -> (boolean)

A value that indicates if the table was reloaded (true ) or loaded as part of a new full load operation (false ).

LastUpdateTime -> (timestamp)

The last time a 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

ValidationPendingRecords -> (long)

The number of records that have yet to be validated.

ValidationFailedRecords -> (long)

The number of records that failed validation.

ValidationSuspendedRecords -> (long)

The number of records that couldn’t be validated.

ValidationState -> (string)

The validation state of the table.

This parameter can have the following values:

• Not enabled – Validation isn’t enabled for the table in the migration task.

• Pending records – Some records in the table are waiting for validation.

• Mismatched records – Some records in the table don’t match between the source and target.

• Suspended records – Some records in the table couldn’t be validated.

• No primary key –The table couldn’t be validated because it has no primary key.

• Table error – The table wasn’t validated because it’s in an error state and some data wasn’t migrated.

• Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.

• Error – The table couldn’t be validated because of an unexpected error.

• Pending validation – The table is waiting validation.

• Preparing table – Preparing the table enabled in the migration task for validation.

• Pending revalidation – All rows in the table are pending validation after the table was updated.

ValidationStateDetails -> (string)

Additional details about the state of validation.

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 .