Struct aws_sdk_dynamodb::types::Delete

#[non_exhaustive]
pub struct Delete {
    pub key: HashMap<String, AttributeValue>,
    pub table_name: String,
    pub condition_expression: Option<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 DeleteItem 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.

key: HashMap<String, AttributeValue>

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

table_name: String

Name of the table in which the item to be deleted resides. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

condition_expression: Option<String>

A condition that must be satisfied in order for a conditional delete to succeed.

expression_attribute_names: Option<HashMap<String, String>>

One or more substitution tokens for attribute names in an expression.

expression_attribute_values: Option<HashMap<String, AttributeValue>>

One or more values that can be substituted in an expression.

return_values_on_condition_check_failure: Option<ReturnValuesOnConditionCheckFailure>

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

Implementations

impl Delete

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

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

pub fn table_name(&self) -> &str

Name of the table in which the item to be deleted resides. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

A condition that must be satisfied in order for a conditional delete to succeed.

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

One or more substitution tokens for attribute names in an expression.

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

One or more values that can be substituted in an expression.

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

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

impl Delete

pub fn builder() -> DeleteBuilder

Creates a new builder-style object to manufacture Delete.

Trait Implementations

impl Clone for Delete

fn clone(&self) -> Delete

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Delete

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

Formats the value using the given formatter.

impl PartialEq for Delete

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