class Amazonite::DynamoDB::DeleteItemOutput

Overview

Represents the output of a DeleteItem operation.

Included Modules

JSON::Serializable

Defined in:

dynamodb/delete_item_output.cr

Constructors

.new(pull : JSON::PullParser)
.new(attributes : Hash(String, AttributeValue) | Nil = nil, consumed_capacity : ConsumedCapacity | Nil = nil, item_collection_metrics : ItemCollectionMetrics | Nil = nil)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#attributes : Hash(String, AttributeValue) | Nil
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
#attributes=(attributes : Hash(String, AttributeValue) | Nil)
A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation.
#consumed_capacity : ConsumedCapacity | Nil
The capacity units consumed by the DeleteItem operation.
#consumed_capacity=(consumed_capacity : ConsumedCapacity | Nil)
The capacity units consumed by the DeleteItem operation.
#hash(hasher)
See Object#hash(hasher)
#item_collection_metrics : ItemCollectionMetrics | Nil
Information about item collections, if any, that were affected by the DeleteItem operation.
#item_collection_metrics=(item_collection_metrics : ItemCollectionMetrics | Nil)
Information about item collections, if any, that were affected by the DeleteItem operation.
#validate! : Nil

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(attributes : Hash(String, AttributeValue) | Nil = nil, consumed_capacity : ConsumedCapacity | Nil = nil, item_collection_metrics : ItemCollectionMetrics | Nil = nil) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def attributes : Hash(String, AttributeValue) | Nil #

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

[View source]

def attributes=(attributes : Hash(String, AttributeValue) | Nil) #

[View source]

def consumed_capacity : ConsumedCapacity | Nil #

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

If the table has vector indexes, the response includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index.

[View source]

def consumed_capacity=(consumed_capacity : ConsumedCapacity | Nil) #

If the table has vector indexes, the response includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def item_collection_metrics : ItemCollectionMetrics | Nil #

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
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.

[View source]

def item_collection_metrics=(item_collection_metrics : ItemCollectionMetrics | Nil) #

Each ItemCollectionMetrics element consists of:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
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.

[View source]

def validate! : Nil #

[View source]