Struct aws_sdk_dynamodb::types::ConditionCheck

#[non_exhaustive]
pub struct ConditionCheck {
    pub key: HashMap<String, AttributeValue>,
    pub table_name: String,
    pub condition_expression: String,
    pub expression_attribute_names: Option<HashMap<String, String>>,
    pub expression_attribute_values: Option<HashMap<String, AttributeValue>>,
    pub return_values_on_condition_check_failure: Option<ReturnValuesOnConditionCheckFailure>,
}

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

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.

key: HashMap<String, AttributeValue>

The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

table_name: String

Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

condition_expression: String

A condition that must be satisfied in order for a conditional update to succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

expression_attribute_names: Option<HashMap<String, String>>

One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.

expression_attribute_values: Option<HashMap<String, AttributeValue>>

One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

return_values_on_condition_check_failure: Option<ReturnValuesOnConditionCheckFailure>

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

Implementations

impl ConditionCheck

pub fn key(&self) -> &HashMap<String, AttributeValue>

The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

pub fn table_name(&self) -> &str

Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

pub fn condition_expression(&self) -> &str

A condition that must be satisfied in order for a conditional update to succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

pub fn expression_attribute_names(&self) -> Option<&HashMap<String, String>>

One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.

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

One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.

pub fn return_values_on_condition_check_failure( &self, ) -> Option<&ReturnValuesOnConditionCheckFailure>

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

impl ConditionCheck

pub fn builder() -> ConditionCheckBuilder

Creates a new builder-style object to manufacture ConditionCheck.

Trait Implementations

impl Clone for ConditionCheck

fn clone(&self) -> ConditionCheck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConditionCheck

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

Formats the value using the given formatter.

impl PartialEq for ConditionCheck

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