Class: Aws::DynamoDB::Types::DeleteItemOutput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Represents the output of a ‘DeleteItem` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,Types::AttributeValue>

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.

Returns:



2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 2508

class DeleteItemOutput < Struct.new(
  :attributes,
  :consumed_capacity,
  :item_collection_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_capacity ⇒ Types::ConsumedCapacity

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*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html

Returns:



2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 2508

class DeleteItemOutput < Struct.new(
  :attributes,
  :consumed_capacity,
  :item_collection_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#item_collection_metrics ⇒ Types::ItemCollectionMetrics

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.

Returns:



2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 2508

class DeleteItemOutput < Struct.new(
  :attributes,
  :consumed_capacity,
  :item_collection_metrics)
  SENSITIVE = []
  include Aws::Structure
end