Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DMS.DescribeTableStatistics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTableStatistics Source #

See: newDescribeTableStatistics smart constructor.

Constructors

DescribeTableStatistics'

Fields

filters :: Maybe [Filter]
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.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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.
replicationTaskArn :: Text
The Amazon Resource Name (ARN) of the replication task.

Instances

Instances details

Eq DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods (==) :: DescribeTableStatistics -> DescribeTableStatistics -> Bool # (/=) :: DescribeTableStatistics -> DescribeTableStatistics -> Bool #
Read DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods readsPrec :: Int -> ReadS DescribeTableStatistics # readList :: ReadS [DescribeTableStatistics] # readPrec :: ReadPrec DescribeTableStatistics # readListPrec :: ReadPrec [DescribeTableStatistics] #
Show DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods showsPrec :: Int -> DescribeTableStatistics -> ShowS # show :: DescribeTableStatistics -> String # showList :: [DescribeTableStatistics] -> ShowS #
Generic DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Associated Types type Rep DescribeTableStatistics :: Type -> Type # Methods from :: DescribeTableStatistics -> Rep DescribeTableStatistics x # to :: Rep DescribeTableStatistics x -> DescribeTableStatistics #
NFData DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods rnf :: DescribeTableStatistics -> () #
Hashable DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods hashWithSalt :: Int -> DescribeTableStatistics -> Int # hash :: DescribeTableStatistics -> Int #
ToJSON DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods toJSON :: DescribeTableStatistics -> Value # toEncoding :: DescribeTableStatistics -> Encoding # toJSONList :: [DescribeTableStatistics] -> Value # toEncodingList :: [DescribeTableStatistics] -> Encoding #
AWSPager DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods page :: DescribeTableStatistics -> AWSResponse DescribeTableStatistics -> Maybe DescribeTableStatistics #
AWSRequest DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Associated Types type AWSResponse DescribeTableStatistics # Methods request :: DescribeTableStatistics -> Request DescribeTableStatistics # response :: MonadResource m => Logger -> Service -> Proxy DescribeTableStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTableStatistics))) #
ToHeaders DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods toHeaders :: DescribeTableStatistics -> [Header] #
ToPath DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods toPath :: DescribeTableStatistics -> ByteString #
ToQuery DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods toQuery :: DescribeTableStatistics -> QueryString #
type Rep DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics type Rep DescribeTableStatistics = D1 ('MetaData "DescribeTableStatistics" "Amazonka.DMS.DescribeTableStatistics" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeTableStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeTableStatistics Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics type AWSResponse DescribeTableStatistics = DescribeTableStatisticsResponse

newDescribeTableStatistics Source #

Arguments

:: Text	`$sel:replicationTaskArn:DescribeTableStatistics'`
-> DescribeTableStatistics

Create a value of DescribeTableStatistics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:DescribeTableStatistics', describeTableStatistics_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.

$sel:marker:DescribeTableStatistics', describeTableStatistics_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.

$sel:maxRecords:DescribeTableStatistics', describeTableStatistics_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.

$sel:replicationTaskArn:DescribeTableStatistics', describeTableStatistics_replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

Request Lenses

describeTableStatistics_filters :: Lens' DescribeTableStatistics (Maybe [Filter]) Source #

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.

describeTableStatistics_marker :: Lens' DescribeTableStatistics (Maybe Text) Source #

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.

describeTableStatistics_maxRecords :: Lens' DescribeTableStatistics (Maybe Int) Source #

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.

describeTableStatistics_replicationTaskArn :: Lens' DescribeTableStatistics Text Source #

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

Destructuring the Response

data DescribeTableStatisticsResponse Source #

See: newDescribeTableStatisticsResponse smart constructor.

Constructors

DescribeTableStatisticsResponse'

Fields

replicationTaskArn :: Maybe Text
The Amazon Resource Name (ARN) of the replication task.
marker :: Maybe Text
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.
tableStatistics :: Maybe [TableStatistics]
The table statistics.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods (==) :: DescribeTableStatisticsResponse -> DescribeTableStatisticsResponse -> Bool # (/=) :: DescribeTableStatisticsResponse -> DescribeTableStatisticsResponse -> Bool #
Read DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods readsPrec :: Int -> ReadS DescribeTableStatisticsResponse # readList :: ReadS [DescribeTableStatisticsResponse] # readPrec :: ReadPrec DescribeTableStatisticsResponse # readListPrec :: ReadPrec [DescribeTableStatisticsResponse] #
Show DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods showsPrec :: Int -> DescribeTableStatisticsResponse -> ShowS # show :: DescribeTableStatisticsResponse -> String # showList :: [DescribeTableStatisticsResponse] -> ShowS #
Generic DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Associated Types type Rep DescribeTableStatisticsResponse :: Type -> Type # Methods from :: DescribeTableStatisticsResponse -> Rep DescribeTableStatisticsResponse x # to :: Rep DescribeTableStatisticsResponse x -> DescribeTableStatisticsResponse #
NFData DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics Methods rnf :: DescribeTableStatisticsResponse -> () #
type Rep DescribeTableStatisticsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeTableStatistics type Rep DescribeTableStatisticsResponse = D1 ('MetaData "DescribeTableStatisticsResponse" "Amazonka.DMS.DescribeTableStatistics" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeTableStatisticsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tableStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableStatistics])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTableStatisticsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTableStatisticsResponse'`
-> DescribeTableStatisticsResponse

Create a value of DescribeTableStatisticsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:replicationTaskArn:DescribeTableStatistics', describeTableStatisticsResponse_replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

$sel:marker:DescribeTableStatistics', describeTableStatisticsResponse_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.

$sel:tableStatistics:DescribeTableStatisticsResponse', describeTableStatisticsResponse_tableStatistics - The table statistics.

$sel:httpStatus:DescribeTableStatisticsResponse', describeTableStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

describeTableStatisticsResponse_replicationTaskArn :: Lens' DescribeTableStatisticsResponse (Maybe Text) Source #

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

describeTableStatisticsResponse_marker :: Lens' DescribeTableStatisticsResponse (Maybe Text) Source #

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.

describeTableStatisticsResponse_tableStatistics :: Lens' DescribeTableStatisticsResponse (Maybe [TableStatistics]) Source #

The table statistics.

describeTableStatisticsResponse_httpStatus :: Lens' DescribeTableStatisticsResponse Int Source #

The response's http status code.