![]() |
![]()
| ![]() |
![]()
NAMEPaws::DynamoDB::UpdateItem - Arguments for method UpdateItem on Paws::DynamoDB DESCRIPTIONThis class represents the parameters used for calling the method UpdateItem on the Amazon DynamoDB service. Use the attributes of this class as arguments to method UpdateItem. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateItem. SYNOPSISmy $dynamodb = Paws->service('DynamoDB'); # To update an item in a table # This example updates an item in the Music table. It adds a new attribute # (Year) and modifies the AlbumTitle attribute. All of the attributes in the # item, as they appear after the update, are returned in the response. my $UpdateItemOutput = $dynamodb->UpdateItem( 'ExpressionAttributeNames' => { '#AT' => 'AlbumTitle', '#Y' => 'Year' }, 'ExpressionAttributeValues' => { ':t' => { 'S' => 'Louder Than Ever' }, ':y' => { 'N' => 2015 } }, 'Key' => { 'Artist' => { 'S' => 'Acme Band' }, 'SongTitle' => { 'S' => 'Happy Day' } }, 'ReturnValues' => 'ALL_NEW', 'TableName' => 'Music', 'UpdateExpression' => 'SET #Y = :y, #AT = :t' ); # Results: my $Attributes = $UpdateItemOutput->Attributes; # Returns a L<Paws::DynamoDB::UpdateItemOutput> object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/dynamodb/UpdateItem> ATTRIBUTESAttributeUpdates => Paws::DynamoDB::AttributeUpdatesThis is a legacy parameter. Use "UpdateExpression" instead. For more information, see AttributeUpdates (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) in the Amazon DynamoDB Developer Guide. ConditionalOperator => StrThis is a legacy parameter. Use "ConditionExpression" instead. For more information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the Amazon DynamoDB Developer Guide. Valid values are: "AND", "OR" ConditionExpression => StrA condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following:
For more information about condition expressions, see Specifying Conditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the Amazon DynamoDB Developer Guide. Expected => Paws::DynamoDB::ExpectedAttributeMapThis is a legacy parameter. Use "ConditionExpression" instead. For more information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames => Paws::DynamoDB::ExpressionAttributeNameMapOne or more substitution tokens for attribute names in an expression. The following are some use cases for using "ExpressionAttributeNames":
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for "ExpressionAttributeNames":
You could then use this substitution in an expression, as in this example:
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information about expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues => Paws::DynamoDB::ExpressionAttributeValueMapOne or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the "ProductStatus" attribute was one of the following: "Available | Backordered | Discontinued" You would first need to specify "ExpressionAttributeValues" as follows: "{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }" You could then use these values in an expression, such as this: "ProductStatus IN (:avail, :back, :disc)" For more information on expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the Amazon DynamoDB Developer Guide. REQUIRED Key => Paws::DynamoDB::KeyThe primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. ReturnConsumedCapacity => StrValid values are: "INDEXES", "TOTAL", "NONE" ReturnItemCollectionMetrics => StrDetermines whether item collection metrics are returned. If set to "SIZE", the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to "NONE" (the default), no statistics are returned. Valid values are: "SIZE", "NONE" ReturnValues => StrUse "ReturnValues" if you want to get the item attributes as they appear before or after they are updated. For "UpdateItem", the valid values are:
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent. Valid values are: "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" REQUIRED TableName => StrThe name of the table containing the item to update. UpdateExpression => StrAn expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them. The following action values are available for "UpdateExpression".
These function names are case-sensitive.
The "ADD" action only supports Number and set data types. In addition, "ADD" can only be used on top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the following: "SET a=:value1, b=:value2 DELETE :value3, :value4, :value5" For more information on update expressions, see Modifying Items and Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html) in the Amazon DynamoDB Developer Guide. SEE ALSOThis class forms part of Paws, documenting arguments for method UpdateItem in Paws::DynamoDB BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|