Class: Aws::DynamoDB::Types::Put

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Note:

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

{
  item: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  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 a `PutItem` 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)

5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

class Put < Struct.new(
  :item,
  :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>)

5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

class Put < Struct.new(
  :item,
  :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:


5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

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

#itemHash<String,Types::AttributeValue>

A map of attribute name to attribute values, representing the primary key of the item to be written by `PutItem`. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

Returns:


5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

class Put < Struct.new(
  :item,
  :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 `Put` condition fails. For `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL_OLD.

Returns:

  • (String)

5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

class Put < Struct.new(
  :item,
  :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 in which to write the item.

Returns:

  • (String)

5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
# File 'lib/aws-sdk-dynamodb/types.rb', line 5962

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