diff options
| author | kyleknap <kyleknap@amazon.com> | 2014-10-07 15:21:47 -0700 |
|---|---|---|
| committer | kyleknap <kyleknap@amazon.com> | 2014-10-08 09:26:01 -0700 |
| commit | b9d9220182b76219a4d538f79e1a8ddcd6ec12be (patch) | |
| tree | 0f84a5d9e63efcc72f575dba25c424d76dcc4d2d | |
| parent | bce8fcfc5e4aef956ad4779c09a3b71dae904143 (diff) | |
| download | boto-b9d9220182b76219a4d538f79e1a8ddcd6ec12be.tar.gz | |
Add support for DynamoDB recursive shapes
| -rw-r--r-- | boto/dynamodb2/layer1.py | 1799 | ||||
| -rw-r--r-- | tests/integration/dynamodb2/test_layer1.py | 39 |
2 files changed, 1254 insertions, 584 deletions
diff --git a/boto/dynamodb2/layer1.py b/boto/dynamodb2/layer1.py index aa319cfd..fd98d2f9 100644 --- a/boto/dynamodb2/layer1.py +++ b/boto/dynamodb2/layer1.py @@ -21,12 +21,8 @@ # from binascii import crc32 -try: - import json -except ImportError: - import simplejson as json - import boto +from boto.compat import json from boto.connection import AWSQueryConnection from boto.regioninfo import RegionInfo from boto.exception import JSONResponseError @@ -93,7 +89,7 @@ class DynamoDBConnection(AWSQueryConnection): consistent read instead. + BatchGetItem - Performs multiple GetItem requests for data items using their primary keys, from one table or multiple tables. The - response from BatchGetItem has a size limit of 1 MB and returns a + response from BatchGetItem has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. + Query - Returns one or more items from a table or a secondary @@ -136,7 +132,8 @@ class DynamoDBConnection(AWSQueryConnection): requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire BatchWriteItem operation to fail. Supports batches of up to 25 - items to put or delete, with a maximum total request size of 1 MB. + items to put or delete, with a maximum total request size of 16 + MB. @@ -159,7 +156,6 @@ class DynamoDBConnection(AWSQueryConnection): "ResourceNotFoundException": exceptions.ResourceNotFoundException, "InternalServerError": exceptions.InternalServerError, "ItemCollectionSizeLimitExceededException": exceptions.ItemCollectionSizeLimitExceededException, - "ValidationException": exceptions.ValidationException, } NumberRetries = 10 @@ -195,7 +191,7 @@ class DynamoDBConnection(AWSQueryConnection): more items from one or more tables. You identify requested items by primary key. - A single operation can retrieve up to 1 MB of data, which can + A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal @@ -205,15 +201,15 @@ class DynamoDBConnection(AWSQueryConnection): item to get. For example, if you ask to retrieve 100 items, but each - individual item is 50 KB in size, the system returns 20 items - (1 MB) and an appropriate UnprocessedKeys value so you can get - the next page of results. If desired, your application can - include its own logic to assemble the pages of results into - one dataset. + individual item is 300 KB in size, the system returns 52 items + (so as not to exceed the 16 MB limit). It also returns an + appropriate UnprocessedKeys value so you can get the next page + of results. If desired, your application can include its own + logic to assemble the pages of results into one data set. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, - then BatchGetItem will throw a + then BatchGetItem will return a ProvisionedThroughputExceededException . If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread @@ -229,7 +225,7 @@ class DynamoDBConnection(AWSQueryConnection): much more likely to succeed. For more information, go to `Batch Operations and Error - Handling`_ in the Amazon DynamoDB Developer Guide. + Handling`_ in the Amazon DynamoDB Developer Guide . By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent @@ -248,7 +244,7 @@ class DynamoDBConnection(AWSQueryConnection): result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see `Capacity Units Calculations`_ in the Amazon - DynamoDB Developer Guide. + DynamoDB Developer Guide . :type request_items: map :param request_items: @@ -276,11 +272,11 @@ class DynamoDBConnection(AWSQueryConnection): `False` (the default), an eventually consistent read is used. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. """ params = {'RequestItems': request_items, } @@ -294,12 +290,9 @@ class DynamoDBConnection(AWSQueryConnection): """ The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write - up to 1 MB of data, which can comprise as many as 25 put or + up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as - large as 64 KB. - - BatchWriteItem cannot update items. To update items, use the - UpdateItem API. + large as 400 KB. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole @@ -314,7 +307,7 @@ class DynamoDBConnection(AWSQueryConnection): Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in - the request, then BatchGetItem will throw a + the request, then BatchWriteItem will return a ProvisionedThroughputExceededException . If DynamoDB returns any unprocessed items, you should retry @@ -327,7 +320,7 @@ class DynamoDBConnection(AWSQueryConnection): much more likely to succeed. For more information, go to `Batch Operations and Error - Handling`_ in the Amazon DynamoDB Developer Guide. + Handling`_ in the Amazon DynamoDB Developer Guide . With BatchWriteItem , you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce @@ -368,8 +361,9 @@ class DynamoDBConnection(AWSQueryConnection): + You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. - + The total request size exceeds 1 MB. - + Any individual item in a batch exceeds 64 KB. + + There are more than 25 requests in the batch. + + Any individual item in a batch exceeds 400 KB. + + The total request size exceeds 16 MB. :type request_items: map :param request_items: @@ -397,22 +391,23 @@ class DynamoDBConnection(AWSQueryConnection): values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a - ValidationException . If you specify any attributes that are part - of an index key, then the data types for those attributes must - match those of the schema in the table's attribute definition. + ValidationException exception. If you specify any attributes that + are part of an index key, then the data types for those attributes + must match those of the schema in the table's attribute definition. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. :type return_item_collection_metrics: string - :param return_item_collection_metrics: If set to `SIZE`, 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. + :param return_item_collection_metrics: A value that 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. """ params = {'RequestItems': request_items, } @@ -456,7 +451,7 @@ class DynamoDBConnection(AWSQueryConnection): :param key_schema: Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, - see `Data Model`_ in the Amazon DynamoDB Developer Guide. + see `Data Model`_ in the Amazon DynamoDB Developer Guide . Each KeySchemaElement in the array is composed of: @@ -473,7 +468,7 @@ class DynamoDBConnection(AWSQueryConnection): KeyType of `RANGE`. For more information, see `Specifying the Primary Key`_ in the Amazon - DynamoDB Developer Guide. + DynamoDB Developer Guide . :type local_secondary_indexes: list :param local_secondary_indexes: @@ -551,7 +546,7 @@ class DynamoDBConnection(AWSQueryConnection): settings for a specified table or index. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see - `Limits`_ in the Amazon DynamoDB Developer Guide. + `Limits`_ in the Amazon DynamoDB Developer Guide . """ params = { @@ -570,7 +565,10 @@ class DynamoDBConnection(AWSQueryConnection): def delete_item(self, table_name, key, expected=None, conditional_operator=None, return_values=None, return_consumed_capacity=None, - return_item_collection_metrics=None): + return_item_collection_metrics=None, + condition_expression=None, + expression_attribute_names=None, + expression_attribute_values=None): """ Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item @@ -584,7 +582,7 @@ class DynamoDBConnection(AWSQueryConnection): operation; running it multiple times on the same item or attribute does not result in an error response. - Conditional deletes are useful for only deleting items if + Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. @@ -602,8 +600,14 @@ class DynamoDBConnection(AWSQueryConnection): :type expected: map :param expected: - A map of attribute/condition pairs. This is the conditional block for - the DeleteItem operation. + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use Expected and ConditionExpression at the same + time, DynamoDB will return a ValidationException exception. + + This parameter does not support lists or maps. + + A map of attribute/condition pairs. Expected provides a conditional + block for the DeleteItem operation. Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute @@ -621,8 +625,7 @@ class DynamoDBConnection(AWSQueryConnection): If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails. - Each item in Expected represents an attribute name for DynamoDB to - check, along with an AttributeValueList and a ComparisonOperator : + Expected contains the following: + AttributeValueList - One or more values to evaluate against the @@ -633,7 +636,7 @@ class DynamoDBConnection(AWSQueryConnection): `a` is greater than `A`, and `aa` is greater than `B`. For a list of code values, see `http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_. - For Binary, DynamoDB treats each byte of the binary data as + For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. + ComparisonOperator - A comparator for evaluating attributes in the @@ -643,13 +646,16 @@ class DynamoDBConnection(AWSQueryConnection): CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN` The following are descriptions of each comparison operator. - + `EQ` : Equal. AttributeValueList can contain only one AttributeValue - of type String, Number, Binary, String Set, Number Set, or Binary - Set. If an item contains an AttributeValue of a different type than - the one specified in the request, the value does not match. For - example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` - does not equal `{"NS":["6", "2", "1"]}`. > <li> - + `NE` : Not equal. AttributeValueList can contain only one + + `EQ` : Equal. `EQ` is supported for all datatypes, including lists + and maps. AttributeValueList can contain only one AttributeValue + element of type String, Number, Binary, String Set, Number Set, or + Binary Set. If an item contains an AttributeValue element of a + different type than the one specified in the request, the value + does not match. For example, `{"S":"6"}` does not equal + `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", + "1"]}`. > <li> + + `NE` : Not equal. `NE` is supported for all datatypes, including + lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value @@ -657,74 +663,84 @@ class DynamoDBConnection(AWSQueryConnection): `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", "1"]}`. > <li> + `LE` : Less than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `LT` : Less than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue of type String, Number, or Binary (not a set type). + If an item contains an AttributeValue element of a different type + than the one specified in the request, the value does not match. + For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GE` : Greater than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GT` : Greater than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> - + `NOT_NULL` : The attribute exists. - + `NULL` : The attribute does not exist. - + `CONTAINS` : checks for a subsequence, or value in a set. - AttributeValueList can contain only one AttributeValue of type - String, Number, or Binary (not a set). If the target attribute of - the comparison is a String, then the operation checks for a - substring match. If the target attribute of the comparison is - Binary, then the operation looks for a subsequence of the target - that matches the input. If the target attribute of the comparison - is a set ("SS", "NS", or "BS"), then the operation checks for a - member of the set (not as a substring). - + `NOT_CONTAINS` : checks for absence of a subsequence, or absence of a + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + + `NOT_NULL` : The attribute exists. `NOT_NULL` is supported for all + datatypes, including lists and maps. + + `NULL` : The attribute does not exist. `NULL` is supported for all + datatypes, including lists and maps. + + `CONTAINS` : Checks for a subsequence, or value in a set. + AttributeValueList can contain only one AttributeValue element of + type String, Number, or Binary (not a set type). If the target + attribute of the comparison is of type String, then the operator + checks for a substring match. If the target attribute of the + comparison is of type Binary, then the operator looks for a + subsequence of the target that matches the input. If the target + attribute of the comparison is a set (" `SS`", " `NS`", or " + `BS`"), then the operator evaluates to true if it finds an exact + match with any member of the set. CONTAINS is supported for lists: + When evaluating " `a CONTAINS b`", " `a`" can be a list; however, " + `b`" cannot be a set, a map, or a list. + + `NOT_CONTAINS` : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If - the target attribute of the comparison is a String, then the - operation checks for the absence of a substring match. If the - target attribute of the comparison is Binary, then the operation + AttributeValue element of type String, Number, or Binary (not a set + type). If the target attribute of the comparison is a String, then + the operator checks for the absence of a substring match. If the + target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches - the input. If the target attribute of the comparison is a set - ("SS", "NS", or "BS"), then the operation checks for the absence of - a member of the set (not as a substring). - + `BEGINS_WITH` : checks for a prefix. AttributeValueList can contain + the input. If the target attribute of the comparison is a set (" + `SS`", " `NS`", or " `BS`"), then the operator evaluates to true if + it does not find an exact match with any member of the set. + NOT_CONTAINS is supported for lists: When evaluating " `a NOT + CONTAINS b`", " `a`" can be a list; however, " `b`" cannot be a + set, a map, or a list. + + `BEGINS_WITH` : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a - set). The target attribute of the comparison must be a String or - Binary (not a Number or a set). > <li> - + `IN` : checks for exact matches. AttributeValueList can contain more - than one AttributeValue of type String, Number, or Binary (not a - set). The target attribute of the comparison must be of the same - type and exact value to match. A String never matches a String set. + set type). The target attribute of the comparison must be of type + String or Binary (not a Number or a set type). > <li> + + `IN` : Checks for matching elements within two sets. + AttributeValueList can contain one or more AttributeValue elements + of type String, Number, or Binary (not a set type). These + attributes are compared against an existing set type attribute of + an item. If any elements of the input set are present in the item + attribute, the expression evaluates to true. + `BETWEEN` : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or - Binary (not a set). A target attribute matches if the target value - is greater than, or equal to, the first element and less than, or - equal to, the second element. If an item contains an AttributeValue - of a different type than the one specified in the request, the - value does not match. For example, `{"S":"6"}` does not compare to - `{"N":"6"}`. Also, `{"N":"6"}` does not compare to `{"NS":["6", - "2", "1"]}` + Binary (not a set type). A target attribute matches if the target + value is greater than, or equal to, the first element and less + than, or equal to, the second element. If an item contains an + AttributeValue element of a different type than the one specified + in the request, the value does not match. For example, `{"S":"6"}` + does not compare to `{"N":"6"}`. Also, `{"N":"6"}` does not compare + to `{"NS":["6", "2", "1"]}` For usage examples of AttributeValueList and ComparisonOperator , see - `Conditional Expressions`_ in the Amazon DynamoDB Developer Guide. - + `Legacy Conditional Parameters`_ in the Amazon DynamoDB Developer + Guide . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and @@ -732,8 +748,8 @@ class DynamoDBConnection(AWSQueryConnection): + Value - A value for DynamoDB to compare with an attribute. - + Exists - Causes DynamoDB to evaluate the value before attempting the - conditional operation: + + Exists - A Boolean value that causes DynamoDB to evaluate the value + before attempting the conditional operation: + If Exists is `True`, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the @@ -747,19 +763,22 @@ class DynamoDBConnection(AWSQueryConnection): - Even though DynamoDB continues to accept the Value and Exists - parameters, they are now deprecated. We recommend that you use - AttributeValueList and ComparisonOperator instead, since they allow - you to construct a much wider range of conditions. - The Value and Exists parameters are incompatible with - AttributeValueList and ComparisonOperator . If you attempt to use - both sets of parameters at once, DynamoDB will throw a - ValidationException . + AttributeValueList and ComparisonOperator . Note that if you use + both sets of parameters at once, DynamoDB will return a + ValidationException exception. :type conditional_operator: string - :param conditional_operator: A logical operator to apply to the - conditions in the Expected map: + :param conditional_operator: + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use ConditionalOperator and ConditionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter does not support lists or maps. + + A logical operator to apply to the conditions in the Expected map: + + `AND` - If all of the conditions evaluate to true, then the entire map evaluates to true. @@ -779,21 +798,95 @@ class DynamoDBConnection(AWSQueryConnection): + `NONE` - If ReturnValues is not specified, or if its value is `NONE`, - then nothing is returned. (This is the default for ReturnValues .) + then nothing is returned. (This setting is the default for + ReturnValues .) + `ALL_OLD` - The content of the old item is returned. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. :type return_item_collection_metrics: string - :param return_item_collection_metrics: If set to `SIZE`, 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. + :param return_item_collection_metrics: A value that 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. + + :type condition_expression: string + :param condition_expression: + A condition that must be satisfied in order for a conditional + DeleteItem to succeed. + + An expression can contain any of the following: + + + + Boolean functions: `ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH` + + Comparison operators: ` = | <> | < | > | <= + | >= | BETWEEN | IN` + + Logical operators: `NOT | AND | OR` + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` + + :type expression_attribute_values: map + :param expression_attribute_values: + One or more values that can be substituted in an expression. + + Use the **:** character in an expression to dereference an attribute + value. For example, consider the following expression: + + + + `ProductStatus IN ("Available","Backordered","Discontinued")` + + + Now suppose that you specified the following for + ExpressionAttributeValues : + + + + `{ "a":{"S":"Available"}, "b":{"S":"Backordered"}, + "d":{"S":"Discontinued"} }` + + + The expression can now be simplified as follows: + + + + `ProductStatus IN (:a,:b,:c)` """ params = {'TableName': table_name, 'Key': key, } @@ -807,6 +900,12 @@ class DynamoDBConnection(AWSQueryConnection): params['ReturnConsumedCapacity'] = return_consumed_capacity if return_item_collection_metrics is not None: params['ReturnItemCollectionMetrics'] = return_item_collection_metrics + if condition_expression is not None: + params['ConditionExpression'] = condition_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names + if expression_attribute_values is not None: + params['ExpressionAttributeValues'] = expression_attribute_values return self.make_request(action='DeleteItem', body=json.dumps(params)) @@ -822,10 +921,6 @@ class DynamoDBConnection(AWSQueryConnection): table is already in the `DELETING` state, no error is returned. - DynamoDB might continue to accept data read and write - operations, such as GetItem and PutItem , on a table in the - `DELETING` state until the table deletion is complete. - When you delete a table, any indexes on that table are also deleted. @@ -854,7 +949,8 @@ class DynamoDBConnection(AWSQueryConnection): body=json.dumps(params)) def get_item(self, table_name, key, attributes_to_get=None, - consistent_read=None, return_consumed_capacity=None): + consistent_read=None, return_consumed_capacity=None, + projection_expression=None, expression_attribute_names=None): """ The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, @@ -878,26 +974,80 @@ class DynamoDBConnection(AWSQueryConnection): specify both the hash attribute and the range attribute. :type attributes_to_get: list - :param attributes_to_get: The names of one or more attributes to - retrieve. If no attribute names are specified, then all attributes - will be returned. If any of the requested attributes are not found, - they will not appear in the result. + :param attributes_to_get: + There is a newer parameter available. Use ProjectionExpression instead. + Note that if you use AttributesToGet and ProjectionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter allows you to retrieve lists or maps; however, it cannot + retrieve individual list or map elements. + + The names of one or more attributes to retrieve. If no attribute names + are specified, then all attributes will be returned. If any of the + requested attributes are not found, they will not appear in the + result. + Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. :type consistent_read: boolean - :param consistent_read: If set to `True`, then the operation uses - strongly consistent reads; otherwise, eventually consistent reads - are used. + :param consistent_read: A value that if set to `True`, then the + operation uses strongly consistent reads; otherwise, eventually + consistent reads are used. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. + + :type projection_expression: string + :param projection_expression: One or more attributes to retrieve from + the table. These attributes can include scalars, sets, or elements + of a JSON document. The attributes in the expression must be + separated by commas. + If no attribute names are specified, then all attributes will be + returned. If any of the requested attributes are not found, they + will not appear in the result. + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` """ params = {'TableName': table_name, 'Key': key, } @@ -907,6 +1057,10 @@ class DynamoDBConnection(AWSQueryConnection): params['ConsistentRead'] = consistent_read if return_consumed_capacity is not None: params['ReturnConsumedCapacity'] = return_consumed_capacity + if projection_expression is not None: + params['ProjectionExpression'] = projection_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names return self.make_request(action='GetItem', body=json.dumps(params)) @@ -938,14 +1092,17 @@ class DynamoDBConnection(AWSQueryConnection): def put_item(self, table_name, item, expected=None, return_values=None, return_consumed_capacity=None, return_item_collection_metrics=None, - conditional_operator=None): + conditional_operator=None, condition_expression=None, + expression_attribute_names=None, + expression_attribute_values=None): """ Creates a new item, or replaces an old item with a new item. - If an item already exists in the specified table with the same - primary key, the new item completely replaces the existing - item. You can perform a conditional put (insert a new item if - one with the specified primary key doesn't exist), or replace - an existing item if it has certain attribute values. + If an item that has the same primary key as the new item + already exists in the specified table, the new item completely + replaces the existing item. You can perform a conditional put + operation (add a new item if one with the specified primary + key doesn't exist), or replace an existing item if it has + certain attribute values. In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues @@ -953,21 +1110,18 @@ class DynamoDBConnection(AWSQueryConnection): When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. - String and binary type attributes must have lengths greater + String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with - empty values will be rejected with a ValidationException . + empty values will be rejected with a ValidationException + exception. - You can request that PutItem return either a copy of the old - item (before the update) or a copy of the new item (after the - update). For more information, see the ReturnValues - description. - - To prevent a new item from replacing an existing item, use a - conditional put operation with ComparisonOperator set to - `NULL` for the primary key attribute, or attributes. + You can request that PutItem return either a copy of the + original item (before the update) or a copy of the updated + item (after the update). For more information, see the + ReturnValues description below. For more information about using this API, see `Working with - Items`_ in the Amazon DynamoDB Developer Guide. + Items`_ in the Amazon DynamoDB Developer Guide . :type table_name: string :param table_name: The name of the table to contain the item. @@ -986,14 +1140,20 @@ class DynamoDBConnection(AWSQueryConnection): the table's attribute definition. For more information about primary keys, see `Primary Key`_ in the - Amazon DynamoDB Developer Guide. + Amazon DynamoDB Developer Guide . Each element in the Item map is an AttributeValue object. :type expected: map :param expected: - A map of attribute/condition pairs. This is the conditional block for - the PutItem operation. + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use Expected and ConditionExpression at the same + time, DynamoDB will return a ValidationException exception. + + This parameter does not support lists or maps. + + A map of attribute/condition pairs. Expected provides a conditional + block for the PutItem operation. Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute @@ -1011,8 +1171,7 @@ class DynamoDBConnection(AWSQueryConnection): If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails. - Each item in Expected represents an attribute name for DynamoDB to - check, along with an AttributeValueList and a ComparisonOperator : + Expected contains the following: + AttributeValueList - One or more values to evaluate against the @@ -1023,7 +1182,7 @@ class DynamoDBConnection(AWSQueryConnection): `a` is greater than `A`, and `aa` is greater than `B`. For a list of code values, see `http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_. - For Binary, DynamoDB treats each byte of the binary data as + For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. + ComparisonOperator - A comparator for evaluating attributes in the @@ -1033,13 +1192,16 @@ class DynamoDBConnection(AWSQueryConnection): CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN` The following are descriptions of each comparison operator. - + `EQ` : Equal. AttributeValueList can contain only one AttributeValue - of type String, Number, Binary, String Set, Number Set, or Binary - Set. If an item contains an AttributeValue of a different type than - the one specified in the request, the value does not match. For - example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` - does not equal `{"NS":["6", "2", "1"]}`. > <li> - + `NE` : Not equal. AttributeValueList can contain only one + + `EQ` : Equal. `EQ` is supported for all datatypes, including lists + and maps. AttributeValueList can contain only one AttributeValue + element of type String, Number, Binary, String Set, Number Set, or + Binary Set. If an item contains an AttributeValue element of a + different type than the one specified in the request, the value + does not match. For example, `{"S":"6"}` does not equal + `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", + "1"]}`. > <li> + + `NE` : Not equal. `NE` is supported for all datatypes, including + lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value @@ -1047,74 +1209,84 @@ class DynamoDBConnection(AWSQueryConnection): `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", "1"]}`. > <li> + `LE` : Less than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `LT` : Less than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue of type String, Number, or Binary (not a set type). + If an item contains an AttributeValue element of a different type + than the one specified in the request, the value does not match. + For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GE` : Greater than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GT` : Greater than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> - + `NOT_NULL` : The attribute exists. - + `NULL` : The attribute does not exist. - + `CONTAINS` : checks for a subsequence, or value in a set. - AttributeValueList can contain only one AttributeValue of type - String, Number, or Binary (not a set). If the target attribute of - the comparison is a String, then the operation checks for a - substring match. If the target attribute of the comparison is - Binary, then the operation looks for a subsequence of the target - that matches the input. If the target attribute of the comparison - is a set ("SS", "NS", or "BS"), then the operation checks for a - member of the set (not as a substring). - + `NOT_CONTAINS` : checks for absence of a subsequence, or absence of a + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + + `NOT_NULL` : The attribute exists. `NOT_NULL` is supported for all + datatypes, including lists and maps. + + `NULL` : The attribute does not exist. `NULL` is supported for all + datatypes, including lists and maps. + + `CONTAINS` : Checks for a subsequence, or value in a set. + AttributeValueList can contain only one AttributeValue element of + type String, Number, or Binary (not a set type). If the target + attribute of the comparison is of type String, then the operator + checks for a substring match. If the target attribute of the + comparison is of type Binary, then the operator looks for a + subsequence of the target that matches the input. If the target + attribute of the comparison is a set (" `SS`", " `NS`", or " + `BS`"), then the operator evaluates to true if it finds an exact + match with any member of the set. CONTAINS is supported for lists: + When evaluating " `a CONTAINS b`", " `a`" can be a list; however, " + `b`" cannot be a set, a map, or a list. + + `NOT_CONTAINS` : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If - the target attribute of the comparison is a String, then the - operation checks for the absence of a substring match. If the - target attribute of the comparison is Binary, then the operation + AttributeValue element of type String, Number, or Binary (not a set + type). If the target attribute of the comparison is a String, then + the operator checks for the absence of a substring match. If the + target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches - the input. If the target attribute of the comparison is a set - ("SS", "NS", or "BS"), then the operation checks for the absence of - a member of the set (not as a substring). - + `BEGINS_WITH` : checks for a prefix. AttributeValueList can contain + the input. If the target attribute of the comparison is a set (" + `SS`", " `NS`", or " `BS`"), then the operator evaluates to true if + it does not find an exact match with any member of the set. + NOT_CONTAINS is supported for lists: When evaluating " `a NOT + CONTAINS b`", " `a`" can be a list; however, " `b`" cannot be a + set, a map, or a list. + + `BEGINS_WITH` : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a - set). The target attribute of the comparison must be a String or - Binary (not a Number or a set). > <li> - + `IN` : checks for exact matches. AttributeValueList can contain more - than one AttributeValue of type String, Number, or Binary (not a - set). The target attribute of the comparison must be of the same - type and exact value to match. A String never matches a String set. + set type). The target attribute of the comparison must be of type + String or Binary (not a Number or a set type). > <li> + + `IN` : Checks for matching elements within two sets. + AttributeValueList can contain one or more AttributeValue elements + of type String, Number, or Binary (not a set type). These + attributes are compared against an existing set type attribute of + an item. If any elements of the input set are present in the item + attribute, the expression evaluates to true. + `BETWEEN` : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or - Binary (not a set). A target attribute matches if the target value - is greater than, or equal to, the first element and less than, or - equal to, the second element. If an item contains an AttributeValue - of a different type than the one specified in the request, the - value does not match. For example, `{"S":"6"}` does not compare to - `{"N":"6"}`. Also, `{"N":"6"}` does not compare to `{"NS":["6", - "2", "1"]}` + Binary (not a set type). A target attribute matches if the target + value is greater than, or equal to, the first element and less + than, or equal to, the second element. If an item contains an + AttributeValue element of a different type than the one specified + in the request, the value does not match. For example, `{"S":"6"}` + does not compare to `{"N":"6"}`. Also, `{"N":"6"}` does not compare + to `{"NS":["6", "2", "1"]}` For usage examples of AttributeValueList and ComparisonOperator , see - `Conditional Expressions`_ in the Amazon DynamoDB Developer Guide. - + `Legacy Conditional Parameters`_ in the Amazon DynamoDB Developer + Guide . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and @@ -1122,8 +1294,8 @@ class DynamoDBConnection(AWSQueryConnection): + Value - A value for DynamoDB to compare with an attribute. - + Exists - Causes DynamoDB to evaluate the value before attempting the - conditional operation: + + Exists - A Boolean value that causes DynamoDB to evaluate the value + before attempting the conditional operation: + If Exists is `True`, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the @@ -1137,15 +1309,10 @@ class DynamoDBConnection(AWSQueryConnection): - Even though DynamoDB continues to accept the Value and Exists - parameters, they are now deprecated. We recommend that you use - AttributeValueList and ComparisonOperator instead, since they allow - you to construct a much wider range of conditions. - The Value and Exists parameters are incompatible with - AttributeValueList and ComparisonOperator . If you attempt to use - both sets of parameters at once, DynamoDB will throw a - ValidationException . + AttributeValueList and ComparisonOperator . Note that if you use + both sets of parameters at once, DynamoDB will return a + ValidationException exception. :type return_values: string :param return_values: @@ -1155,26 +1322,36 @@ class DynamoDBConnection(AWSQueryConnection): + `NONE` - If ReturnValues is not specified, or if its value is `NONE`, - then nothing is returned. (This is the default for ReturnValues .) + then nothing is returned. (This setting is the default for + ReturnValues .) + `ALL_OLD` - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. :type return_item_collection_metrics: string - :param return_item_collection_metrics: If set to `SIZE`, 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. + :param return_item_collection_metrics: A value that 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. :type conditional_operator: string - :param conditional_operator: A logical operator to apply to the - conditions in the Expected map: + :param conditional_operator: + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use ConditionalOperator and ConditionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter does not support lists or maps. + + A logical operator to apply to the conditions in the Expected map: + + `AND` - If all of the conditions evaluate to true, then the entire map evaluates to true. @@ -1186,6 +1363,78 @@ class DynamoDBConnection(AWSQueryConnection): The operation will succeed only if the entire map evaluates to true. + :type condition_expression: string + :param condition_expression: + A condition that must be satisfied in order for a conditional PutItem + operation to succeed. + + An expression can contain any of the following: + + + + Boolean functions: `ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH` + + Comparison operators: ` = | <> | < | > | <= + | >= | BETWEEN | IN` + + Logical operators: `NOT | AND | OR` + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` + + :type expression_attribute_values: map + :param expression_attribute_values: + One or more values that can be substituted in an expression. + + Use the **:** character in an expression to dereference an attribute + value. For example, consider the following expression: + + + + `ProductStatus IN ("Available","Backordered","Discontinued")` + + + Now suppose that you specified the following for + ExpressionAttributeValues : + + + + `{ "a":{"S":"Available"}, "b":{"S":"Backordered"}, + "d":{"S":"Discontinued"} }` + + + The expression can now be simplified as follows: + + + + `ProductStatus IN (:a,:b,:c)` + """ params = {'TableName': table_name, 'Item': item, } if expected is not None: @@ -1198,6 +1447,12 @@ class DynamoDBConnection(AWSQueryConnection): params['ReturnItemCollectionMetrics'] = return_item_collection_metrics if conditional_operator is not None: params['ConditionalOperator'] = conditional_operator + if condition_expression is not None: + params['ConditionExpression'] = condition_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names + if expression_attribute_values is not None: + params['ExpressionAttributeValues'] = expression_attribute_values return self.make_request(action='PutItem', body=json.dumps(params)) @@ -1205,7 +1460,9 @@ class DynamoDBConnection(AWSQueryConnection): attributes_to_get=None, limit=None, consistent_read=None, query_filter=None, conditional_operator=None, scan_index_forward=None, exclusive_start_key=None, - return_consumed_capacity=None): + return_consumed_capacity=None, projection_expression=None, + filter_expression=None, expression_attribute_names=None, + expression_attribute_values=None): """ A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. @@ -1215,16 +1472,17 @@ class DynamoDBConnection(AWSQueryConnection): ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key. - Queries that do not return results consume the minimum read - capacity units according to the type of read. + Queries that do not return results consume the minimum number + of read capacity units for that type of read operation. If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and - results are returned to the user with a LastEvaluatedKey to + results are returned to the user with LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan - operation, a Query operation never returns an empty result set - and a LastEvaluatedKey . The LastEvaluatedKey is only provided - if the results exceed 1 MB, or if you have used Limit . + operation, a Query operation never returns both an empty + result set and a LastEvaluatedKey . The LastEvaluatedKey is + only provided if the results exceed 1 MB, or if you have used + Limit . You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local @@ -1238,8 +1496,8 @@ class DynamoDBConnection(AWSQueryConnection): items. :type index_name: string - :param index_name: The name of an index to query. This can be any local - secondary index or global secondary index on the table. + :param index_name: The name of an index to query. This index can be any + local secondary index or global secondary index on the table. :type select: string :param select: The attributes to be returned in the result. You can @@ -1247,29 +1505,28 @@ class DynamoDBConnection(AWSQueryConnection): of matching items, or in the case of an index, some or all of the attributes projected into the index. - + `ALL_ATTRIBUTES`: Returns all of the item attributes from the - specified table or index. If you are querying a local secondary - index, then for each matching item in the index DynamoDB will fetch - the entire item from the parent table. If the index is configured - to project all item attributes, then all of the data can be - obtained from the local secondary index, and no fetching is - required.. - + `ALL_PROJECTED_ATTRIBUTES`: Allowed only when querying an index. - Retrieves all attributes which have been projected into the index. - If the index is configured to project all attributes, this is - equivalent to specifying `ALL_ATTRIBUTES`. - + `COUNT`: Returns the number of matching items, rather than the + + `ALL_ATTRIBUTES` - Returns all of the item attributes from the + specified table or index. If you query a local secondary index, + then for each matching item in the index DynamoDB will fetch the + entire item from the parent table. If the index is configured to + project all item attributes, then all of the data can be obtained + from the local secondary index, and no fetching is required. + + `ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. + Retrieves all attributes that have been projected into the index. + If the index is configured to project all attributes, this return + value is equivalent to specifying `ALL_ATTRIBUTES`. + + `COUNT` - Returns the number of matching items, rather than the matching items themselves. - + `SPECIFIC_ATTRIBUTES` : Returns only the attributes listed in - AttributesToGet . This is equivalent to specifying AttributesToGet - without specifying any value for Select . If you are querying a - local secondary index and request only attributes that are + + `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in + AttributesToGet . This return value is equivalent to specifying + AttributesToGet without specifying any value for Select . If you + query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching - incurs additional throughput cost and latency. If you are querying - a global secondary index, you can only request attributes that are + incurs additional throughput cost and latency. If you query a + global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. @@ -1283,10 +1540,20 @@ class DynamoDBConnection(AWSQueryConnection): Select .) :type attributes_to_get: list - :param attributes_to_get: The names of one or more attributes to - retrieve. If no attribute names are specified, then all attributes - will be returned. If any of the requested attributes are not found, - they will not appear in the result. + :param attributes_to_get: + There is a newer parameter available. Use ProjectionExpression instead. + Note that if you use AttributesToGet and ProjectionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter allows you to retrieve lists or maps; however, it cannot + retrieve individual list or map elements. + + The names of one or more attributes to retrieve. If no attribute names + are specified, then all attributes will be returned. If any of the + requested attributes are not found, they will not appear in the + result. + Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an @@ -1297,57 +1564,49 @@ class DynamoDBConnection(AWSQueryConnection): (This usage is equivalent to specifying AttributesToGet without any value for Select .) - If you are querying a local secondary index and request only attributes - that are projected into that index, the operation will read only - the index and not the table. If any of the requested attributes are - not projected into the local secondary index, DynamoDB will fetch - each of these attributes from the parent table. This extra fetching + If you query a local secondary index and request only attributes that + are projected into that index, the operation will read only the + index and not the table. If any of the requested attributes are not + projected into the local secondary index, DynamoDB will fetch each + of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. - If you are querying a global secondary index, you can only request - attributes that are projected into the index. Global secondary - index queries cannot fetch attributes from the parent table. + If you query a global secondary index, you can only request attributes + that are projected into the index. Global secondary index queries + cannot fetch attributes from the parent table. :type limit: integer :param limit: The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a - LastEvaluatedKey to apply in a subsequent operation, so that you - can pick up where you left off. Also, if the processed data set + key in LastEvaluatedKey to apply in a subsequent operation, so that + you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a - LastEvaluatedKey to apply in a subsequent operation to continue the - operation. For more information, see `Query and Scan`_ in the - Amazon DynamoDB Developer Guide. + key in LastEvaluatedKey to apply in a subsequent operation to + continue the operation. For more information, see `Query and Scan`_ + in the Amazon DynamoDB Developer Guide . :type consistent_read: boolean - :param consistent_read: If set to `True`, then the operation uses - strongly consistent reads; otherwise, eventually consistent reads - are used. + :param consistent_read: A value that if set to `True`, then the + operation uses strongly consistent reads; otherwise, eventually + consistent reads are used. Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to `True`, you will receive an error message. :type key_conditions: map - :param key_conditions: The selection criteria for the query. - For a query on a table, you can only have conditions on the table - primary key attributes. You must specify the hash key attribute - name and value as an `EQ` condition. You can optionally specify a - second condition, referring to the range key attribute. - - For a query on an index, you can only have conditions on the index key + :param key_conditions: The selection criteria for the query. For a + query on a table, you can have conditions only on the table primary + key attributes. You must specify the hash key attribute name and + value as an `EQ` condition. You can optionally specify a second + condition, referring to the range key attribute. + For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute. - If you specify more than one condition in the KeyConditions map, then - by default all of the conditions must evaluate to true. In other - words, the conditions are ANDed together. (You can use the - ConditionalOperator parameter to OR the conditions instead. If you - do this, then at least one of the conditions must evaluate to true, - rather than all of them.) - Each KeyConditions element consists of an attribute name to compare, along with the following: @@ -1363,65 +1622,73 @@ class DynamoDBConnection(AWSQueryConnection): For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. - + ComparisonOperator - A comparator for evaluating attributes. For - example, equals, greater than, less than, etc. For KeyConditions , - only the following comparison operators are supported: `EQ | LE | - LT | GE | GT | BEGINS_WITH | BETWEEN` The following are - descriptions of these comparison operators. + + ComparisonOperator - A comparator for evaluating attributes, for + example, equals, greater than, less than, and so on. For + KeyConditions , only the following comparison operators are + supported: `EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN` The + following are descriptions of these comparison operators. + `EQ` : Equal. AttributeValueList can contain only one AttributeValue - of type String, Number, or Binary (not a set). If an item contains - an AttributeValue of a different type than the one specified in the - request, the value does not match. For example, `{"S":"6"}` does - not equal `{"N":"6"}`. Also, `{"N":"6"}` does not equal - `{"NS":["6", "2", "1"]}`. + of type String, Number, or Binary (not a set type). If an item + contains an AttributeValue element of a different type than the one + specified in the request, the value does not match. For example, + `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not + equal `{"NS":["6", "2", "1"]}`. + `LE` : Less than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `LT` : Less than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue of type String, Number, or Binary (not a set type). + If an item contains an AttributeValue element of a different type + than the one specified in the request, the value does not match. + For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GE` : Greater than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GT` : Greater than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> - + `BEGINS_WITH` : checks for a prefix. AttributeValueList can contain + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + + `BEGINS_WITH` : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a - set). The target attribute of the comparison must be a String or - Binary (not a Number or a set). > <li> + set type). The target attribute of the comparison must be of type + String or Binary (not a Number or a set type). > <li> + `BETWEEN` : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or - Binary (not a set). A target attribute matches if the target value - is greater than, or equal to, the first element and less than, or - equal to, the second element. If an item contains an AttributeValue - of a different type than the one specified in the request, the - value does not match. For example, `{"S":"6"}` does not compare to - `{"N":"6"}`. Also, `{"N":"6"}` does not compare to `{"NS":["6", - "2", "1"]}` + Binary (not a set type). A target attribute matches if the target + value is greater than, or equal to, the first element and less + than, or equal to, the second element. If an item contains an + AttributeValue element of a different type than the one specified + in the request, the value does not match. For example, `{"S":"6"}` + does not compare to `{"N":"6"}`. Also, `{"N":"6"}` does not compare + to `{"NS":["6", "2", "1"]}` For usage examples of AttributeValueList and ComparisonOperator , see - `Conditional Expressions`_ in the Amazon DynamoDB Developer Guide. + `Legacy Conditional Parameters`_ in the Amazon DynamoDB Developer + Guide . :type query_filter: map :param query_filter: - Evaluates the query results and returns only the desired values. + There is a newer parameter available. Use FilterExpression instead. + Note that if you use QueryFilter and FilterExpression at the same + time, DynamoDB will return a ValidationException exception. + + This parameter does not support lists or maps. + + A condition that evaluates the query results and returns only the + desired values. If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other @@ -1436,17 +1703,17 @@ class DynamoDBConnection(AWSQueryConnection): + AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the - ComparisonOperator being used. For type Number, value comparisons - are numeric. String value comparisons for greater than, equals, or - less than are based on ASCII character code values. For example, - `a` is greater than `A`, and `aa` is greater than `B`. For a list - of code values, see + operator specified in ComparisonOperator . For type Number, value + comparisons are numeric. String value comparisons for greater than, + equals, or less than are based on ASCII character code values. For + example, `a` is greater than `A`, and `aa` is greater than `B`. For + a list of code values, see `http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_. - For Binary, DynamoDB treats each byte of the binary data as + For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. For information on specifying data types in JSON, see `JSON Data Format`_ in the Amazon DynamoDB - Developer Guide. + Developer Guide . + ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: `EQ | NE | LE | LT | GE | GT | @@ -1455,8 +1722,16 @@ class DynamoDBConnection(AWSQueryConnection): `API_Condition.html`_. :type conditional_operator: string - :param conditional_operator: A logical operator to apply to the - conditions in the QueryFilter map: + :param conditional_operator: + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use ConditionalOperator and ConditionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter does not support lists or maps. + + A logical operator to apply to the conditions in the QueryFilter map: + + `AND` - If all of the conditions evaluate to true, then the entire map evaluates to true. @@ -1469,13 +1744,13 @@ class DynamoDBConnection(AWSQueryConnection): The operation will succeed only if the entire map evaluates to true. :type scan_index_forward: boolean - :param scan_index_forward: Specifies ascending (true) or descending - (false) traversal of the index. DynamoDB returns results reflecting - the requested order determined by the range key. If the data type - is Number, the results are returned in numeric order. For String, - the results are returned in order of ASCII character code values. - For Binary, DynamoDB treats each byte of the binary data as - unsigned when it compares binary values. + :param scan_index_forward: A value that specifies ascending (true) or + descending (false) traversal of the index. DynamoDB returns results + reflecting the requested order determined by the range key. If the + data type is Number, the results are returned in numeric order. For + type String, the results are returned in order of ASCII character + code values. For type Binary, DynamoDB treats each byte of the + binary data as unsigned when it compares binary values. If ScanIndexForward is not specified, the results are returned in ascending order. @@ -1487,11 +1762,85 @@ class DynamoDBConnection(AWSQueryConnection): No set data types are allowed. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. + + :type projection_expression: string + :param projection_expression: One or more attributes to retrieve from + the table. These attributes can include scalars, sets, or elements + of a JSON document. The attributes in the expression must be + separated by commas. + If no attribute names are specified, then all attributes will be + returned. If any of the requested attributes are not found, they + will not appear in the result. + + :type filter_expression: string + :param filter_expression: A condition that evaluates the query results + and returns only the desired values. + The condition you specify is applied to the items queried; any items + that do not match the expression are not returned. + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` + + :type expression_attribute_values: map + :param expression_attribute_values: + One or more values that can be substituted in an expression. + + Use the **:** character in an expression to dereference an attribute + value. For example, consider the following expression: + + + + `ProductStatus IN ("Available","Backordered","Discontinued")` + + + Now suppose that you specified the following for + ExpressionAttributeValues : + + + + `{ "a":{"S":"Available"}, "b":{"S":"Backordered"}, + "d":{"S":"Discontinued"} }` + + + The expression can now be simplified as follows: + + + + `ProductStatus IN (:a,:b,:c)` """ params = { @@ -1518,42 +1867,63 @@ class DynamoDBConnection(AWSQueryConnection): params['ExclusiveStartKey'] = exclusive_start_key if return_consumed_capacity is not None: params['ReturnConsumedCapacity'] = return_consumed_capacity + if projection_expression is not None: + params['ProjectionExpression'] = projection_expression + if filter_expression is not None: + params['FilterExpression'] = filter_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names + if expression_attribute_values is not None: + params['ExpressionAttributeValues'] = expression_attribute_values return self.make_request(action='Query', body=json.dumps(params)) def scan(self, table_name, attributes_to_get=None, limit=None, select=None, scan_filter=None, conditional_operator=None, exclusive_start_key=None, return_consumed_capacity=None, - total_segments=None, segment=None): + total_segments=None, segment=None, projection_expression=None, + filter_expression=None, expression_attribute_names=None, + expression_attribute_values=None): """ The Scan operation returns one or more items and item attributes by accessing every item in the table. To have - DynamoDB return fewer items, you can provide a ScanFilter . + DynamoDB return fewer items, you can provide a ScanFilter + operation. If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are - returned to the user with a LastEvaluatedKey to continue the - scan in a subsequent operation. The results also include the - number of items exceeding the limit. A scan can result in no - table data meeting the filter criteria. + returned to the user as a LastEvaluatedKey value to continue + the scan in a subsequent operation. The results also include + the number of items exceeding the limit. A scan can result in + no table data meeting the filter criteria. The result set is eventually consistent. By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a - parallel Scan by specifying the Segment and TotalSegments - parameters. For more information, see `Parallel Scan`_ in the - Amazon DynamoDB Developer Guide. + parallel Scan operation by specifying the Segment and + TotalSegments parameters. For more information, see `Parallel + Scan`_ in the Amazon DynamoDB Developer Guide . :type table_name: string :param table_name: The name of the table containing the requested items. :type attributes_to_get: list - :param attributes_to_get: The names of one or more attributes to - retrieve. If no attribute names are specified, then all attributes - will be returned. If any of the requested attributes are not found, - they will not appear in the result. + :param attributes_to_get: + There is a newer parameter available. Use ProjectionExpression instead. + Note that if you use AttributesToGet and ProjectionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter allows you to retrieve lists or maps; however, it cannot + retrieve individual list or map elements. + + The names of one or more attributes to retrieve. If no attribute names + are specified, then all attributes will be returned. If any of the + requested attributes are not found, they will not appear in the + result. + Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an @@ -1564,36 +1934,43 @@ class DynamoDBConnection(AWSQueryConnection): the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a - LastEvaluatedKey to apply in a subsequent operation, so that you - can pick up where you left off. Also, if the processed data set + key in LastEvaluatedKey to apply in a subsequent operation, so that + you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a - LastEvaluatedKey to apply in a subsequent operation to continue the - operation. For more information, see `Query and Scan`_ in the - Amazon DynamoDB Developer Guide. + key in LastEvaluatedKey to apply in a subsequent operation to + continue the operation. For more information, see `Query and Scan`_ + in the Amazon DynamoDB Developer Guide . :type select: string :param select: The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items. - + `ALL_ATTRIBUTES`: Returns all of the item attributes. - + `COUNT`: Returns the number of matching items, rather than the + + `ALL_ATTRIBUTES` - Returns all of the item attributes. + + `COUNT` - Returns the number of matching items, rather than the matching items themselves. - + `SPECIFIC_ATTRIBUTES` : Returns only the attributes listed in - AttributesToGet . This is equivalent to specifying AttributesToGet - without specifying any value for Select . + + `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in + AttributesToGet . This return value is equivalent to specifying + AttributesToGet without specifying any value for Select . If neither Select nor AttributesToGet are specified, DynamoDB defaults - to `ALL_ATTRIBUTES`. You cannot use both Select and AttributesToGet + to `ALL_ATTRIBUTES`. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select is `SPECIFIC_ATTRIBUTES`. (This usage is equivalent to specifying AttributesToGet without any value for Select .) :type scan_filter: map :param scan_filter: - Evaluates the scan results and returns only the desired values. + There is a newer parameter available. Use FilterExpression instead. + Note that if you use ScanFilter and FilterExpression at the same + time, DynamoDB will return a ValidationException exception. + + This parameter does not support lists or maps. + + A condition that evaluates the scan results and returns only the + desired values. If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other @@ -1608,17 +1985,17 @@ class DynamoDBConnection(AWSQueryConnection): + AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the - ComparisonOperator being used. For type Number, value comparisons - are numeric. String value comparisons for greater than, equals, or - less than are based on ASCII character code values. For example, - `a` is greater than `A`, and `aa` is greater than `B`. For a list - of code values, see + operator specified in ComparisonOperator . For type Number, value + comparisons are numeric. String value comparisons for greater than, + equals, or less than are based on ASCII character code values. For + example, `a` is greater than `A`, and `aa` is greater than `B`. For + a list of code values, see `http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. For information on specifying data types in JSON, see `JSON Data Format`_ in the Amazon DynamoDB - Developer Guide. + Developer Guide . + ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: `EQ | NE | LE | LT | GE | GT | @@ -1627,8 +2004,16 @@ class DynamoDBConnection(AWSQueryConnection): `Condition`_. :type conditional_operator: string - :param conditional_operator: A logical operator to apply to the - conditions in the ScanFilter map: + :param conditional_operator: + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use ConditionalOperator and ConditionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter does not support lists or maps. + + A logical operator to apply to the conditions in the ScanFilter map: + + `AND` - If all of the conditions evaluate to true, then the entire map evaluates to true. @@ -1652,11 +2037,11 @@ class DynamoDBConnection(AWSQueryConnection): corresponding value of LastEvaluatedKey . :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. :type total_segments: integer :param total_segments: For a parallel Scan request, TotalSegments @@ -1664,10 +2049,10 @@ class DynamoDBConnection(AWSQueryConnection): operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to scan a table using four - application threads, you would specify a TotalSegments value of 4. + application threads, specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and - less than or equal to 4096. If you specify a TotalSegments value of - 1, the Scan will be sequential rather than parallel. + less than or equal to 1000000. If you specify a TotalSegments value + of 1, the Scan operation will be sequential rather than parallel. If you specify TotalSegments , you must also specify Segment . @@ -1676,11 +2061,11 @@ class DynamoDBConnection(AWSQueryConnection): individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application - threads, the first thread would specify a Segment value of 0, the - second thread would specify 1, and so on. + threads, the first thread specifies a Segment value of 0, the + second thread specifies 1, and so on. The value of LastEvaluatedKey returned from a parallel Scan request - must be used as ExclusiveStartKey with the same Segment ID in a + must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for Segment must be greater than or equal to 0, and less than @@ -1688,6 +2073,80 @@ class DynamoDBConnection(AWSQueryConnection): If you specify Segment , you must also specify TotalSegments . + :type projection_expression: string + :param projection_expression: One or more attributes to retrieve from + the table. These attributes can include scalars, sets, or elements + of a JSON document. The attributes in the expression must be + separated by commas. + If no attribute names are specified, then all attributes will be + returned. If any of the requested attributes are not found, they + will not appear in the result. + + :type filter_expression: string + :param filter_expression: A condition that evaluates the scan results + and returns only the desired values. + The condition you specify is applied to the items scanned; any items + that do not match the expression are not returned. + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` + + :type expression_attribute_values: map + :param expression_attribute_values: + One or more values that can be substituted in an expression. + + Use the **:** character in an expression to dereference an attribute + value. For example, consider the following expression: + + + + `ProductStatus IN ("Available","Backordered","Discontinued")` + + + Now suppose that you specified the following for + ExpressionAttributeValues : + + + + `{ "a":{"S":"Available"}, "b":{"S":"Backordered"}, + "d":{"S":"Discontinued"} }` + + + The expression can now be simplified as follows: + + + + `ProductStatus IN (:a,:b,:c)` + """ params = {'TableName': table_name, } if attributes_to_get is not None: @@ -1708,24 +2167,34 @@ class DynamoDBConnection(AWSQueryConnection): params['TotalSegments'] = total_segments if segment is not None: params['Segment'] = segment + if projection_expression is not None: + params['ProjectionExpression'] = projection_expression + if filter_expression is not None: + params['FilterExpression'] = filter_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names + if expression_attribute_values is not None: + params['ExpressionAttributeValues'] = expression_attribute_values return self.make_request(action='Scan', body=json.dumps(params)) def update_item(self, table_name, key, attribute_updates=None, expected=None, conditional_operator=None, return_values=None, return_consumed_capacity=None, - return_item_collection_metrics=None): + return_item_collection_metrics=None, + update_expression=None, condition_expression=None, + expression_attribute_names=None, + expression_attribute_values=None): """ - Edits an existing item's attributes, or inserts a new item if - it does not already exist. You can put, delete, or add - attribute values. You can also perform a conditional update - (insert a new attribute name-value pair if it doesn't exist, - or replace an existing name-value pair if it has certain - expected attribute values). - - In addition to updating an item, you can also return the - item's attribute values in the same operation, using the - ReturnValues parameter. + Edits an existing item's attributes, or adds a new item to the + table if it does not already exist. You can put, delete, or + add attribute values. You can also perform a conditional + update (insert a new attribute name-value pair if it doesn't + exist, or replace an existing name-value pair if it has + certain expected attribute values). + + You can also return the item's attribute values in the same + UpdateItem operation using the ReturnValues parameter. :type table_name: string :param table_name: The name of the table containing the item to update. @@ -1739,78 +2208,73 @@ class DynamoDBConnection(AWSQueryConnection): specify both the hash attribute and the range attribute. :type attribute_updates: map - :param attribute_updates: The names of attributes to be modified, the - action to perform on each, and the new value for each. If you are - updating an attribute that is an index key attribute for any - indexes on that table, the attribute type must match the index key - type defined in the AttributesDefinition of the table description. - You can use UpdateItem to update any non-key attributes. - Attribute values cannot be null. String and binary type attributes must + :param attribute_updates: + There is a newer parameter available. Use UpdateExpression instead. + Note that if you use AttributeUpdates and UpdateExpression at the + same time, DynamoDB will return a ValidationException exception. + + This parameter can be used for modifying top-level attributes; however, + it does not support individual list or map elements. + + The names of attributes to be modified, the action to perform on each, + and the new value for each. If you are updating an attribute that + is an index key attribute for any indexes on that table, the + attribute type must match the index key type defined in the + AttributesDefinition of the table description. You can use + UpdateItem to update any nonkey attributes. + + Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a - ValidationException . + ValidationException exception. Each AttributeUpdates element consists of an attribute name to modify, along with the following: + Value - The new value, if applicable, for this attribute. - + Action - Specifies how to perform the update. Valid values for Action - are `PUT`, `DELETE`, and `ADD`. The behavior depends on whether the - specified primary key already exists in the table. **If an item - with the specified Key is found in the table:** + + Action - A value that specifies how to perform the update. This + action is only valid for an existing attribute whose data type is + Number or is a set; do not use `ADD` for other data types. If an + item with the specified primary key is found in the table, the + following values perform the following actions: + `PUT` - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. - + `DELETE` - If no value is specified, the attribute and its value are - removed from the item. The data type of the specified value must + + `DELETE` - Removes the attribute and its value, if no value is + specified for `DELETE`. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set `[a,b,c]` and the - DELETE action specified `[a,c]`, then the final attribute value - would be `[b]`. Specifying an empty set is an error. - + `ADD` - If the attribute does not already exist, then the attribute - and its values are added to the item. If the attribute does exist, - then the behavior of `ADD` depends on the data type of the - attribute: + `DELETE` action specifies `[a,c]`, then the final attribute value + is `[b]`. Specifying an empty set is an error. + + `ADD` - Adds the specified value to the item, if the attribute does + not already exist. If the attribute does exist, then the behavior + of `ADD` depends on the data type of the attribute: + If the existing attribute is a number, and if Value is also a number, - then the Value is mathematically added to the existing attribute. - If Value is a negative number, then it is subtracted from the - existing attribute. If you use `ADD` to increment or decrement a - number value for an item that doesn't exist before the update, - DynamoDB uses 0 as the initial value. In addition, if you use `ADD` - to update an existing item, and intend to increment or decrement an - attribute value which does not yet exist, DynamoDB uses `0` as the - initial value. For example, suppose that the item you want to - update does not yet have an attribute named itemcount , but you - decide to `ADD` the number `3` to this attribute anyway, even - though it currently does not exist. DynamoDB will create the - itemcount attribute, set its initial value to `0`, and finally add - `3` to it. The result will be a new itemcount attribute in the - item, with a value of `3`. - + If the existing data type is a set, and if the Value is also a set, - then the Value is added to the existing set. (This is a set - operation, not mathematical addition.) For example, if the - attribute value was the set `[1,2]`, and the `ADD` action specified - `[3]`, then the final attribute value would be `[1,2,3]`. An error - occurs if an Add action is specified for a set attribute and the + then Value is mathematically added to the existing attribute. If + Value is a negative number, then it is subtracted from the existing + attribute. + + If the existing data type is a set, and if Value is also a set, then + Value is appended to the existing set. For example, if the + attribute value is the set `[1,2]`, and the `ADD` action specified + `[3]`, then the final attribute value is `[1,2,3]`. An error occurs + if an `ADD` action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the - existing data type is a set of strings, the Value must also be a - set of strings. The same holds true for number sets and binary - sets. - This action is only valid for an existing attribute whose data type is - number or is a set. Do not use `ADD` for any other data types. - **If no item with the specified Key is found:** + existing data type is a set of strings, Value must also be a set of + strings. - + `PUT` - DynamoDB creates a new item with the specified primary key, - and then adds the attribute. - + `DELETE` - Nothing happens; there is no attribute to delete. - + `ADD` - DynamoDB creates an item with the supplied primary key and - number (or set of numbers) for the attribute value. The only data - types allowed are number and number set; no other data types can be - specified. + If no item with the specified key is found in the table, the following + values perform the following actions: + + + `PUT` - Causes DynamoDB to create a new item with the specified + primary key, and then adds the attribute. + + `DELETE` - Causes nothing to happen; there is no attribute to delete. + + `ADD` - Causes DynamoDB to creat an item with the supplied primary + key and number (or set of numbers) for the attribute value. The + only data types allowed are Number and Number Set. @@ -1820,8 +2284,14 @@ class DynamoDBConnection(AWSQueryConnection): :type expected: map :param expected: - A map of attribute/condition pairs. This is the conditional block for - the UpdateItem operation. + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use Expected and ConditionExpression at the same + time, DynamoDB will return a ValidationException exception. + + This parameter does not support lists or maps. + + A map of attribute/condition pairs. Expected provides a conditional + block for the UpdateItem operation. Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute @@ -1839,8 +2309,7 @@ class DynamoDBConnection(AWSQueryConnection): If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails. - Each item in Expected represents an attribute name for DynamoDB to - check, along with an AttributeValueList and a ComparisonOperator : + Expected contains the following: + AttributeValueList - One or more values to evaluate against the @@ -1851,7 +2320,7 @@ class DynamoDBConnection(AWSQueryConnection): `a` is greater than `A`, and `aa` is greater than `B`. For a list of code values, see `http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters`_. - For Binary, DynamoDB treats each byte of the binary data as + For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions. + ComparisonOperator - A comparator for evaluating attributes in the @@ -1861,13 +2330,16 @@ class DynamoDBConnection(AWSQueryConnection): CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN` The following are descriptions of each comparison operator. - + `EQ` : Equal. AttributeValueList can contain only one AttributeValue - of type String, Number, Binary, String Set, Number Set, or Binary - Set. If an item contains an AttributeValue of a different type than - the one specified in the request, the value does not match. For - example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` - does not equal `{"NS":["6", "2", "1"]}`. > <li> - + `NE` : Not equal. AttributeValueList can contain only one + + `EQ` : Equal. `EQ` is supported for all datatypes, including lists + and maps. AttributeValueList can contain only one AttributeValue + element of type String, Number, Binary, String Set, Number Set, or + Binary Set. If an item contains an AttributeValue element of a + different type than the one specified in the request, the value + does not match. For example, `{"S":"6"}` does not equal + `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", + "1"]}`. > <li> + + `NE` : Not equal. `NE` is supported for all datatypes, including + lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value @@ -1875,74 +2347,84 @@ class DynamoDBConnection(AWSQueryConnection): `{"N":"6"}`. Also, `{"N":"6"}` does not equal `{"NS":["6", "2", "1"]}`. > <li> + `LE` : Less than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `LT` : Less than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue of type String, Number, or Binary (not a set type). + If an item contains an AttributeValue element of a different type + than the one specified in the request, the value does not match. + For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GE` : Greater than or equal. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + `GT` : Greater than. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If an - item contains an AttributeValue of a different type than the one - specified in the request, the value does not match. For example, - `{"S":"6"}` does not equal `{"N":"6"}`. Also, `{"N":"6"}` does not - compare to `{"NS":["6", "2", "1"]}`. > <li> - + `NOT_NULL` : The attribute exists. - + `NULL` : The attribute does not exist. - + `CONTAINS` : checks for a subsequence, or value in a set. - AttributeValueList can contain only one AttributeValue of type - String, Number, or Binary (not a set). If the target attribute of - the comparison is a String, then the operation checks for a - substring match. If the target attribute of the comparison is - Binary, then the operation looks for a subsequence of the target - that matches the input. If the target attribute of the comparison - is a set ("SS", "NS", or "BS"), then the operation checks for a - member of the set (not as a substring). - + `NOT_CONTAINS` : checks for absence of a subsequence, or absence of a + AttributeValue element of type String, Number, or Binary (not a set + type). If an item contains an AttributeValue element of a different + type than the one specified in the request, the value does not + match. For example, `{"S":"6"}` does not equal `{"N":"6"}`. Also, + `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}`. > <li> + + `NOT_NULL` : The attribute exists. `NOT_NULL` is supported for all + datatypes, including lists and maps. + + `NULL` : The attribute does not exist. `NULL` is supported for all + datatypes, including lists and maps. + + `CONTAINS` : Checks for a subsequence, or value in a set. + AttributeValueList can contain only one AttributeValue element of + type String, Number, or Binary (not a set type). If the target + attribute of the comparison is of type String, then the operator + checks for a substring match. If the target attribute of the + comparison is of type Binary, then the operator looks for a + subsequence of the target that matches the input. If the target + attribute of the comparison is a set (" `SS`", " `NS`", or " + `BS`"), then the operator evaluates to true if it finds an exact + match with any member of the set. CONTAINS is supported for lists: + When evaluating " `a CONTAINS b`", " `a`" can be a list; however, " + `b`" cannot be a set, a map, or a list. + + `NOT_CONTAINS` : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one - AttributeValue of type String, Number, or Binary (not a set). If - the target attribute of the comparison is a String, then the - operation checks for the absence of a substring match. If the - target attribute of the comparison is Binary, then the operation + AttributeValue element of type String, Number, or Binary (not a set + type). If the target attribute of the comparison is a String, then + the operator checks for the absence of a substring match. If the + target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches - the input. If the target attribute of the comparison is a set - ("SS", "NS", or "BS"), then the operation checks for the absence of - a member of the set (not as a substring). - + `BEGINS_WITH` : checks for a prefix. AttributeValueList can contain + the input. If the target attribute of the comparison is a set (" + `SS`", " `NS`", or " `BS`"), then the operator evaluates to true if + it does not find an exact match with any member of the set. + NOT_CONTAINS is supported for lists: When evaluating " `a NOT + CONTAINS b`", " `a`" can be a list; however, " `b`" cannot be a + set, a map, or a list. + + `BEGINS_WITH` : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a - set). The target attribute of the comparison must be a String or - Binary (not a Number or a set). > <li> - + `IN` : checks for exact matches. AttributeValueList can contain more - than one AttributeValue of type String, Number, or Binary (not a - set). The target attribute of the comparison must be of the same - type and exact value to match. A String never matches a String set. + set type). The target attribute of the comparison must be of type + String or Binary (not a Number or a set type). > <li> + + `IN` : Checks for matching elements within two sets. + AttributeValueList can contain one or more AttributeValue elements + of type String, Number, or Binary (not a set type). These + attributes are compared against an existing set type attribute of + an item. If any elements of the input set are present in the item + attribute, the expression evaluates to true. + `BETWEEN` : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or - Binary (not a set). A target attribute matches if the target value - is greater than, or equal to, the first element and less than, or - equal to, the second element. If an item contains an AttributeValue - of a different type than the one specified in the request, the - value does not match. For example, `{"S":"6"}` does not compare to - `{"N":"6"}`. Also, `{"N":"6"}` does not compare to `{"NS":["6", - "2", "1"]}` + Binary (not a set type). A target attribute matches if the target + value is greater than, or equal to, the first element and less + than, or equal to, the second element. If an item contains an + AttributeValue element of a different type than the one specified + in the request, the value does not match. For example, `{"S":"6"}` + does not compare to `{"N":"6"}`. Also, `{"N":"6"}` does not compare + to `{"NS":["6", "2", "1"]}` For usage examples of AttributeValueList and ComparisonOperator , see - `Conditional Expressions`_ in the Amazon DynamoDB Developer Guide. - + `Legacy Conditional Parameters`_ in the Amazon DynamoDB Developer + Guide . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and @@ -1950,8 +2432,8 @@ class DynamoDBConnection(AWSQueryConnection): + Value - A value for DynamoDB to compare with an attribute. - + Exists - Causes DynamoDB to evaluate the value before attempting the - conditional operation: + + Exists - A Boolean value that causes DynamoDB to evaluate the value + before attempting the conditional operation: + If Exists is `True`, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the @@ -1965,19 +2447,22 @@ class DynamoDBConnection(AWSQueryConnection): - Even though DynamoDB continues to accept the Value and Exists - parameters, they are now deprecated. We recommend that you use - AttributeValueList and ComparisonOperator instead, since they allow - you to construct a much wider range of conditions. - The Value and Exists parameters are incompatible with - AttributeValueList and ComparisonOperator . If you attempt to use - both sets of parameters at once, DynamoDB will throw a - ValidationException . + AttributeValueList and ComparisonOperator . Note that if you use + both sets of parameters at once, DynamoDB will return a + ValidationException exception. :type conditional_operator: string - :param conditional_operator: A logical operator to apply to the - conditions in the Expected map: + :param conditional_operator: + There is a newer parameter available. Use ConditionExpression instead. + Note that if you use ConditionalOperator and ConditionExpression at + the same time, DynamoDB will return a ValidationException + exception. + + This parameter does not support lists or maps. + + A logical operator to apply to the conditions in the Expected map: + + `AND` - If all of the conditions evaluate to true, then the entire map evaluates to true. @@ -1997,7 +2482,8 @@ class DynamoDBConnection(AWSQueryConnection): + `NONE` - If ReturnValues is not specified, or if its value is `NONE`, - then nothing is returned. (This is the default for ReturnValues .) + then nothing is returned. (This setting is the default for + ReturnValues .) + `ALL_OLD` - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned. + `UPDATED_OLD` - The old versions of only the updated attributes are @@ -2008,17 +2494,154 @@ class DynamoDBConnection(AWSQueryConnection): returned. :type return_consumed_capacity: string - :param return_consumed_capacity: If set to `TOTAL`, the response - includes ConsumedCapacity data for tables and indexes. If set to - `INDEXES`, the response includes ConsumedCapacity for indexes. If - set to `NONE` (the default), ConsumedCapacity is not included in - the response. + :param return_consumed_capacity: A value that if set to `TOTAL`, the + response includes ConsumedCapacity data for tables and indexes. If + set to `INDEXES`, the response includes ConsumedCapacity for + indexes. If set to `NONE` (the default), ConsumedCapacity is not + included in the response. :type return_item_collection_metrics: string - :param return_item_collection_metrics: If set to `SIZE`, 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. + :param return_item_collection_metrics: A value that 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. + + :type update_expression: string + :param update_expression: + An expression that defines one or more attributes to be updated, the + action to be performed on them, and new value(s) for them. + + The following action values are available for UpdateExpression . + + + + `SET` - Adds one or more attributes and values to an item. If any of + these attribute already exist, they are replaced by the new values. + You can also use `SET` to add or subtract from an attribute that is + of type Number. `SET` supports the following functions: + + + `if_not_exists (path, operand)` - if the item does not contain an + attribute at the specified path, then `if_not_exists` evaluates to + operand; otherwise, it evaluates to path. You can use this function + to avoid overwriting an attribute that may already be present in + the item. + + `list_append (operand, operand)` - evaluates to a list with a new + element added to it. You can append the new element to the start or + the end of the list by reversing the order of the operands. + These function names are case-sensitive. + + `REMOVE` - Removes one or more attributes from an item. + + `ADD` - Adds the specified value to the item, if the attribute does + not already exist. If the attribute does exist, then the behavior + of `ADD` depends on the data type of the attribute: + + + If the existing attribute is a number, and if Value is also a number, + then Value is mathematically added to the existing attribute. If + Value is a negative number, then it is subtracted from the existing + attribute. + + If the existing data type is a set and if Value is also a set, then + Value is added to the existing set. For example, if the attribute + value is the set `[1,2]`, and the `ADD` action specified `[3]`, + then the final attribute value is `[1,2,3]`. An error occurs if an + `ADD` action is specified for a set attribute and the attribute + type specified does not match the existing set type. Both sets must + have the same primitive data type. For example, if the existing + data type is a set of strings, the Value must also be a set of + strings. + The `ADD` action only supports Number and set data types. In addition, + `ADD` can only be used on top-level attributes, not nested + attributes. + + `DELETE` - Deletes an element from a set. If a set of values is + specified, then those values are subtracted from the old set. For + example, if the attribute value was the set `[a,b,c]` and the + `DELETE` action specifies `[a,c]`, then the final attribute value + is `[b]`. Specifying an empty set is an error. The `DELETE` action + only supports Number and set data types. In addition, `DELETE` 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` + + An expression can contain any of the following: + + + + Boolean functions: `ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH` + + Comparison operators: ` = | <> | < | > | <= + | >= | BETWEEN | IN` + + Logical operators: `NOT | AND | OR` + + :type condition_expression: string + :param condition_expression: + A condition that must be satisfied in order for a conditional update to + succeed. + + An expression can contain any of the following: + + + + Boolean functions: `ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH` + + Comparison operators: ` = | <> | < | > | <= + | >= | BETWEEN | IN` + + Logical operators: `NOT | AND | OR` + + :type expression_attribute_names: map + :param expression_attribute_names: + One or more substitution tokens for simplifying complex expressions. + The following are some use cases for an ExpressionAttributeNames + value: + + + + To shorten an attribute name that is very long or unwieldy in an + expression. + + To create a placeholder for repeating occurrences of an attribute + name in an expression. + + To prevent special characters in an attribute name from being + misinterpreted in an expression. + + + Use the **#** character in an expression to dereference an attribute + name. For example, consider the following expression: + + + + `order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName + = "Jones"` + + + Now suppose that you specified the following for + ExpressionAttributeNames : + + + + `{"n":"order.customerInfo.LastName"}` + + + The expression can now be simplified as follows: + + + + `#n = "Smith" OR #n = "Jones"` + + :type expression_attribute_values: map + :param expression_attribute_values: + One or more values that can be substituted in an expression. + + Use the **:** character in an expression to dereference an attribute + value. For example, consider the following expression: + + + + `ProductStatus IN ("Available","Backordered","Discontinued")` + + + Now suppose that you specified the following for + ExpressionAttributeValues : + + + + `{ "a":{"S":"Available"}, "b":{"S":"Backordered"}, + "d":{"S":"Discontinued"} }` + + + The expression can now be simplified as follows: + + + + `ProductStatus IN (:a,:b,:c)` """ params = {'TableName': table_name, 'Key': key, } @@ -2034,6 +2657,14 @@ class DynamoDBConnection(AWSQueryConnection): params['ReturnConsumedCapacity'] = return_consumed_capacity if return_item_collection_metrics is not None: params['ReturnItemCollectionMetrics'] = return_item_collection_metrics + if update_expression is not None: + params['UpdateExpression'] = update_expression + if condition_expression is not None: + params['ConditionExpression'] = condition_expression + if expression_attribute_names is not None: + params['ExpressionAttributeNames'] = expression_attribute_names + if expression_attribute_values is not None: + params['ExpressionAttributeValues'] = expression_attribute_values return self.make_request(action='UpdateItem', body=json.dumps(params)) @@ -2047,7 +2678,7 @@ class DynamoDBConnection(AWSQueryConnection): The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the - `Limits`_ section in the Amazon DynamoDB Developer Guide. + `Limits`_ section in the Amazon DynamoDB Developer Guide . The table must be in the `ACTIVE` state for this operation to succeed. UpdateTable is an asynchronous operation; while @@ -2069,7 +2700,7 @@ class DynamoDBConnection(AWSQueryConnection): settings for a specified table or index. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see - `Limits`_ in the Amazon DynamoDB Developer Guide. + `Limits`_ in the Amazon DynamoDB Developer Guide . :type global_secondary_index_updates: list :param global_secondary_index_updates: An array of one or more global diff --git a/tests/integration/dynamodb2/test_layer1.py b/tests/integration/dynamodb2/test_layer1.py index 0a0beef9..98e8a3cb 100644 --- a/tests/integration/dynamodb2/test_layer1.py +++ b/tests/integration/dynamodb2/test_layer1.py @@ -322,3 +322,42 @@ class DynamoDBv2Layer1Test(unittest.TestCase): for i in range(100): # This would cause an exception due to a non-existant instance variable. self.dynamodb.scan(tiny_tablename) + + def test_recursive(self): + result = self.create_table( + self.table_name, + self.attributes, + self.schema, + self.provisioned_throughput, + self.lsi + ) + self.assertEqual( + result['TableDescription']['TableName'], + self.table_name + ) + + description = self.dynamodb.describe_table(self.table_name) + self.assertEqual(description['Table']['ItemCount'], 0) + + # Create some records with one being a recursive shape. + record_1_data = { + 'username': {'S': 'johndoe'}, + 'first_name': {'S': 'John'}, + 'last_name': {'S': 'Doe'}, + 'date_joined': {'N': '1366056668'}, + 'friend_count': {'N': '3'}, + 'friend_data': {'M': {'username': {'S': 'alice'}, + 'friend_count': {'N': '4'}}} + } + r1_result = self.dynamodb.put_item(self.table_name, record_1_data) + + # Get the data. + record_1 = self.dynamodb.get_item(self.table_name, key={ + 'username': {'S': 'johndoe'}, + 'date_joined': {'N': '1366056668'}, + }, consistent_read=True) + self.assertEqual(record_1['Item']['username']['S'], 'johndoe') + self.assertEqual(record_1['Item']['first_name']['S'], 'John') + recursive_data = record_1['Item']['friend_data']['M'] + self.assertEqual(recursive_data['username']['S'], 'alice') + self.assertEqual(recursive_data['friend_count']['N'], '4') |