This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the Amazon DynamoDB\n API.
\n ", "operations": { "BatchGetItem": { "name": "BatchGetItem", "input": { "shape_name": "BatchGetItemInput", "type": "structure", "members": { "RequestItems": { "shape_name": "BatchGetRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "KeysAndAttributes", "type": "structure", "members": { "Keys": { "shape_name": "KeyList", "type": "list", "members": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": null }, "min_length": 1, "max_length": 100, "documentation": "\nThe primary key attribute values that define the items and the attributes\n associated with the items.
\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "\nOne or more attributes to retrieve from the table or index. If no attribute names are \n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.
\nIf you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.
\n\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "\nThe consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.
Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.
\n " }, "min_length": 1, "max_length": 100, "documentation": "\nA map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve.\n Each table name can be invoked only once.
\nEach element in the map consists of the following:
\nKeys - An array of primary key attribute values that define specific items in the table.
\nAttributesToGet - One or more attributes to be retrieved from the table or index. By\n default, all attributes are returned. If a specified attribute is not found, it does not\n appear in the result.
\nConsistentRead - If true, a strongly consistent read is used; if\n false (the default), an eventually consistent read is used.
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Represents the input of a BatchGetItem operation.
\n " }, "output": { "shape_name": "BatchGetItemOutput", "type": "structure", "members": { "Responses": { "shape_name": "BatchGetResponseMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": null }, "documentation": null }, "documentation": "\nA map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
\n " }, "UnprocessedKeys": { "shape_name": "BatchGetRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "KeysAndAttributes", "type": "structure", "members": { "Keys": { "shape_name": "KeyList", "type": "list", "members": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": null }, "min_length": 1, "max_length": 100, "documentation": "\nThe primary key attribute values that define the items and the attributes\n associated with the items.
\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "\nOne or more attributes to retrieve from the table or index. If no attribute names are \n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.
\nIf you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.
\n\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "\nThe consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.
Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.
\n " }, "min_length": 1, "max_length": 100, "documentation": "\nA map of tables and their respective keys that were not processed with the current response.\n The UnprocessedKeys value is in the same form as RequestItems, so the value can\n be provided directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.
\nEach element consists of:
\nKeys - An array of primary key attribute values that define specific items in the table.
\nAttributesToGet - One or more attributes to be retrieved from the table or index. By\n default, all attributes are returned. If a specified attribute is not found, it does not\n appear in the result.
\nIf you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.
\n\n \n\nConsistentRead - The consistency of a read operation. If set to\n true, then a strongly consistent read is used; otherwise, an eventually\n consistent read is used.
The name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " }, "documentation": "\nThe write capacity units consumed by the operation.
\nEach element consists of:
\nTableName - The table that consumed the provisioned throughput.
\nCapacityUnits - The total number of capacity units consumed.
\nRepresents the output of a BatchGetItem operation.
\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe \n BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.
\nA single operation can retrieve up to 1 MB of data, which can comprise as many as 100 items.\n BatchGetItem will return a partial result if the response size limit is exceeded, the\n table's provisioned throughput is exceeded, or an internal processing failure occurs. If a\n partial result is returned, the operation returns a value for UnprocessedKeys. You can\n use this value to retry the operation starting with the next item to get.
\nFor example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the\n system returns 20 items (1 MB) and an appropriate UnprocessedKeys value so you can get the\n next page of results. If desired, your application can include its own logic to assemble the\n pages of results into one dataset.
\nIf no items can be processed because of insufficient provisioned throughput on each of the\n tables involved in the request, BatchGetItem throws ProvisionedThroughputExceededException.
\nBy default, BatchGetItem performs eventually consistent reads on every table in the\n request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem fetches items in parallel.
\nWhen designing your application, keep in mind that Amazon DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the\n AttributesToGet parameter.
\nIf a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the\n type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.
\n\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute name to attribute values, representing the primary key of an item to be\n processed by PutItem. All of the table's primary key attributes must be specified, and\n their data types must match those of the table's key schema. If any attributes are present in\n the item which are part of an index key schema for the table, their types must match the index\n key schema.
\n ", "required": true } }, "documentation": "\nA request to perform a PutItem operation.
\n " }, "DeleteRequest": { "shape_name": "DeleteRequest", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
\n ", "required": true } }, "documentation": "\nA request to perform a DeleteItem operation.
\n " } }, "documentation": "\nRepresents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.
\n " }, "min_length": 1, "max_length": 25, "documentation": null }, "min_length": 1, "max_length": 25, "documentation": "\nA map of one or more table names and, for each table, a list of operations to be performed\n (DeleteRequest or PutRequest). Each element in the map consists of the following:
\nDeleteRequest - Perform a DeleteItem operation on the specified item.\n The item to be deleted is identified by a Key subelement:
\nKey - A map of primary key attribute values that uniquely identify the\n item. Each entry in this map consists of an attribute name and an attribute value.
\nPutRequest - Perform a PutItem operation on the specified item. The\n item to be put is identified by an Item subelement:
\nItem - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with a\n ValidationException.
\nIf 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.
\nIf set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Represents the input of a BatchWriteItem operation.
\n " }, "output": { "shape_name": "BatchWriteItemOutput", "type": "structure", "members": { "UnprocessedItems": { "shape_name": "BatchWriteItemRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "WriteRequests", "type": "list", "members": { "shape_name": "WriteRequest", "type": "structure", "members": { "PutRequest": { "shape_name": "PutRequest", "type": "structure", "members": { "Item": { "shape_name": "PutItemInputAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute name to attribute values, representing the primary key of an item to be\n processed by PutItem. All of the table's primary key attributes must be specified, and\n their data types must match those of the table's key schema. If any attributes are present in\n the item which are part of an index key schema for the table, their types must match the index\n key schema.
\n ", "required": true } }, "documentation": "\nA request to perform a PutItem operation.
\n " }, "DeleteRequest": { "shape_name": "DeleteRequest", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
\n ", "required": true } }, "documentation": "\nA request to perform a DeleteItem operation.
\n " } }, "documentation": "\nRepresents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.
\n " }, "min_length": 1, "max_length": 25, "documentation": null }, "min_length": 1, "max_length": 25, "documentation": "\nA map of tables and requests against those tables that were not processed. The\n UnprocessedKeys value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.
\nEach UnprocessedItems entry consists of a table name and, for that table, a list of\n operations to perform (DeleteRequest or PutRequest).
\nDeleteRequest - Perform a DeleteItem operation on the specified item.\n The item to be deleted is identified by a Key subelement:
\nKey - A map of primary key attribute values that uniquely identify the\n item. Each entry in this map consists of an attribute name and an attribute value.
\nPutRequest - Perform a PutItem operation on the specified item. The\n item to be put is identified by an Item subelement:
\nItem - A map of attributes and their values. Each entry in this map consists\n of an attribute name and an attribute value. Attribute values must not be null; string\n and binary type attributes must have lengths greater than zero; and set type\n attributes must not be empty. Requests that contain empty values will be rejected with a\n ValidationException.
\nIf 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.
\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe hash key value of the item collection. This is the same as the hash key of the item.
\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\nAn estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\n " } }, "documentation": "\nInformation about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
\n " }, "documentation": null }, "documentation": "\nA list of tables that were processed by BatchWriteItem and, for each table,\n information about any item collections that were affected by individual DeleteItem or\n PutItem operations.
\nEach entry consists of the following subelements:
\nItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
\nSizeEstimateRange - An estimate of item collection size, expressed in\n GB. This is a two-element array containing a lower bound and an upper bound for\n the estimate. The estimate includes the size of all the items in the table, plus the size\n of all attributes projected into all of the local secondary indexes on the table. Use this\n estimate to measure whether a local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nThe name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " }, "documentation": "\nThe capacity units consumed by the operation.
\nEach element consists of:
\nTableName - The table that consumed the provisioned throughput.
\nCapacityUnits - The total number of capacity units consumed.
\nRepresents the output of a BatchWriteItem operation.
\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
\n " } }, "documentation": "\nAn item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.
\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe BatchWriteItem operation puts or deletes multiple items in one or more tables. A\n single call to BatchWriteItem can write up to 1 MB of data, which can comprise as many\n as 25 put or delete requests. Individual items to be written can be as large as 64 KB.
\nBatchWriteItem cannot update items. To update items, use the UpdateItem\n API.
\nThe individual PutItem and DeleteItem operations specified in\n BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any\n requested operations fail because the table's provisioned throughput is exceeded or an\n internal processing failure occurs, the failed operations are returned in the\n UnprocessedItems response parameter. You can investigate and optionally resend the\n requests. Typically, you would call BatchWriteItem in a loop. Each iteration would\n check for unprocessed items and submit a new BatchWriteItem request with those\n unprocessed items until all items have been processed.
\nTo write one item, you can use the PutItem operation; to delete one item, you can use the DeleteItem operation.
\nWith BatchWriteItem, you can efficiently write or delete large amounts of data, such\n as from Amazon Elastic MapReduce (EMR), or copy data from another database into Amazon DynamoDB. In\n order to improve performance with these large-scale operations, BatchWriteItem does not\n behave in the same way as individual PutItem and DeleteItem calls would For\n example, you cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.
\nIf you use a programming language that supports concurrency, such as Java, you can use\n threads to write items in parallel. Your application must include the necessary logic to manage the threads.
\nWith languages that don't support threading, such as PHP, BatchWriteItem will write or\n delete the specified items one at a time. In both situations, BatchWriteItem provides\n an alternative where the API performs the specified put and delete operations in parallel,\n giving you the power of the thread pool approach without having to introduce complexity into\n your application.
\nParallel processing reduces latency, but each specified put and delete request consumes the\n same number of write capacity units whether it is processed in parallel or not. Delete\n operations on nonexistent items consume one write capacity unit.
\nIf one or more of the following is true, Amazon DynamoDB rejects the entire batch write operation:
\nOne or more tables specified in the BatchWriteItem request does not\n exist.
\nPrimary key attributes specified on an item in the request do not match those in the\n corresponding table's primary key schema.
\nYou try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete the same item in\n the same BatchWriteItem request.
\nThe total request size exceeds 1 MB.
\nAny individual item in a batch exceeds 64 KB.
\nA name for the attribute.
\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\nThe data type for the attribute.
\n ", "required": true } }, "documentation": "\nRepresents an attribute for describing the key schema for the table and indexes.
\n " }, "documentation": "\nAn array of attributes that describe the key schema for the table and indexes.
\n ", "required": true }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the table to create.
\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nSpecifies the attributes that make up the primary key for a table or an index. The attributes in\n KeySchema must also be defined in the AttributeDefinitions array. For more\n information, see Data\n Model in the Amazon DynamoDB Developer Guide.
\nEach KeySchemaElement in the array is composed of:
\nAttributeName - The name of this key attribute.
\nKeyType - Determines whether the key attribute is HASH or\n RANGE.
For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH.
For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
\n ", "required": true }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexList", "type": "list", "members": { "shape_name": "LocalSecondaryIndex", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the local secondary index. The name must be unique among all other indexes\n on this table.
\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n ", "required": true } }, "documentation": "\nRepresents a local secondary index.
\n " }, "documentation": "\nOne or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given\n hash key value. There is a 10 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.
\nEach local secondary index in the array includes the following:
\nIndexName - The name of the local secondary index. Must be unique only for this\n table.
\n \nKeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nThe name of the global secondary index. The name must be unique among all other indexes on this table.
\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for a global secondary index, which consists of one or more pairs of attribute\n names and key types (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
\nFor current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents a global secondary index.
\n " }, "documentation": "\nOne or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:
\nIndexName - The name of the global secondary index. Must be unique only for this table.
\n \nKeySchema - Specifies the key schema for the global secondary index.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units.
\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
\nFor current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateTable operation.
\n " }, "output": { "shape_name": "CreateTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA name for the attribute.
\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\nThe data type for the attribute.
\n ", "required": true } }, "documentation": "\nRepresents an attribute for describing the key schema for the table and indexes.
\n " }, "documentation": "\nAn array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
\nEach AttributeDefinition object in this array is composed of:
\nAttributeName - The name of the attribute.
\nAttributeType - The data type for the attribute.
\nThe name of the table.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe primary key structure for the table. Each KeySchemaElement consists of:
\nAttributeName - The name of the attribute.
\nKeyType - The key type for the attribute. Can be either HASH or\n RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the table:
\nCREATING - The table is being created, as the result of a CreateTable\n operation.
\nUPDATING - The table is being updated, as the result of an UpdateTable\n operation.
\nDELETING - The table is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The table is ready for use.
\nThe date and time when the table was created, in UNIX epoch time format.
\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nThe provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nRepresents the name of the local secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). "
},
"Projection": {
"shape_name": "Projection",
"type": "structure",
"members": {
"ProjectionType": {
"shape_name": "ProjectionType",
"type": "string",
"enum": [
"ALL",
"KEYS_ONLY",
"INCLUDE"
],
"documentation": "\n The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a local secondary index.
\n " }, "documentation": "\nRepresents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:
\nIndexName - The name of the local secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nIndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\nItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
\nIf the table is in the DELETING state, no information about indexes will be returned.
The name of the global secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the global secondary index:
\nCREATING - The index is being created, as the result of a CreateTable or \n UpdateTable operation.
\nUPDATING - The index is being updated, as the result of a CreateTable or \n UpdateTable operation.
\nDELETING - The index is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The index is ready for use.
\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nRepresents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a global secondary index.
\n " }, "documentation": "\nThe global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:
\nIndexName - The name of the global secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
\nIndexSizeBytes - The total size of the global secondary index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nItemCount - The number of items in the global secondary index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nIf the table is in the DELETING state, no information about indexes will be returned.
Represents the properties of a table.
\n " } }, "documentation": "\nRepresents the output of a CreateTable operation.
\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being attempted to be changed is in use.
\n " } }, "documentation": "\nThe operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.
Too many operations for a given subscriber.
\n " } }, "documentation": "\nThe number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe CreateTable operation adds a new table to your account. In an AWS account, table\n names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.
\nCreateTable is an asynchronous operation. Upon receiving a CreateTable request, Amazon DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, Amazon DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable API to check the table status.
\nThe name of the table from which to delete the item.
\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
\n ", "required": true }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\nCauses Amazon DynamoDB to evaluate the value before attempting a conditional operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n " } }, "documentation": "\nRepresents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.
\n " }, "documentation": "\nA map of attribute/condition pairs. This is the conditional block for the DeleteItemoperation. All the conditions must be met for the operation to succeed.
Expected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.
\nEach item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:
\nValue - The attribute value for Amazon DynamoDB to check.
\nExists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional\n operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value\n all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is\n implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n\n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\nUse ReturnValues if you want to get the item attributes as they appeared before they were\n deleted. For DeleteItem, the valid values are:
\nNONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Represents the input of a DeleteItem operation.
\n " }, "output": { "shape_name": "DeleteItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute names to AttributeValue objects, representing the item as it appeared\n before the DeleteItem operation. This map appears in the response only\n if ReturnValues was specified as ALL_OLD in the request.
The name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe hash key value of the item collection. This is the same as the hash key of the item.
\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\nAn estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\n " } }, "documentation": "Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.
\nEach ItemCollectionMetrics\n element consists of:
\nItemCollectionKey - The hash key value of the item\n collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,\n measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nRepresents the output of a DeleteItem operation.
\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe conditional request failed.
\n " } }, "documentation": "\nA condition specified in the operation could not be evaluated.
\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
\n " } }, "documentation": "\nAn item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.
\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nDeletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute value.
\nIn addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
\nUnless you specify conditions, the DeleteItem is an idempotent operation; running it\n multiple times on the same item or attribute does not result in an error\n response.
\nConditional deletes are useful for only deleting items if specific conditions are met. If those\n conditions are met, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.
\nThe name of the table to delete.
\n ", "required": true } }, "documentation": "\nRepresents the input of a DeleteTable operation.
\n " }, "output": { "shape_name": "DeleteTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA name for the attribute.
\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\nThe data type for the attribute.
\n ", "required": true } }, "documentation": "\nRepresents an attribute for describing the key schema for the table and indexes.
\n " }, "documentation": "\nAn array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
\nEach AttributeDefinition object in this array is composed of:
\nAttributeName - The name of the attribute.
\nAttributeType - The data type for the attribute.
\nThe name of the table.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe primary key structure for the table. Each KeySchemaElement consists of:
\nAttributeName - The name of the attribute.
\nKeyType - The key type for the attribute. Can be either HASH or\n RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the table:
\nCREATING - The table is being created, as the result of a CreateTable\n operation.
\nUPDATING - The table is being updated, as the result of an UpdateTable\n operation.
\nDELETING - The table is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The table is ready for use.
\nThe date and time when the table was created, in UNIX epoch time format.
\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nThe provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nRepresents the name of the local secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). "
},
"Projection": {
"shape_name": "Projection",
"type": "structure",
"members": {
"ProjectionType": {
"shape_name": "ProjectionType",
"type": "string",
"enum": [
"ALL",
"KEYS_ONLY",
"INCLUDE"
],
"documentation": "\n The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a local secondary index.
\n " }, "documentation": "\nRepresents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:
\nIndexName - The name of the local secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nIndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\nItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
\nIf the table is in the DELETING state, no information about indexes will be returned.
The name of the global secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the global secondary index:
\nCREATING - The index is being created, as the result of a CreateTable or \n UpdateTable operation.
\nUPDATING - The index is being updated, as the result of a CreateTable or \n UpdateTable operation.
\nDELETING - The index is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The index is ready for use.
\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nRepresents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a global secondary index.
\n " }, "documentation": "\nThe global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:
\nIndexName - The name of the global secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
\nIndexSizeBytes - The total size of the global secondary index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nItemCount - The number of items in the global secondary index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nIf the table is in the DELETING state, no information about indexes will be returned.
Represents the properties of a table.
\n " } }, "documentation": "\nRepresents the output of a DeleteTable operation.
\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being attempted to be changed is in use.
\n " } }, "documentation": "\nThe operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.
The resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
Too many operations for a given subscriber.
\n " } }, "documentation": "\nThe number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the DELETING state until\n Amazon DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete\n it. If a table is in CREATING or UPDATING states, then Amazon DynamoDB returns\n a ResourceInUseException. If the specified table does not exist, Amazon DynamoDB returns a\n ResourceNotFoundException. If table is already in the DELETING state, no\n error is returned.
Amazon DynamoDB might continue to accept data read and write operations, such as GetItem and\n PutItem, on a table in the DELETING state until the table deletion is\n complete.
When you delete a table, any indexes on that table are also deleted.
\n \nUse the DescribeTable API to check the status of the table.
\n\nThe name of the table to describe.
\n ", "required": true } }, "documentation": "\nRepresents the input of a DescribeTable operation.
\n " }, "output": { "shape_name": "DescribeTableOutput", "type": "structure", "members": { "Table": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA name for the attribute.
\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\nThe data type for the attribute.
\n ", "required": true } }, "documentation": "\nRepresents an attribute for describing the key schema for the table and indexes.
\n " }, "documentation": "\nAn array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
\nEach AttributeDefinition object in this array is composed of:
\nAttributeName - The name of the attribute.
\nAttributeType - The data type for the attribute.
\nThe name of the table.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe primary key structure for the table. Each KeySchemaElement consists of:
\nAttributeName - The name of the attribute.
\nKeyType - The key type for the attribute. Can be either HASH or\n RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the table:
\nCREATING - The table is being created, as the result of a CreateTable\n operation.
\nUPDATING - The table is being updated, as the result of an UpdateTable\n operation.
\nDELETING - The table is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The table is ready for use.
\nThe date and time when the table was created, in UNIX epoch time format.
\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nThe provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nRepresents the name of the local secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). "
},
"Projection": {
"shape_name": "Projection",
"type": "structure",
"members": {
"ProjectionType": {
"shape_name": "ProjectionType",
"type": "string",
"enum": [
"ALL",
"KEYS_ONLY",
"INCLUDE"
],
"documentation": "\n The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a local secondary index.
\n " }, "documentation": "\nRepresents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:
\nIndexName - The name of the local secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nIndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\nItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
\nIf the table is in the DELETING state, no information about indexes will be returned.
The name of the global secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the global secondary index:
\nCREATING - The index is being created, as the result of a CreateTable or \n UpdateTable operation.
\nUPDATING - The index is being updated, as the result of a CreateTable or \n UpdateTable operation.
\nDELETING - The index is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The index is ready for use.
\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nRepresents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a global secondary index.
\n " }, "documentation": "\nThe global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:
\nIndexName - The name of the global secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
\nIndexSizeBytes - The total size of the global secondary index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nItemCount - The number of items in the global secondary index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nIf the table is in the DELETING state, no information about indexes will be returned.
Represents the properties of a table.
\n " } }, "documentation": "\nRepresents the output of a DescribeTable operation.
\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nReturns information about the table, including the current status of the table, when it was\n created, the primary key schema, and any indexes on the table.
\nThis example describes the Thread table.
\nThe name of the table containing the requested item.
\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.
\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "If set to true, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Represents the input of a GetItem operation.
\n " }, "output": { "shape_name": "GetItemOutput", "type": "structure", "members": { "Item": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute names to AttributeValue objects, as specified by AttributesToGet.
\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " } }, "documentation": "\nRepresents the output of a GetItem operation.
\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe GetItem operation returns a set of attributes for the item with the given primary\n key. If there is no matching item, GetItem does not return any data.
\nGetItem provides an eventually consistent read by default. If your application\n requires a strongly consistent read, set ConsistentRead to true. Although\n a strongly consistent read might take more time than an eventually consistent read, it always\n returns the last updated value.
The name of the table that starts the list. If you already ran a ListTables operation\n and received a LastEvaluatedTableName value in the response, use that value here to\n continue the list.
\n " }, "Limit": { "shape_name": "ListTablesInputLimit", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\nA maximum number of table names to return.
\n " } }, "documentation": "\nRepresents the input of a ListTables operation.
\n " }, "output": { "shape_name": "ListTablesOutput", "type": "structure", "members": { "TableNames": { "shape_name": "TableNameList", "type": "list", "members": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "documentation": "\nThe names of the tables associated with the current account at the current endpoint.
\n " }, "LastEvaluatedTableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the last table in the current list, only if some tables for the account and\n endpoint have not been returned. This value does not exist in a response if all table names\n are already returned. Use this value as the ExclusiveStartTableName in a new request to\n continue the list until all the table names are returned.
\n " } }, "documentation": "\nRepresents the output of a ListTables operation.
\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nReturns an array of all the tables associated with the current account and endpoint.
\nThis example requests a list of tables, starting with a table named comp2 and ending\n after three table names have been returned.
\nThe name of the table to contain the item.
\n ", "required": true }, "Item": { "shape_name": "PutItemInputAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for the\n item.
\nIf 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.
\nFor more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
\nEach element in the Item map is an AttributeValue object.
\n ", "required": true }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\nCauses Amazon DynamoDB to evaluate the value before attempting a conditional operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n " } }, "documentation": "\nRepresents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.
\n " }, "documentation": "\nA map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.
Expected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.
\nEach item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:
\nValue - The attribute value for Amazon DynamoDB to check.
\nExists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional\n operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value\n all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is\n implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n \n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\nUse ReturnValues if you want to get the item attributes as they appeared before they were updated\n with the PutItem request. For PutItem, the valid values are:
\nNONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This is the default for ReturnValues.)
ALL_OLD - If PutItem overwrote an attribute name-value pair, then\n the content of the old item is returned.
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Represents the input of a PutItem operation.
\n " }, "output": { "shape_name": "PutItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe attribute values as they appeared before the PutItem operation, but only if \n ReturnValues is specified as ALL_OLD in the request. Each\n element consists of an attribute name and an attribute value.
The name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe hash key value of the item collection. This is the same as the hash key of the item.
\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\nAn estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\n " } }, "documentation": "Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.
\nEach ItemCollectionMetrics\n element consists of:
\nItemCollectionKey - The hash key value of the item\n collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size,\n measured in gigabytes. This is a two-element array\n containing a lower bound and an upper bound for the\n estimate. The estimate includes the size of all the\n items in the table, plus the size of all attributes\n projected into all of the local secondary indexes on that\n table. Use this estimate to measure whether a local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\nRepresents the output of a PutItem operation.
\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe conditional request failed.
\n " } }, "documentation": "\nA condition specified in the operation could not be evaluated.
\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
\n " } }, "documentation": "\nAn item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.
\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nCreates a new item, or replaces an old item with a new item. If an item already exists in the\n specified table with the same primary key, the new item completely replaces the existing item.\n You can perform a conditional put (insert a new item if one with the specified primary key\n doesn't exist), or replace an existing item if it has certain attribute values.
\nIn addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
\nWhen you add an item, the primary key attribute(s) are the only required attributes.\n Attribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes cannot be empty. Requests with empty values will be\n rejected with a ValidationException.
\nYou can request that PutItem return either a copy of the old item (before the update)\n or a copy of the new item (after the update). For more information, see the\n ReturnValues description.
\nTo prevent a new item from replacing an existing item, use a conditional put\n operation with Exists set to false for the primary key attribute, or\n attributes.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.
\nThis example puts a new item into the Thread table. To prevent this new item from overwriting an existing item, \"Exists\" is set to false for the primary key attributes.
\nThe name of the table containing the requested items.
\n ", "required": true }, "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of an index to query. This can be any local secondary index or global secondary index on the table.
\n " }, "Select": { "shape_name": "Select", "type": "string", "enum": [ "ALL_ATTRIBUTES", "ALL_PROJECTED_ATTRIBUTES", "SPECIFIC_ATTRIBUTES", "COUNT" ], "documentation": "\nThe attributes to be returned in the result. You can\n retrieve all item attributes, specific item attributes, the count \n of matching items, or in the case of an index, some or all of the \n attributes projected into the index.
\nALL_ATTRIBUTES: Returns all of the item attributes. For a table,\n this is the default. For an index, this mode causes Amazon DynamoDB to fetch the full\n item from the table for each matching item in the index. If the index is configured to\n project all item attributes, the matching items will not be fetched from the table.\n Fetching items from the table incurs additional throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying an index. Retrieves all\n attributes which have been projected into the index. If the index is configured\n to project all attributes, this is equivalent to specifying ALL_ATTRIBUTES.
COUNT: Returns the number of matching items, rather than the matching items\n themselves.
\n SPECIFIC_ATTRIBUTES : Returns only the attributes listed in AttributesToGet. This is equivalent to\n specifying AttributesToGet without specifying any value\n for Select.
If you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.
\n\nIf neither Select nor AttributesToGet are specified, Amazon DynamoDB\n defaults to ALL_ATTRIBUTES when accessing a table, and \n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single\n request, unless the value for Select\n is SPECIFIC_ATTRIBUTES. (This usage is equivalent to \n specifying AttributesToGet without any value for Select.)
The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.
\n \nIf you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.
\n\nYou cannot use both AttributesToGet and Select together in a Query\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying AttributesToGet without any value for\n Select.)
The maximum number of items to evaluate (not necessarily the number of matching items). If\n Amazon DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a LastEvaluatedKey to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to\n continue the operation. For more information see
If set to true, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with\n ConsistentRead set to true, you will receive an error message.
A String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nOne or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN or IN comparison, in which\n case the list contains two values.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.
\nA comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.
Valid comparison operators for Query:
\nEQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
Valid comparison operators for Scan:
\nEQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.
\nThe following are descriptions of each comparison operator.
\nEQ : Equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
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,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).
\nNOT_CONTAINS : checks for absence of a subsequence, or absence of a value in\n a set.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).
\nBEGINS_WITH : checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).
\n \nIN : checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.
\nBETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue of a different type than\n the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
Represents a selection criteria for a Query or Scan operation.
\nFor a Query operation, the condition specifies the key attributes to use when\n querying a table or an index.
\nFor a Scan operation, the condition is used to evaluate the scan results and\n return only the desired values.
\nMultiple conditions are \"ANDed\" together. In other words, all of the conditions must be met\n to be included in the output.
\n " }, "documentation": "\nThe selection criteria for the query.
\nFor a query on a table, you can only have conditions on the table primary key attributes. You\n must specify the hash key attribute name and value as an EQ condition. You can\n 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 attributes.\n You must specify the index hash attribute name and value as an EQ condition. You can\n optionally specify a second condition, referring to the index key range attribute.
\nMultiple conditions are evaluated using \"AND\"; in other words, all of the conditions must be met in order for an item to appear in the results results.
\nEach KeyConditions element consists of an attribute name to compare, along with the following:
\nAttributeValueList - One or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN comparison, in which\n case the list contains two values.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.
\nComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.
\nValid comparison operators for Query:
\nEQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.
\nThe following are descriptions of each comparison operator.
\nEQ : Equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
BEGINS_WITH : checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).
\n \nBETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue of a different type than\n the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
Specifies ascending (true) or descending (false) traversal of the index. Amazon DynamoDB returns results reflecting\n 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, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
\nIf ScanIndexForward is not specified, the results are returned in ascending order.
\n " }, "ExclusiveStartKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "The primary key of the first item that this operation will evalute. Use the value that was returned for LastEvaluatedKey in the previous operation.
\nThe data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\nIf set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
Represents the input of a Query operation.
\n " }, "output": { "shape_name": "QueryOutput", "type": "structure", "members": { "Items": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": null }, "documentation": "\nAn array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
\n " }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of items in the response.
\n " }, "LastEvaluatedKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is null, then the \"last page\" of results has been processed and there is no more data to be retrieved.
\nIf LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.
\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " } }, "documentation": "\nRepresents the output of a Query operation.
\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nA Query operation directly accesses items from a table using the table primary key, or\n from an index using the index key. You must provide a specific hash key value. You can narrow\n the scope of the query by using comparison operators on the range key value, or on the index\n key. You can use the ScanIndexForward parameter to get results in forward or reverse\n order, by range key or by index key.
\nQueries that do not return results consume the minimum read capacity units according to the\n type of read.
\nIf the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query\n stops and results are returned to the user with a LastEvaluatedKey to continue the\n query in a subsequent operation. Unlike a Scan operation, a Query operation\n never returns an empty result set and a LastEvaluatedKey. The\n LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used\n Limit.
\nYou can query a table, a local secondary index (LSI), or a global secondary index (GSI). For a query on a table or on an LSI, you can set ConsistentRead to true and obtain a strongly consistent result. GSIs support eventually consistent reads only, so do not specify ConsistentRead when querying a GSI.
\nThis example queries the Thread table for postings between two dates. There is an index on\n LastPostDateTime to facilitate fast lookups on this attribute.
\nAll of the attributes will be returned. Any attributes that are not projected into the\n index will cause Amazon DynamoDB to fetch those attributes from the Thread table;\n this fetching occurs automatically.
\nThe name of the table containing the requested items.
\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.
\n " }, "Limit": { "shape_name": "PositiveIntegerObject", "type": "integer", "min_length": 1, "documentation": "The maximum number of items to evaluate (not necessarily the number of matching items). If\n Amazon DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a LastEvaluatedKey to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to\n continue the operation. For more information see
The attributes to be returned in the result. You can\n retrieve all item attributes, specific item attributes, or the count \n of matching items.
\nALL_ATTRIBUTES: Returns all of the item attributes.
COUNT: Returns the number of matching items, rather than the matching items\n themselves.
\n SPECIFIC_ATTRIBUTES : Returns only the attributes listed in AttributesToGet. This is equivalent to\n specifying AttributesToGet without specifying any value\n for Select.
If neither Select nor AttributesToGet are specified, Amazon DynamoDB\n defaults to ALL_ATTRIBUTES. You cannot use both Select and AttributesToGet together in a single\n request, unless the value for Select\n is SPECIFIC_ATTRIBUTES. (This usage is equivalent to \n specifying AttributesToGet without any value for Select.)
A String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nOne or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN or IN comparison, in which\n case the list contains two values.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.
\nA comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.
Valid comparison operators for Query:
\nEQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
Valid comparison operators for Scan:
\nEQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.
\nThe following are descriptions of each comparison operator.
\nEQ : Equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
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,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).
\nNOT_CONTAINS : checks for absence of a subsequence, or absence of a value in\n a set.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).
\nBEGINS_WITH : checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).
\n \nIN : checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.
\nBETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue of a different type than\n the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
Represents a selection criteria for a Query or Scan operation.
\nFor a Query operation, the condition specifies the key attributes to use when\n querying a table or an index.
\nFor a Scan operation, the condition is used to evaluate the scan results and\n return only the desired values.
\nMultiple conditions are \"ANDed\" together. In other words, all of the conditions must be met\n to be included in the output.
\n " }, "documentation": "\nEvaluates the scan results and returns only the desired values. Multiple conditions are\n treated as \"AND\" operations: all conditions must be met to be included in the results.
\nEach ScanConditions element consists of an attribute name to compare, along with the following:
\nAttributeValueList - One or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN or IN comparison, in which\n case the list contains two values.
For type Number, value comparisons are numeric.
\nString value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.
\nComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.
\nValid comparison operators for Scan:
\nEQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.
\nThe following are descriptions of each comparison operator.
\nEQ : Equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If an item contains an AttributeValue of a different\n type than the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
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,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for a substring match. If the target attribute of the comparison is\n Binary, then the operation looks for a subsequence of the target that matches the input.\n If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the\n operation checks for a member of the set (not as a substring).
\nNOT_CONTAINS : checks for absence of a subsequence, or absence of a value in\n a set.
AttributeValueList can contain only one AttributeValue of type String,\n Number, or Binary (not a set). If the target attribute of the comparison is a String, then\n the operation checks for the absence of a substring match. If the target attribute of the\n comparison is Binary, then the operation checks for the absence of a subsequence of the\n target that matches the input. If the target attribute of the comparison is a set (\"SS\",\n \"NS\", or \"BS\"), then the operation checks for the absence of a member of the set (not as a\n substring).
\nBEGINS_WITH : checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or\n Binary (not a Number or a set). The target attribute of the comparison must be a String or\n Binary (not a Number or a set).
\n \nIN : checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String,\n Number, or Binary (not a set). The target attribute of the comparison must be of the same\n type and exact value to match. A String never matches a String set.
\nBETWEEN : Greater than or equal to the first value, and less than or equal\n to the second value.
AttributeValueList must contain two AttributeValue elements of the same\n type, either String, Number, or Binary (not a set). A target attribute matches if the\n target value is greater than, or equal to, the first element and less than, or equal to,\n the second element. If an item contains an AttributeValue of a different type than\n the one specified in the request, the value does not match. For example,\n {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also,\n {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
A String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "The primary key of the first item that this operation will evalute. Use the value that was returned for LastEvaluatedKey in the previous operation.
\nThe data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
\n \nIn a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\nIf set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments\n corresponds to the number of application workers that will\n perform the parallel scan. For example, if you want to scan a table using four\n application threads, you would specify a TotalSegments value of 4.
\nThe value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential\n rather than parallel.
\nIf you specify TotalSegments, you must also specify Segment.
\n" }, "Segment": { "shape_name": "ScanSegment", "type": "integer", "min_length": 0, "max_length": 4095, "documentation": "\nFor a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
\nSegment IDs are zero-based, so the first segment is always 0. For example, if you want to\n scan a table using four application threads, the first thread would specify a Segment\n value of 0, the second thread would specify 1, and so on.
\nThe value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.
\nThe value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
\nIf you specify Segment, you must also specify TotalSegments.
\n " } }, "documentation": "\nRepresents the input of a Scan operation.
\n " }, "output": { "shape_name": "ScanOutput", "type": "structure", "members": { "Items": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": null }, "documentation": "\nAn array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
\n " }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of items in the response.
\n " }, "ScannedCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of items in the complete scan, before any filters are applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
\n\n " }, "LastEvaluatedKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.
\nIf LastEvaluatedKey is null, then the \"last page\" of results has been processed and there is no more data to be retrieved.
\nIf LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.
\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " } }, "documentation": "\nRepresents the output of a Scan operation.
\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nThe Scan operation returns one or more items and item attributes by accessing every item in the table. To have Amazon DynamoDB return fewer items, you can provide a ScanFilter.
\n\nIf the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are\n returned to the user with a LastEvaluatedKey to continue the scan in a subsequent\n operation. The results also include the number of items exceeding the limit. A scan can result\n in no table data meeting the filter criteria.
\nThe result set is eventually consistent.
\nBy default, Scan operations proceed sequentially; however, for faster performance on\n large tables, applications can request a parallel Scan by specifying the Segment\n and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
\nThe name of the table containing the item to update.
\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe primary key that defines the item. Each element consists of an attribute name and a value for that attribute.
\n ", "required": true }, "AttributeUpdates": { "shape_name": "AttributeUpdates", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValueUpdate", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "Action": { "shape_name": "AttributeAction", "type": "string", "enum": [ "ADD", "PUT", "DELETE" ], "documentation": "\nSpecifies how to perform the update. Valid values are PUT, DELETE,\n and ADD. The behavior depends on whether the specified primary key already exists\n in the table.
\n If an item with the specified Key is found in the table:\n
\n \nPUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.
DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the existing\n value's data type.
If a set of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set [a,b,c] and the\n DELETE action specified [a,c], then the final attribute value\n would be [b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the behavior\n 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\n the Value is mathematically added to the existing attribute. If\n Value is a negative number, then it is subtracted from the existing\n attribute.
\n If you use ADD to increment or decrement a number value for an\n item that doesn't exist before the update, Amazon DynamoDB uses 0 as the initial\n value.
In addition, if you use ADD to update an existing item, and intend\n to increment or decrement an attribute value which does not yet exist, Amazon DynamoDB\n uses 0 as the initial value. For example, suppose that the item you\n want to update does not yet have an attribute named itemcount, but you\n decide to ADD the number 3 to this attribute anyway,\n even though it currently does not exist. Amazon DynamoDB will create the itemcount\n attribute, set its initial value to 0, and finally add\n 3 to it. The result will be a new itemcount attribute in\n the item, with a value of 3.
If the existing data type is a set, and if the Value is also a set, then\n the Value is added to the existing set. (This is a set operation,\n not mathematical addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified [3],\n then the final attribute value would be [1,2,3]. An error occurs if\n an Add action is specified for a set attribute and the attribute type specified\n does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing\n data type is a set of strings, the Value must also be a set of strings. The\n same holds true for number sets and binary sets.
\nThis action is only valid for an existing attribute whose data type is number or is a\n set. Do not use ADD for any other data types.
\n If no item with the specified Key is found:\n
\n \nPUT - Amazon DynamoDB creates a new item with the specified primary key, and\n then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - Amazon DynamoDB creates an item with the supplied primary key and number\n (or set of numbers) for the attribute value. The only data types allowed are number\n and number set; no other data types can be specified.
For the UpdateItem operation, represents the attributes to be modified,the action to perform on each, and the new value for each.
\nYou cannot use UpdateItem to update any primary key attributes. Instead, you will\n need to delete the item, and then use PutItem to create a new item with new\n attributes.
\nAttribute values cannot be null; string and binary type attributes must have lengths greater\n than zero; and set type attributes must not be empty. Requests with empty values will be\n rejected with a ValidationException.
\n " }, "documentation": "\nThe names of attributes to be modified, the action to perform on each, and the new value for\n each. If you are updating an attribute that is an index key attribute for any indexes on that\n table, the attribute type must match the index key type defined in the AttributesDefinition of\n the table description. You can use UpdateItem to update any non-key attributes.
\nAttribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes must not be empty. Requests with empty values will be\n rejected with a ValidationException.
\nEach AttributeUpdates element consists of an attribute name to modify, along with the\n following:
\nValue - The new value, if applicable, for this attribute.
\nAction - Specifies how to perform the update. Valid values for Action\n are PUT, DELETE, and ADD. The behavior depends on\n whether the specified primary key already exists in the table.
\n If an item with the specified Key is found in the table:\n
\n\nPUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.
DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the existing\n value's data type.
If a set of values is specified, then those values are subtracted from the old\n set. For example, if the attribute value was the set [a,b,c] and the\n DELETE action specified [a,c], then the final attribute value\n would be [b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the behavior\n 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\n the Value is mathematically added to the existing attribute. If\n Value is a negative number, then it is subtracted from the existing\n attribute.
\n If you use ADD to increment or decrement a number value for an\n item that doesn't exist before the update, Amazon DynamoDB uses 0 as the initial\n value.
In addition, if you use ADD to update an existing item, and intend\n to increment or decrement an attribute value which does not yet exist, Amazon DynamoDB\n uses 0 as the initial value. For example, suppose that the item you\n want to update does not yet have an attribute named itemcount, but you\n decide to ADD the number 3 to this attribute anyway,\n even though it currently does not exist. Amazon DynamoDB will create the itemcount\n attribute, set its initial value to 0, and finally add\n 3 to it. The result will be a new itemcount attribute in\n the item, with a value of 3.
If the existing data type is a set, and if the Value is also a set, then\n the Value is added to the existing set. (This is a set operation,\n not mathematical addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified [3],\n then the final attribute value would be [1,2,3]. An error occurs if\n an Add action is specified for a set attribute and the attribute type specified\n does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing\n data type is a set of strings, the Value must also be a set of strings. The\n same holds true for number sets and binary sets.
\nThis action is only valid for an existing attribute whose data type is number or is a\n set. Do not use ADD for any other data types.
\n If no item with the specified Key is found:\n
\n\nPUT - Amazon DynamoDB creates a new item with the specified primary key, and\n then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - Amazon DynamoDB creates an item with the supplied primary key and number\n (or set of numbers) for the attribute value. The only data types allowed are number\n and number set; no other data types can be specified.
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.
\n " }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\nCauses Amazon DynamoDB to evaluate the value before attempting a conditional operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n " } }, "documentation": "\nRepresents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.
\n " }, "documentation": "\nA map of attribute/condition pairs. This is the conditional block for the UpdateItem operation. All the conditions must be met for the operation to succeed.
\nExpected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.
\nEach item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:
\nValue - The attribute value for Amazon DynamoDB to check.
\nExists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional\n operation:
\nIf Exists is true, Amazon DynamoDB will check to see if that attribute\n value already exists in the table. If it is found, then the operation\n succeeds. If it is not found, the operation fails with a\n ConditionalCheckFailedException.
If Exists is false, Amazon DynamoDB assumes that the attribute value does\n not exist in the table. If in fact the value does not exist, then the\n assumption is valid and the operation succeeds. If the value is found,\n despite the assumption that it does not exist, the operation fails with a\n ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value\n all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is\n implied.
Amazon DynamoDB returns a ValidationException if:
\nExists is true but there is no Value to check. (You expect\n a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot\n expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.
\n\n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\nUse ReturnValues if you want to get the item attributes as they appeared either before\n or after they were updated. For UpdateItem, the valid values are:
\nNONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This is the default for ReturnValues.)
ALL_OLD - If UpdateItem overwrote an attribute name-value pair,\n then the content of the old item is returned.
UPDATED_OLD - The old versions of only the updated attributes are\n returned.
ALL_NEW - All of the attributes of the new version of the item are\n returned.
UPDATED_NEW - The new versions of only the updated attributes are\n returned.
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Represents the input of an UpdateItem operation.
\n " }, "output": { "shape_name": "UpdateItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nA map of attribute values as they appeared before the UpdateItem operation, but only if\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.
The name of the table that was affected by the operation.
\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed by the operation.
\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nThe amount of throughput consumed on the table affected by the operation.
\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each local index affected by the operation.
\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\nThe total number of capacity units consumed on a table or an index.
\n " } }, "documentation": "\nRepresents the amount of provisioned throughput capacity consumed on a table or an index.
\n " }, "documentation": "\nThe amount of throughput consumed on each global index affected by the operation.
\n " } }, "documentation": "\nRepresents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\nA String data type
\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\nA Number data type
\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\nA Binary data type
\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\nA String set data type
\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\nNumber set data type
\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\nA Binary set data type
\n " } }, "documentation": "\nRepresents the data for an attribute. You can set one, and only one, of the elements.
\n " }, "documentation": "\nThe hash key value of the item collection. This is the same as the hash key of the item.
\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\nAn estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.
\nThe estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
\n " } }, "documentation": "\nInformation about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.
\n " } }, "documentation": "\nRepresents the output of an UpdateItem operation.
\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe conditional request failed.
\n " } }, "documentation": "\nA condition specified in the operation could not be evaluated.
\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nYou exceeded your maximum allowed provisioned throughput.
\n " } }, "documentation": "\nThe request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
\n " } }, "documentation": "\nAn item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.
\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nEdits 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\n also perform a conditional update (insert a new attribute name-value pair if it doesn't exist,\n or replace an existing name-value pair if it has certain expected attribute values).
\nIn addition to updating an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
\nThis example updates the Thread table, changing the LastPostedBy attribute-but\n only if LastPostedBy is currently \"fred@example.com\". All of the item's attributes, as\n they appear after the update, are returned in the response.
\nThe name of the table to be updated.
\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
\nFor current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "GlobalSecondaryIndexUpdates": { "shape_name": "GlobalSecondaryIndexUpdateList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexUpdate", "type": "structure", "members": { "Update": { "shape_name": "UpdateGlobalSecondaryIndexAction", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nThe name of the global secondary index to be updated.
\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
\nFor current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
\n ", "required": true } }, "documentation": "\nThe name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.
\n " } }, "documentation": "\nRepresents the new provisioned throughput settings to apply to a global secondary index.
\n " }, "documentation": "\nAn array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
\n " } }, "documentation": "\nRepresents the input of an UpdateTable operation.
\n " }, "output": { "shape_name": "UpdateTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA name for the attribute.
\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\nThe data type for the attribute.
\n ", "required": true } }, "documentation": "\nRepresents an attribute for describing the key schema for the table and indexes.
\n " }, "documentation": "\nAn array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
\nEach AttributeDefinition object in this array is composed of:
\nAttributeName - The name of the attribute.
\nAttributeType - The data type for the attribute.
\nThe name of the table.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe primary key structure for the table. Each KeySchemaElement consists of:
\nAttributeName - The name of the attribute.
\nKeyType - The key type for the attribute. Can be either HASH or\n RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the table:
\nCREATING - The table is being created, as the result of a CreateTable\n operation.
\nUPDATING - The table is being updated, as the result of an UpdateTable\n operation.
\nDELETING - The table is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The table is ready for use.
\nThe date and time when the table was created, in UNIX epoch time format.
\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nThe provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\nRepresents the name of the local secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). "
},
"Projection": {
"shape_name": "Projection",
"type": "structure",
"members": {
"ProjectionType": {
"shape_name": "ProjectionType",
"type": "string",
"enum": [
"ALL",
"KEYS_ONLY",
"INCLUDE"
],
"documentation": "\n The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a local secondary index.
\n " }, "documentation": "\nRepresents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:
\nIndexName - The name of the local secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nIndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates\n this value approximately every six hours. Recent changes might not be reflected in this\n value.
\nItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this value.
\nIf the table is in the DELETING state, no information about indexes will be returned.
The name of the global secondary index.
\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name of a key attribute.
\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\nThe attribute data, consisting of the data type and the attribute value\n itself.
\n ", "required": true } }, "documentation": "\nRepresents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.
\n " }, "min_length": 1, "max_length": 2, "documentation": "\nThe complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).
The set of attributes that are projected into the index:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
Represents the non-key attribute names which will be projected into the index.
\nFor local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\n " } }, "documentation": "\nRepresents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.
\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\nThe current state of the global secondary index:
\nCREATING - The index is being created, as the result of a CreateTable or \n UpdateTable operation.
\nUPDATING - The index is being updated, as the result of a CreateTable or \n UpdateTable operation.
\nDELETING - The index is being deleted, as the result of a DeleteTable\n operation.
\nACTIVE - The index is ready for use.
\nThe date and time of the last provisioned throughput increase for this table.
\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\nThe date and time of the last provisioned throughput decrease for this table.
\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.
\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\nThe maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.
\n " } }, "documentation": "\nRepresents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.
\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\nThe total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\n " } }, "documentation": "\nRepresents the properties of a global secondary index.
\n " }, "documentation": "\nThe global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:
\nIndexName - The name of the global secondary index.
\nKeySchema - Specifies the complete index key schema. The attribute names in the\n key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
\nProjection - Specifies\n attributes that are copied (projected) from the table into the index. These are in\n addition to the primary key attributes and index key\n attributes, which are automatically projected. Each\n attribute specification is composed of:
\nProjectionType - One\n of the following:
\nKEYS_ONLY - Only the index and primary keys are projected into the\n index.
INCLUDE - Only the specified table attributes are projected into the\n index. The list of projected attributes are\n in NonKeyAttributes.
ALL - All of the table attributes are projected into the\n index.
NonKeyAttributes - A list of one or more non-key attribute names that are \n projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
\nProvisionedThroughput - The provisioned throughput settings for the global secondary index,\n consisting of read and write capacity units, along with data about increases and\n decreases.
\nIndexSizeBytes - The total size of the global secondary index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nItemCount - The number of items in the global secondary index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n
\nIf the table is in the DELETING state, no information about indexes will be returned.
Represents the properties of a table.
\n " } }, "documentation": "\nRepresents the output of an UpdateTable operation.
\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nThe resource which is being attempted to be changed is in use.
\n " } }, "documentation": "\nThe operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.
The resource which is being requested does not exist.
\n " } }, "documentation": "\nThe operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.
Too many operations for a given subscriber.
\n " } }, "documentation": "\nThe number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
The server encountered an internal error trying to fulfill the request.
\n " } }, "documentation": "\nAn error occurred on the server side.
\n " } ], "documentation": "\nUpdates the provisioned throughput for the given table. Setting the throughput for a table\n helps you manage performance and is part of the provisioned throughput feature of Amazon DynamoDB.
\nThe provisioned throughput values can be upgraded or downgraded based on the maximums and\n minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.
\nThe table must be in the ACTIVE state for this operation to succeed.\n UpdateTable is an asynchronous operation; while executing the operation, the table is\n in the UPDATING state. While the table is in the UPDATING state, the\n table still has the provisioned throughput from before the call. The new provisioned\n throughput setting is in effect only when the table returns to the ACTIVE state\n after the UpdateTable operation.
You cannot add, modify or delete indexes using UpdateTable. Indexes can only be defined at table creation time.
\n\nThis example changes both the provisioned read and write throughput of the Thread table to\n 10 capacity units.
\n