Struct aws_sdk_dynamodb::output::BatchGetItemOutput
source · [−]#[non_exhaustive]pub struct BatchGetItemOutput {
pub responses: Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>>,
pub unprocessed_keys: Option<HashMap<String, KeysAndAttributes>>,
pub consumed_capacity: Option<Vec<ConsumedCapacity>>,
}
Expand description
Represents the output of a BatchGetItem
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.responses: Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>>
A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
unprocessed_keys: Option<HashMap<String, 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 totrue
, 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.
consumed_capacity: Option<Vec<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.
Implementations
sourceimpl BatchGetItemOutput
impl BatchGetItemOutput
sourcepub fn responses(
&self
) -> Option<&HashMap<String, Vec<HashMap<String, AttributeValue>>>>
pub fn responses(
&self
) -> Option<&HashMap<String, Vec<HashMap<String, AttributeValue>>>>
A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
sourcepub fn unprocessed_keys(&self) -> Option<&HashMap<String, KeysAndAttributes>>
pub fn unprocessed_keys(&self) -> Option<&HashMap<String, 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 totrue
, 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.
sourcepub fn consumed_capacity(&self) -> Option<&[ConsumedCapacity]>
pub fn consumed_capacity(&self) -> Option<&[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.
sourceimpl BatchGetItemOutput
impl BatchGetItemOutput
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture BatchGetItemOutput
Trait Implementations
sourceimpl Clone for BatchGetItemOutput
impl Clone for BatchGetItemOutput
sourcefn clone(&self) -> BatchGetItemOutput
fn clone(&self) -> BatchGetItemOutput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BatchGetItemOutput
impl Debug for BatchGetItemOutput
sourceimpl PartialEq<BatchGetItemOutput> for BatchGetItemOutput
impl PartialEq<BatchGetItemOutput> for BatchGetItemOutput
sourcefn eq(&self, other: &BatchGetItemOutput) -> bool
fn eq(&self, other: &BatchGetItemOutput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BatchGetItemOutput) -> bool
fn ne(&self, other: &BatchGetItemOutput) -> bool
This method tests for !=
.
impl StructuralPartialEq for BatchGetItemOutput
Auto Trait Implementations
impl RefUnwindSafe for BatchGetItemOutput
impl Send for BatchGetItemOutput
impl Sync for BatchGetItemOutput
impl Unpin for BatchGetItemOutput
impl UnwindSafe for BatchGetItemOutput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more