You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Represents the output of an UpdateItem operation.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<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 ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

Returns:



5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5226

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

#consumed_capacityTypes::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 Provisioned Throughput in the Amazon DynamoDB Developer Guide.



5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5226

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

#item_collection_metricsTypes::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.

  • SizeEstimateRange - 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.



5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5226

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