Struct aws_sdk_dynamodb::output::ScanOutput [−][src]
#[non_exhaustive]pub struct ScanOutput {
pub items: Option<Vec<HashMap<String, AttributeValue>>>,
pub count: i32,
pub scanned_count: i32,
pub last_evaluated_key: Option<HashMap<String, AttributeValue>>,
pub consumed_capacity: Option<ConsumedCapacity>,
}
Expand description
Represents the output of a Scan
operation.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.items: Option<Vec<HashMap<String, 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.
count: i32
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
.
scanned_count: i32
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
.
last_evaluated_key: Option<HashMap<String, 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.
consumed_capacity: Option<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.
Implementations
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.
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
.
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
.
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.
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.
Creates a new builder-style object to manufacture ScanOutput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ScanOutput
impl Send for ScanOutput
impl Sync for ScanOutput
impl Unpin for ScanOutput
impl UnwindSafe for ScanOutput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more