Struct aws_sdk_dynamodb::operation::scan::ScanOutput
source · #[non_exhaustive]pub struct ScanOutput { /* private fields */ }
Expand description
Represents the output of a Scan
operation.
Implementations§
source§impl ScanOutput
impl ScanOutput
sourcepub fn items(&self) -> Option<&[HashMap<String, AttributeValue>]>
pub fn items(&self) -> Option<&[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.
sourcepub fn count(&self) -> i32
pub fn count(&self) -> 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
.
sourcepub fn scanned_count(&self) -> i32
pub fn scanned_count(&self) -> 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
.
sourcepub fn last_evaluated_key(&self) -> Option<&HashMap<String, AttributeValue>>
pub fn last_evaluated_key(&self) -> 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.
sourcepub fn consumed_capacity(&self) -> Option<&ConsumedCapacity>
pub fn consumed_capacity(&self) -> 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.
source§impl ScanOutput
impl ScanOutput
sourcepub fn builder() -> ScanOutputBuilder
pub fn builder() -> ScanOutputBuilder
Creates a new builder-style object to manufacture ScanOutput
.
Trait Implementations§
source§impl Clone for ScanOutput
impl Clone for ScanOutput
source§fn clone(&self) -> ScanOutput
fn clone(&self) -> ScanOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ScanOutput
impl Debug for ScanOutput
source§impl PartialEq<ScanOutput> for ScanOutput
impl PartialEq<ScanOutput> for ScanOutput
source§fn eq(&self, other: &ScanOutput) -> bool
fn eq(&self, other: &ScanOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for ScanOutput
impl RequestId for ScanOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.