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.DynamoDB.Types.ItemCollectionMetrics

Description

Documentation

data ItemCollectionMetrics Source #

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

See: newItemCollectionMetrics smart constructor.

Constructors

ItemCollectionMetrics'

Fields

itemCollectionKey :: Maybe (HashMap Text AttributeValue)
The partition key value of the item collection. This value is the same as the partition key value of the item.
sizeEstimateRangeGB :: Maybe [Double]
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Instances

Instances details

Eq ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods (==) :: ItemCollectionMetrics -> ItemCollectionMetrics -> Bool # (/=) :: ItemCollectionMetrics -> ItemCollectionMetrics -> Bool #
Read ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods readsPrec :: Int -> ReadS ItemCollectionMetrics # readList :: ReadS [ItemCollectionMetrics] # readPrec :: ReadPrec ItemCollectionMetrics # readListPrec :: ReadPrec [ItemCollectionMetrics] #
Show ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods showsPrec :: Int -> ItemCollectionMetrics -> ShowS # show :: ItemCollectionMetrics -> String # showList :: [ItemCollectionMetrics] -> ShowS #
Generic ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Associated Types type Rep ItemCollectionMetrics :: Type -> Type # Methods from :: ItemCollectionMetrics -> Rep ItemCollectionMetrics x # to :: Rep ItemCollectionMetrics x -> ItemCollectionMetrics #
NFData ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods rnf :: ItemCollectionMetrics -> () #
Hashable ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods hashWithSalt :: Int -> ItemCollectionMetrics -> Int # hash :: ItemCollectionMetrics -> Int #
FromJSON ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics Methods parseJSON :: Value -> Parser ItemCollectionMetrics # parseJSONList :: Value -> Parser [ItemCollectionMetrics] #
type Rep ItemCollectionMetrics Source #
Instance details Defined in Amazonka.DynamoDB.Types.ItemCollectionMetrics type Rep ItemCollectionMetrics = D1 ('MetaData "ItemCollectionMetrics" "Amazonka.DynamoDB.Types.ItemCollectionMetrics" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "ItemCollectionMetrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemCollectionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AttributeValue))) :*: S1 ('MetaSel ('Just "sizeEstimateRangeGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double]))))

newItemCollectionMetrics :: ItemCollectionMetrics Source #

Create a value of ItemCollectionMetrics 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:itemCollectionKey:ItemCollectionMetrics', itemCollectionMetrics_itemCollectionKey - The partition key value of the item collection. This value is the same as the partition key value of the item.

$sel:sizeEstimateRangeGB:ItemCollectionMetrics', itemCollectionMetrics_sizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

itemCollectionMetrics_itemCollectionKey :: Lens' ItemCollectionMetrics (Maybe (HashMap Text AttributeValue)) Source #

The partition key value of the item collection. This value is the same as the partition key value of the item.

itemCollectionMetrics_sizeEstimateRangeGB :: Lens' ItemCollectionMetrics (Maybe [Double]) Source #

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.