Class: Aws::DynamoDB::Types::ScanOutput

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

Overview

Represents the output of a `Scan` operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html


8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/aws-sdk-dynamodb/types.rb', line 8436

class ScanOutput < Struct.new(
  :items,
  :count,
  :scanned_count,
  :last_evaluated_key,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#countInteger

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

Returns:

  • (Integer)

8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/aws-sdk-dynamodb/types.rb', line 8436

class ScanOutput < Struct.new(
  :items,
  :count,
  :scanned_count,
  :last_evaluated_key,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#itemsArray<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.

Returns:


8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/aws-sdk-dynamodb/types.rb', line 8436

class ScanOutput < Struct.new(
  :items,
  :count,
  :scanned_count,
  :last_evaluated_key,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#last_evaluated_keyHash<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.

Returns:


8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/aws-sdk-dynamodb/types.rb', line 8436

class ScanOutput < Struct.new(
  :items,
  :count,
  :scanned_count,
  :last_evaluated_key,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#scanned_countInteger

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count

Returns:

  • (Integer)

8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/aws-sdk-dynamodb/types.rb', line 8436

class ScanOutput < Struct.new(
  :items,
  :count,
  :scanned_count,
  :last_evaluated_key,
  :consumed_capacity)
  SENSITIVE = []
  include Aws::Structure
end