You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DynamoDB::Types::Put
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::Put
- Defined in:
- (unknown)
Overview
When passing Put as input to an Aws::Client method, you can use a vanilla 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.
Returned by:
Instance Attribute Summary collapse
-
#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.
-
#item ⇒ Hash<String,Types::AttributeValue>
A map of attribute name to attribute values, representing the primary key of the item to be written by
PutItem
. -
#return_values_on_condition_check_failure ⇒ String
Use
ReturnValuesOnConditionCheckFailure
to get the item attributes if thePut
condition fails. -
#table_name ⇒ String
Name of the table in which to write the item.
Instance Attribute Details
#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.
#item ⇒ Hash<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.
#return_values_on_condition_check_failure ⇒ String
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Put
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE and ALL_OLD.
Possible values:
- ALL_OLD
- NONE
#table_name ⇒ String
Name of the table in which to write the item.