Class: Aws::DynamoDB::Types::UpdateItemOutput

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

Overview

Represents the output of an ‘UpdateItem` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

A map of attribute values as they appear before or after the ‘UpdateItem` operation, as determined by the `ReturnValues` parameter.

The ‘Attributes` map is only present if the update was successful and `ReturnValues` was specified as something other than `NONE` in the request. Each element represents one attribute.

Returns:



10276
10277
10278
10279
10280
10281
10282
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 10276

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

#consumed_capacity ⇒ Types::ConsumedCapacity

The capacity units consumed by the ‘UpdateItem` 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 [Capacity unity consumption for write operations] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption

Returns:



10276
10277
10278
10279
10280
10281
10282
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 10276

class UpdateItemOutput < 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 ‘UpdateItem` 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:



10276
10277
10278
10279
10280
10281
10282
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 10276

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