Class: Aws::DynamoDB::Types::Update

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::Update

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass Update data as a hash:

{
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  update_expression: "UpdateExpression", # required
  table_name: "TableName", # required
  condition_expression: "ConditionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
  expression_attribute_values: {
    "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  return_values_on_condition_check_failure: "ALL_OLD", # accepts ALL_OLD, NONE
}

Represents a request to perform an ‘UpdateItem` operation.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #condition_expression ⇒ String

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

• #expression_attribute_names ⇒ Hash<String,String>

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

• #expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

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

• #key ⇒ Hash<String,Types::AttributeValue>

  The primary key of the item to be updated.

• #return_values_on_condition_check_failure ⇒ String

  Use ‘ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Update` condition fails.

• #table_name ⇒ String

  Name of the table for the ‘UpdateItem` request.

• #update_expression ⇒ String

  An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

Instance Attribute Details

#condition_expression ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#expression_attribute_names ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

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

Returns:

• (Hash<String,Types::AttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#key ⇒ Hash<String,Types::AttributeValue>

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

Returns:

• (Hash<String,Types::AttributeValue>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#return_values_on_condition_check_failure ⇒ String

Use ‘ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Update` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#table_name ⇒ String

Name of the table for the ‘UpdateItem` request.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end

#update_expression ⇒ String

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 7314

class Update < Struct.new(
  :key,
  :update_expression,
  :table_name,
  :condition_expression,
  :expression_attribute_names,
  :expression_attribute_values,
  :return_values_on_condition_check_failure)
  include Aws::Structure
end