Struct aws_sdk_dynamodb::operation::execute_statement::ExecuteStatementOutput

#[non_exhaustive]
pub struct ExecuteStatementOutput {
    pub items: Option<Vec<HashMap<String, AttributeValue>>>,
    pub next_token: Option<String>,
    pub consumed_capacity: Option<ConsumedCapacity>,
    pub last_evaluated_key: Option<HashMap<String, AttributeValue>>,
    /* private fields */
}

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.

items: Option<Vec<HashMap<String, AttributeValue>>>

If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

next_token: Option<String>

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

consumed_capacity: Option<ConsumedCapacity>

The capacity units consumed by an 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 request asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

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.

Implementations

impl ExecuteStatementOutput

pub fn items(&self) -> &[HashMap<String, AttributeValue>]

If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .items.is_none().

pub fn next_token(&self) -> Option<&str>

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

pub fn consumed_capacity(&self) -> Option<&ConsumedCapacity>

The capacity units consumed by an 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 request asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

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.

impl ExecuteStatementOutput

pub fn builder() -> ExecuteStatementOutputBuilder

Creates a new builder-style object to manufacture ExecuteStatementOutput.

Trait Implementations

impl Clone for ExecuteStatementOutput

fn clone(&self) -> ExecuteStatementOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteStatementOutput

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

Formats the value using the given formatter.

impl PartialEq for ExecuteStatementOutput

fn eq(&self, other: &ExecuteStatementOutput) -> 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 ExecuteStatementOutput

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

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

impl StructuralPartialEq for ExecuteStatementOutput