Struct aws_sdk_dynamodb::operation::batch_get_item::BatchGetItemOutput

#[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 */
}

Represents the output of a BatchGetItem operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 or table ARN to a list of items. Each object in Responses consists of a table name or ARN, 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 to true, 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

impl BatchGetItemOutput

pub fn responses( &self, ) -> Option<&HashMap<String, Vec<HashMap<String, AttributeValue>>>>

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

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 to true, 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.

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().

impl BatchGetItemOutput

pub fn builder() -> BatchGetItemOutputBuilder

Creates a new builder-style object to manufacture BatchGetItemOutput.

Trait Implementations

impl Clone for BatchGetItemOutput

fn clone(&self) -> BatchGetItemOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchGetItemOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BatchGetItemOutput

fn eq(&self, other: &BatchGetItemOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for BatchGetItemOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for BatchGetItemOutput