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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#condition_expressionString

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

Returns:

  • (String)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#expression_attribute_namesHash<String,String>

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

Returns:

  • (Hash<String,String>)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#expression_attribute_valuesHash<String,Types::AttributeValue>

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

Returns:



9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#keyHash<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:



9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#return_values_on_condition_check_failureString

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)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#table_nameString

Name of the table for the UpdateItem request.

Returns:

  • (String)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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

#update_expressionString

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)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 9753

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