Class: Aws::DynamoDB::Types::BatchGetItemOutput

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::BatchGetItemOutput

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Represents the output of a ‘BatchGetItem` operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consumed_capacity ⇒ Array<Types::ConsumedCapacity>

  The read capacity units consumed by the entire ‘BatchGetItem` operation.

• #responses ⇒ Hash<String,Array<Hash<String,Types::AttributeValue>>>

  A map of table name or table ARN to a list of items.

• #unprocessed_keys ⇒ Hash<String,Types::KeysAndAttributes>

  A map of tables and their respective keys that were not processed with the current response.

Instance Attribute Details

#consumed_capacity ⇒ Array<Types::ConsumedCapacity>

The read capacity units consumed by the entire ‘BatchGetItem` operation.

Each element consists of:

• ‘TableName` - The table that consumed the provisioned throughput.

• ‘CapacityUnits` - The total number of capacity units consumed.

Returns:

• (Array<Types::ConsumedCapacity>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 899

class BatchGetItemOutput < Struct.new(
  :responses,
  :unprocessed_keys,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#responses ⇒ Hash<String,Array<Hash<String,Types::AttributeValue>>>

A map of table name or table ARN to a list of items. Each object in ‘Responses` consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

Returns:

• (Hash<String,Array<Hash<String,Types::AttributeValue>>>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 899

class BatchGetItemOutput < Struct.new(
  :responses,
  :unprocessed_keys,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#unprocessed_keys ⇒ Hash<String,Types::KeysAndAttributes>

A map of tables and their respective keys that were not processed with the current response. The ‘UnprocessedKeys` value is in the same form as `RequestItems`, so the value can be provided directly to a subsequent `BatchGetItem` operation. For more information, see `RequestItems` in the Request Parameters section.

Each element consists of:

• ‘Keys` - An array of primary key attribute values that define specific items in the table.

• ‘ProjectionExpression` - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

• ‘ConsistentRead` - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty ‘UnprocessedKeys` map.

Returns:

• (Hash<String,Types::KeysAndAttributes>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 899

class BatchGetItemOutput < Struct.new(
  :responses,
  :unprocessed_keys,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end