#[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>>,
/* private fields */
}
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§
source§impl 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) -> &[ConsumedCapacity]
pub fn consumed_capacity(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .consumed_capacity.is_none()
.
source§impl BatchGetItemOutput
impl BatchGetItemOutput
sourcepub fn builder() -> BatchGetItemOutputBuilder
pub fn builder() -> BatchGetItemOutputBuilder
Creates a new builder-style object to manufacture BatchGetItemOutput
.
Trait Implementations§
source§impl Clone for BatchGetItemOutput
impl Clone for BatchGetItemOutput
source§fn clone(&self) -> BatchGetItemOutput
fn clone(&self) -> BatchGetItemOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BatchGetItemOutput
impl Debug for BatchGetItemOutput
source§impl PartialEq for BatchGetItemOutput
impl PartialEq for BatchGetItemOutput
source§fn eq(&self, other: &BatchGetItemOutput) -> bool
fn eq(&self, other: &BatchGetItemOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for BatchGetItemOutput
impl RequestId for BatchGetItemOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.