Class: Aws::DynamoDB::Types::ScanOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::ScanOutput
- Defined in:
- gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb
Overview
Represents the output of a Scan
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#consumed_capacity ⇒ Types::ConsumedCapacity
The capacity units consumed by the
Scan
operation. -
#count ⇒ Integer
The number of items in the response.
-
#items ⇒ Array<Hash<String,Types::AttributeValue>>
An array of item attributes that match the scan criteria.
-
#last_evaluated_key ⇒ Hash<String,Types::AttributeValue>
The primary key of the item where the operation stopped, inclusive of the previous result set.
-
#scanned_count ⇒ Integer
The number of items evaluated, before any
ScanFilter
is applied.
Instance Attribute Details
#consumed_capacity ⇒ Types::ConsumedCapacity
The capacity units consumed by the Scan
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 unit consumption for read operations
in the Amazon DynamoDB Developer Guide.
8392 8393 8394 8395 8396 8397 8398 8399 8400 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8392 class ScanOutput < Struct.new( :items, :count, :scanned_count, :last_evaluated_key, :consumed_capacity) SENSITIVE = [] include Aws::Structure end |
#count ⇒ Integer
The number of items in the response.
If you set ScanFilter
in the request, then Count
is the number
of items returned after the filter was applied, and ScannedCount
is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count
is the same
as ScannedCount
.
8392 8393 8394 8395 8396 8397 8398 8399 8400 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8392 class ScanOutput < Struct.new( :items, :count, :scanned_count, :last_evaluated_key, :consumed_capacity) SENSITIVE = [] include Aws::Structure end |
#items ⇒ Array<Hash<String,Types::AttributeValue>>
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
8392 8393 8394 8395 8396 8397 8398 8399 8400 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8392 class ScanOutput < Struct.new( :items, :count, :scanned_count, :last_evaluated_key, :consumed_capacity) SENSITIVE = [] include Aws::Structure end |
#last_evaluated_key ⇒ Hash<String,Types::AttributeValue>
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results
has been processed and there is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean
that there is more data in the result set. The only way to know when
you have reached the end of the result set is when
LastEvaluatedKey
is empty.
8392 8393 8394 8395 8396 8397 8398 8399 8400 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8392 class ScanOutput < Struct.new( :items, :count, :scanned_count, :last_evaluated_key, :consumed_capacity) SENSITIVE = [] include Aws::Structure end |
#scanned_count ⇒ Integer
The number of items evaluated, before any ScanFilter
is applied. A
high ScannedCount
value with few, or no, Count
results indicates
an inefficient Scan
operation. For more information, see Count
and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is
the same as Count
.
8392 8393 8394 8395 8396 8397 8398 8399 8400 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8392 class ScanOutput < Struct.new( :items, :count, :scanned_count, :last_evaluated_key, :consumed_capacity) SENSITIVE = [] include Aws::Structure end |