Struct aws_sdk_dynamodb::types::ItemCollectionMetrics

#[non_exhaustive]
pub struct ItemCollectionMetrics {
    pub item_collection_key: Option<HashMap<String, AttributeValue>>,
    pub size_estimate_range_gb: Option<Vec<f64>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

item_collection_key: Option<HashMap<String, AttributeValue>>

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

size_estimate_range_gb: Option<Vec<f64>>

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.

Implementations

impl ItemCollectionMetrics

pub fn item_collection_key(&self) -> Option<&HashMap<String, AttributeValue>>

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

pub fn size_estimate_range_gb(&self) -> &[f64]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .size_estimate_range_gb.is_none().

impl ItemCollectionMetrics

pub fn builder() -> ItemCollectionMetricsBuilder

Creates a new builder-style object to manufacture ItemCollectionMetrics.

Trait Implementations

impl Clone for ItemCollectionMetrics

fn clone(&self) -> ItemCollectionMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ItemCollectionMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ItemCollectionMetrics

fn eq(&self, other: &ItemCollectionMetrics) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ItemCollectionMetrics