dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/aws/dynamodb/2011-12-05.json
SVN-Git Migration 8d99895006 Imported Upstream version 0.52.0
2015-10-08 11:15:31 -07:00

4460 lines
300 KiB
JSON
Raw Blame History

{
"api_version": "2011-12-05",
"type": "json",
"json_version": 1.0,
"target_prefix": "DynamoDB_20111205",
"signature_version": "v4",
"service_full_name": "Amazon DynamoDB",
"service_abbreviation": "DynamoDB",
"endpoint_prefix": "dynamodb",
"xmlnamespace": "http://dynamodb.amazonaws.com/doc/2011-12-05/",
"documentation": "\n <p>Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.</p>\n\n <p>Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and\n predictable performance.</p>\n\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": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash)\n primary key or a two attribute (hash-and-range) primary key.</p>\n "
},
"min_length": 1,
"max_length": 100,
"documentation": null,
"required": true
},
"AttributesToGet": {
"shape_name": "AttributeNameList",
"type": "list",
"members": {
"shape_name": "AttributeName",
"type": "string",
"documentation": null
},
"min_length": 1,
"documentation": "\n <p>List of <code>Attribute</code> names. If attribute names are not specified then all attributes will be returned.\n If some attributes are not found, they will not appear in the result.</p>\n "
},
"ConsistentRead": {
"shape_name": "ConsistentRead",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, then a consistent read is issued. Otherwise eventually-consistent is used.</p>\n "
}
},
"documentation": null
},
"min_length": 1,
"max_length": 100,
"documentation": "\n <p>A map of the table name and corresponding items to get by primary key. While requesting items, each table name\n can be invoked only once per operation.</p>\n ",
"required": true
}
},
"documentation": null
},
"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": "BatchResponse",
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": null
},
"documentation": null
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": "\n <p>The item attributes from a response in a specific table, along with the read resources consumed on the table\n during the request.</p>\n "
},
"documentation": "\n <p>Table names and the respective item attributes from the tables.</p>\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": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash)\n primary key or a two attribute (hash-and-range) primary key.</p>\n "
},
"min_length": 1,
"max_length": 100,
"documentation": null,
"required": true
},
"AttributesToGet": {
"shape_name": "AttributeNameList",
"type": "list",
"members": {
"shape_name": "AttributeName",
"type": "string",
"documentation": null
},
"min_length": 1,
"documentation": "\n <p>List of <code>Attribute</code> names. If attribute names are not specified then all attributes will be returned.\n If some attributes are not found, they will not appear in the result.</p>\n "
},
"ConsistentRead": {
"shape_name": "ConsistentRead",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, then a consistent read is issued. Otherwise eventually-consistent is used.</p>\n "
}
},
"documentation": null
},
"min_length": 1,
"max_length": 100,
"documentation": "\n <p>Contains a map of tables and their respective keys that were not processed with the current response, possibly\n due to reaching a limit on the response size. The <code>UnprocessedKeys</code> value is in the same form as a\n <code>RequestItems</code> parameter (so the value can be provided directly to a subsequent <code>BatchGetItem</code>\n operation). For more information, see the above <code>RequestItems</code> parameter.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Retrieves the attributes for multiple items from multiple tables using their primary keys.</p>\n\n <p>The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of\n items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial\n result is returned due to an internal processing failure, Amazon DynamoDB returns an <code>UnprocessedKeys</code>\n value so you can retry the operation starting with the next item to get.</p>\n\n <p>Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example,\n even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items\n and an appropriate <code>UnprocessedKeys</code> value so you can get the next page of results. If necessary,\n your application needs its own logic to assemble the pages of results into one set.</p>\n\n "
},
"BatchWriteItem": {
"name": "BatchWriteItem",
"input": {
"shape_name": "BatchWriteItemInput",
"type": "structure",
"members": {
"RequestItems": {
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>The item to put</p>\n ",
"required": true
}
},
"documentation": "\n <p>A container for a Put BatchWrite request</p>\n "
},
"DeleteRequest": {
"shape_name": "DeleteRequest",
"type": "structure",
"members": {
"Key": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The item's key to be delete</p>\n ",
"required": true
}
},
"documentation": "\n <p>A container for a Delete BatchWrite request</p>\n "
}
},
"documentation": "\n <p>This structure is a Union of PutRequest and DeleteRequest. It can contain exactly one of <code>PutRequest</code> or <code>DeleteRequest</code>. Never Both. This is enforced in the code.</p>\n "
},
"min_length": 1,
"max_length": 25,
"documentation": null
},
"min_length": 1,
"max_length": 25,
"documentation": "\n <p>A map of table name to list-of-write-requests. Used as input to the <code>BatchWriteItem</code> API call</p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "BatchWriteItemOutput",
"type": "structure",
"members": {
"Responses": {
"shape_name": "BatchWriteResponseMap",
"type": "map",
"keys": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": null
},
"members": {
"shape_name": "BatchWriteResponse",
"type": "structure",
"members": {
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"documentation": "\n <p>The response object as a result of <code>BatchWriteItem</code> call. This is essentially a map of table name to <code>ConsumedCapacityUnits</code>.</p>\n "
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>The item to put</p>\n ",
"required": true
}
},
"documentation": "\n <p>A container for a Put BatchWrite request</p>\n "
},
"DeleteRequest": {
"shape_name": "DeleteRequest",
"type": "structure",
"members": {
"Key": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The item's key to be delete</p>\n ",
"required": true
}
},
"documentation": "\n <p>A container for a Delete BatchWrite request</p>\n "
}
},
"documentation": "\n <p>This structure is a Union of PutRequest and DeleteRequest. It can contain exactly one of <code>PutRequest</code> or <code>DeleteRequest</code>. Never Both. This is enforced in the code.</p>\n "
},
"min_length": 1,
"max_length": 25,
"documentation": null
},
"min_length": 1,
"max_length": 25,
"documentation": "\n <p>The Items which we could not successfully process in a <code>BatchWriteItem</code> call is returned as <code>UnprocessedItems</code></p>\n "
}
},
"documentation": "\n <p>A container for <code>BatchWriteItem</code> response</p>\n "
},
"errors": [
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.</p>\n <p>There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.</p>\n "
},
"CreateTable": {
"name": "CreateTable",
"input": {
"shape_name": "CreateTableInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table you want to create. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"KeySchema": {
"shape_name": "KeySchema",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute\n (hash-and-range) primary key. Single attribute primary keys have one index value: a <code>HashKeyElement</code>.\n A composite hash-and-range primary key contains two attribute values: a <code>HashKeyElement</code> and a\n <code>RangeKeyElement</code>.</p>\n ",
"required": true
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughput",
"type": "structure",
"members": {
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": "\n <p><code>ReadCapacityUnits</code> are in terms of strictly consistent reads, assuming items of 1k. 2k items\n require twice the <code>ReadCapacityUnits</code>. Eventually-consistent reads only require half the\n <code>ReadCapacityUnits</code> of stirctly consistent reads.</p>\n ",
"required": true
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": "\n <p><code>WriteCapacityUnits</code> are in terms of strictly consistent reads, assuming items of 1k. 2k items\n require twice the <code>WriteCapacityUnits</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Provisioned throughput reserves the required read and write resources for your table in terms of\n <code>ReadCapacityUnits</code> and <code>WriteCapacityUnits</code>. Values for provisioned throughput depend\n upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write\n operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value.\n For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent\n reads.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "CreateTableOutput",
"type": "structure",
"members": {
"TableDescription": {
"shape_name": "TableDescription",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table being described.</p>\n "
},
"KeySchema": {
"shape_name": "KeySchema",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute\n (hash-and-range) primary key. Single attribute primary keys have one index value: a <code>HashKeyElement</code>.\n A composite hash-and-range primary key contains two attribute values: a <code>HashKeyElement</code> and a\n <code>RangeKeyElement</code>.</p>\n "
},
"TableStatus": {
"shape_name": "TableStatus",
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
],
"documentation": null
},
"CreationDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughputDescription",
"type": "structure",
"members": {
"LastIncreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"LastDecreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"NumberOfDecreasesToday": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
}
},
"documentation": null
},
"TableSizeBytes": {
"shape_name": "Long",
"type": "long",
"documentation": null
},
"ItemCount": {
"shape_name": "Long",
"type": "long",
"documentation": null
}
},
"documentation": null
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ResourceInUseException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Adds a new table to your account.</p>\n\n <p>The table name must be unique among those associated with the AWS Account issuing the request, and the AWS\n Region that receives the request (e.g. <code>us-east-1</code>).</p>\n\n <p>The <code>CreateTable</code> operation triggers an asynchronous workflow to begin creating the table. Amazon\n DynamoDB immediately returns the state of the table (<code>CREATING</code>) until the table is in the\n <code>ACTIVE</code> state. Once the table is in the <code>ACTIVE</code> state, you can perform data plane\n operations.</p>\n\n "
},
"DeleteItem": {
"name": "DeleteItem",
"input": {
"shape_name": "DeleteItemInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to delete an item. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"Key": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash)\n primary key or a two attribute (hash-and-range) primary key.</p>\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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>Specify whether or not a value already exists and has a specific content for the attribute name-value pair.</p>\n "
},
"Exists": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>Specify whether or not a value already exists for the attribute name-value pair.</p>\n "
}
},
"documentation": "\n <p>Allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute\n value already exists; or if the attribute value exists and has a particular value before changing it.</p>\n "
},
"documentation": "\n <p>Designates an attribute for a conditional modification. The <code>Expected</code> parameter allows you to provide\n an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value\n before modifying it.</p>\n "
},
"ReturnValues": {
"shape_name": "ReturnValue",
"type": "string",
"enum": [
"NONE",
"ALL_OLD",
"UPDATED_OLD",
"ALL_NEW",
"UPDATED_NEW"
],
"documentation": "\n <p>Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For\n <code>PUT</code> operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>. For update operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>, <code>UPDATED_OLD</code>, <code>ALL_NEW</code> or <code>UPDATED_NEW</code>.</p>\n <ul>\n <li>\n<code>NONE</code>: Nothing is returned.</li>\n <li>\n<code>ALL_OLD</code>: Returns the attributes of the item as they were before the operation.</li>\n <li>\n<code>UPDATED_OLD</code>: Returns the values of the updated attributes, only, as they were before the operation.</li>\n <li>\n<code>ALL_NEW</code>: Returns all the attributes and their new values after the operation.</li>\n <li>\n<code>UPDATED_NEW</code>: Returns the values of the updated attributes, only, as they are after the operation.</li>\n </ul>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>If the <code>ReturnValues</code> parameter is provided as <code>ALL_OLD</code> in the request, Amazon DynamoDB\n returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains\n an empty set.</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ConditionalCheckFailedException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when an expected value does not match what was found in the system.</p>\n "
},
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Deletes a single item in a table by primary key.</p>\n\n <p>You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected\n attribute value.</p>\n\n "
},
"DeleteTable": {
"name": "DeleteTable",
"input": {
"shape_name": "DeleteTableInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table you want to delete. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "DeleteTableOutput",
"type": "structure",
"members": {
"TableDescription": {
"shape_name": "TableDescription",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table being described.</p>\n "
},
"KeySchema": {
"shape_name": "KeySchema",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute\n (hash-and-range) primary key. Single attribute primary keys have one index value: a <code>HashKeyElement</code>.\n A composite hash-and-range primary key contains two attribute values: a <code>HashKeyElement</code> and a\n <code>RangeKeyElement</code>.</p>\n "
},
"TableStatus": {
"shape_name": "TableStatus",
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
],
"documentation": null
},
"CreationDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughputDescription",
"type": "structure",
"members": {
"LastIncreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"LastDecreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"NumberOfDecreasesToday": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
}
},
"documentation": null
},
"TableSizeBytes": {
"shape_name": "Long",
"type": "long",
"documentation": null
},
"ItemCount": {
"shape_name": "Long",
"type": "long",
"documentation": null
}
},
"documentation": null
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ResourceInUseException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Deletes a table and all of its items.</p>\n\n <p>If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or\n <code>UPDATING</code> states then Amazon DynamoDB returns a <code>ResourceInUseException</code>. If\n the specified table does not exist, Amazon DynamoDB returns a <code>ResourceNotFoundException</code>.</p>\n\n "
},
"DescribeTable": {
"name": "DescribeTable",
"input": {
"shape_name": "DescribeTableInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table you want to describe. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "DescribeTableOutput",
"type": "structure",
"members": {
"Table": {
"shape_name": "TableDescription",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table being described.</p>\n "
},
"KeySchema": {
"shape_name": "KeySchema",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute\n (hash-and-range) primary key. Single attribute primary keys have one index value: a <code>HashKeyElement</code>.\n A composite hash-and-range primary key contains two attribute values: a <code>HashKeyElement</code> and a\n <code>RangeKeyElement</code>.</p>\n "
},
"TableStatus": {
"shape_name": "TableStatus",
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
],
"documentation": null
},
"CreationDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughputDescription",
"type": "structure",
"members": {
"LastIncreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"LastDecreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"NumberOfDecreasesToday": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
}
},
"documentation": null
},
"TableSizeBytes": {
"shape_name": "Long",
"type": "long",
"documentation": null
},
"ItemCount": {
"shape_name": "Long",
"type": "long",
"documentation": null
}
},
"documentation": null
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Retrieves information about the table, including the current status of the table, the primary key schema and\n when the table was created.</p>\n\n <p>If the table does not exist, Amazon DynamoDB returns a <code>ResourceNotFoundException</code>.</p>\n\n "
},
"GetItem": {
"name": "GetItem",
"input": {
"shape_name": "GetItemInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to get an item. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"Key": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash)\n primary key or a two attribute (hash-and-range) primary key.</p>\n ",
"required": true
},
"AttributesToGet": {
"shape_name": "AttributeNameList",
"type": "list",
"members": {
"shape_name": "AttributeName",
"type": "string",
"documentation": null
},
"min_length": 1,
"documentation": "\n <p>List of <code>Attribute</code> names. If attribute names are not specified then all attributes will be returned.\n If some attributes are not found, they will not appear in the result.</p>\n "
},
"ConsistentRead": {
"shape_name": "ConsistentRead",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, then a consistent read is issued. Otherwise eventually-consistent is used.</p>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>Contains the requested attributes.</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Retrieves a set of Attributes for an item that matches the primary key.</p>\n\n <p>The <code>GetItem</code> operation provides an eventually-consistent read by default. If eventually-consistent\n reads are not acceptable for your application, use <code>ConsistentRead</code>. Although this operation might\n take longer than a standard read, it always returns the last updated value.</p>\n\n "
},
"ListTables": {
"name": "ListTables",
"input": {
"shape_name": "ListTablesInput",
"type": "structure",
"members": {
"ExclusiveStartTableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table that starts the list. If you already ran a <code>ListTables</code> operation and received\n a <code>LastEvaluatedTableName</code> value in the response, use that value here to continue the list.</p>\n "
},
"Limit": {
"shape_name": "ListTablesInputLimit",
"type": "integer",
"min_length": 1,
"max_length": 100,
"documentation": "\n <p>A number of maximum table names to return.</p>\n "
}
},
"documentation": null
},
"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": null
},
"LastEvaluatedTableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the last table in the current list. Use this value as the <code>ExclusiveStartTableName</code> in a\n new request to continue the list until all the table names are returned. If this value is null, all table names\n have been returned.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g.\n <code>us-east-1</code>).</p>\n\n "
},
"PutItem": {
"name": "PutItem",
"input": {
"shape_name": "PutItemInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to put an item. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>A map of the attributes for the item, and must include the primary key values that define the item. Other\n attribute name-value pairs can be provided for the item.</p>\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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>Specify whether or not a value already exists and has a specific content for the attribute name-value pair.</p>\n "
},
"Exists": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>Specify whether or not a value already exists for the attribute name-value pair.</p>\n "
}
},
"documentation": "\n <p>Allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute\n value already exists; or if the attribute value exists and has a particular value before changing it.</p>\n "
},
"documentation": "\n <p>Designates an attribute for a conditional modification. The <code>Expected</code> parameter allows you to provide\n an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value\n before modifying it.</p>\n "
},
"ReturnValues": {
"shape_name": "ReturnValue",
"type": "string",
"enum": [
"NONE",
"ALL_OLD",
"UPDATED_OLD",
"ALL_NEW",
"UPDATED_NEW"
],
"documentation": "\n <p>Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For\n <code>PUT</code> operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>. For update operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>, <code>UPDATED_OLD</code>, <code>ALL_NEW</code> or <code>UPDATED_NEW</code>.</p>\n <ul>\n <li>\n<code>NONE</code>: Nothing is returned.</li>\n <li>\n<code>ALL_OLD</code>: Returns the attributes of the item as they were before the operation.</li>\n <li>\n<code>UPDATED_OLD</code>: Returns the values of the updated attributes, only, as they were before the operation.</li>\n <li>\n<code>ALL_NEW</code>: Returns all the attributes and their new values after the operation.</li>\n <li>\n<code>UPDATED_NEW</code>: Returns the values of the updated attributes, only, as they are after the operation.</li>\n </ul>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>Attribute values before the put operation, but only if the <code>ReturnValues</code> parameter is specified as\n <code>ALL_OLD</code> in the request.</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ConditionalCheckFailedException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when an expected value does not match what was found in the system.</p>\n "
},
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Creates a new item, or replaces an old item with a new item (including all the attributes).</p>\n\n <p>If an item already exists in the specified table with the same primary key, the new item completely replaces the\n existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't\n exist), or replace an existing item if it has certain attribute values.</p>\n\n "
},
"Query": {
"name": "Query",
"input": {
"shape_name": "QueryInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to query. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"AttributesToGet": {
"shape_name": "AttributeNameList",
"type": "list",
"members": {
"shape_name": "AttributeName",
"type": "string",
"documentation": null
},
"min_length": 1,
"documentation": "\n <p>List of <code>Attribute</code> names. If attribute names are not specified then all attributes will be returned.\n If some attributes are not found, they will not appear in the result.</p>\n "
},
"Limit": {
"shape_name": "PositiveIntegerObject",
"type": "integer",
"min_length": 1,
"documentation": "\n <p>The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the\n query and returns the matching values up to the limit, and a <code>LastEvaluatedKey</code> to apply in a\n subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits\n this limit, it stops the query and returns the matching values, and a <code>LastEvaluatedKey</code> to apply in a\n subsequent operation to continue the query.</p>\n "
},
"ConsistentRead": {
"shape_name": "ConsistentRead",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, then a consistent read is issued. Otherwise eventually-consistent is used.</p>\n "
},
"Count": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, Amazon DynamoDB returns a total number of items that match the query parameters,\n instead of a list of the matching items and their attributes. Do not set <code>Count</code> to <code>true</code> while providing\n a list of <code>AttributesToGet</code>, otherwise Amazon DynamoDB returns a validation error.</p>\n "
},
"HashKeyValue": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>Attribute value of the hash component of the composite primary key.</p>\n ",
"required": true
},
"RangeKeyCondition": {
"shape_name": "Condition",
"type": "structure",
"members": {
"AttributeValueList": {
"shape_name": "AttributeValueList",
"type": "list",
"members": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>A list of attribute values to be used with a comparison operator for a scan or query operation. For comparisons\n that require more than one value, such as a <code>BETWEEN</code> comparison, the AttributeValueList contains\n two attribute values and the comparison operator.</p>\n "
},
"ComparisonOperator": {
"shape_name": "ComparisonOperator",
"type": "string",
"enum": [
"EQ",
"NE",
"IN",
"LE",
"LT",
"GE",
"GT",
"BETWEEN",
"NOT_NULL",
"NULL",
"CONTAINS",
"NOT_CONTAINS",
"BEGINS_WITH"
],
"documentation": "\n <p>A comparison operator is an enumeration of several operations:</p>\n <ul>\n <li>\n<code>EQ</code> for <em>equal</em>.</li>\n <li>\n<code>NE</code> for <em>not equal</em>.</li>\n <li>\n<code>IN</code> checks for exact matches.</li>\n <li>\n<code>LE</code> for <em>less than or equal to</em>.</li>\n <li>\n<code>LT</code> for <em>less than</em>.</li>\n <li>\n<code>GE</code> for <em>greater than or equal to</em>.</li>\n <li>\n<code>GT</code> for <em>greater than</em>.</li>\n <li>\n<code>BETWEEN</code> for <em>between</em>.</li>\n <li>\n<code>NOT_NULL</code> for <em>exists</em>.</li>\n <li>\n<code>NULL</code> for <em>not exists</em>.</li>\n <li>\n<code>CONTAINS</code> for substring or value in a set.</li>\n <li>\n<code>NOT_CONTAINS</code> for absence of a substring or absence of a value in a set.</li>\n <li>\n<code>BEGINS_WITH</code> for a substring prefix.</li>\n </ul>\n <p>Scan operations support all available comparison operators.</p>\n <p>Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A container for the attribute values and comparison operators to use for the query.</p>\n "
},
"ScanIndexForward": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested\n order, determined by the range key. The default value is <code>true</code> (forward).</p>\n "
},
"ExclusiveStartKey": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the\n <code>LastEvaluatedKey</code> if that query operation was interrupted before completing the query; either because\n of the result set size or the <code>Limit</code> parameter. The <code>LastEvaluatedKey</code> can be passed back\n in a new query request to continue the operation from that point.</p>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": null
},
"documentation": null
},
"Count": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>Number of items in the response.</p>\n "
},
"LastEvaluatedKey": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>Primary key of the item where the query operation stopped, inclusive of the previous result set. Use this value\n to start a new operation excluding this value in the new request. The <code>LastEvaluatedKey</code> is null when\n the entire query result set is complete (i.e. the operation processed the \"last page\").</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Gets the values of one or more items and its attributes by primary key (composite primary key, only).</p>\n\n <p>Narrow the scope of the query using comparison operators on the <code>RangeKeyValue</code> of the composite key.\n Use the <code>ScanIndexForward</code> parameter to get results in forward or reverse order by range key.</p>\n\n "
},
"Scan": {
"name": "Scan",
"input": {
"shape_name": "ScanInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to scan. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"AttributesToGet": {
"shape_name": "AttributeNameList",
"type": "list",
"members": {
"shape_name": "AttributeName",
"type": "string",
"documentation": null
},
"min_length": 1,
"documentation": "\n <p>List of <code>Attribute</code> names. If attribute names are not specified then all attributes will be returned.\n If some attributes are not found, they will not appear in the result.</p>\n "
},
"Limit": {
"shape_name": "PositiveIntegerObject",
"type": "integer",
"min_length": 1,
"documentation": "\n <p>The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the\n scan and returns the matching values up to the limit, and a <code>LastEvaluatedKey</code> to apply in a subsequent\n operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this\n limit, it stops the scan and returns the matching values up to the limit, and a <code>LastEvaluatedKey</code> to\n apply in a subsequent operation to continue the scan.</p>\n "
},
"Count": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>If set to <code>true</code>, Amazon DynamoDB returns a total number of items for the <code>Scan</code> operation, even if the\n operation has no matching items for the assigned filter. Do not set <code>Count</code> to <code>true</code> while providing a\n list of <code>AttributesToGet</code>, otherwise Amazon DynamoDB returns a validation error.</p>\n "
},
"ScanFilter": {
"shape_name": "FilterConditionMap",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "Condition",
"type": "structure",
"members": {
"AttributeValueList": {
"shape_name": "AttributeValueList",
"type": "list",
"members": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>A list of attribute values to be used with a comparison operator for a scan or query operation. For comparisons\n that require more than one value, such as a <code>BETWEEN</code> comparison, the AttributeValueList contains\n two attribute values and the comparison operator.</p>\n "
},
"ComparisonOperator": {
"shape_name": "ComparisonOperator",
"type": "string",
"enum": [
"EQ",
"NE",
"IN",
"LE",
"LT",
"GE",
"GT",
"BETWEEN",
"NOT_NULL",
"NULL",
"CONTAINS",
"NOT_CONTAINS",
"BEGINS_WITH"
],
"documentation": "\n <p>A comparison operator is an enumeration of several operations:</p>\n <ul>\n <li>\n<code>EQ</code> for <em>equal</em>.</li>\n <li>\n<code>NE</code> for <em>not equal</em>.</li>\n <li>\n<code>IN</code> checks for exact matches.</li>\n <li>\n<code>LE</code> for <em>less than or equal to</em>.</li>\n <li>\n<code>LT</code> for <em>less than</em>.</li>\n <li>\n<code>GE</code> for <em>greater than or equal to</em>.</li>\n <li>\n<code>GT</code> for <em>greater than</em>.</li>\n <li>\n<code>BETWEEN</code> for <em>between</em>.</li>\n <li>\n<code>NOT_NULL</code> for <em>exists</em>.</li>\n <li>\n<code>NULL</code> for <em>not exists</em>.</li>\n <li>\n<code>CONTAINS</code> for substring or value in a set.</li>\n <li>\n<code>NOT_CONTAINS</code> for absence of a substring or absence of a value in a set.</li>\n <li>\n<code>BEGINS_WITH</code> for a substring prefix.</li>\n </ul>\n <p>Scan operations support all available comparison operators.</p>\n <p>Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH.</p>\n ",
"required": true
}
},
"documentation": null
},
"documentation": "\n <p>Evaluates the scan results and returns only the desired values.</p>\n "
},
"ExclusiveStartKey": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that\n scan operation was interrupted before scanning the entire table; either because of the result set size or the\n <code>Limit</code> parameter. The <code>LastEvaluatedKey</code> can be passed back in a new scan request to\n continue the operation from that point.</p>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": null
},
"documentation": null
},
"Count": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>Number of items in the response.</p>\n "
},
"ScannedCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>Number of items in the complete scan before any filters are applied. A high <code>ScannedCount</code> value with\n few, or no, <code>Count</code> results indicates an inefficient <code>Scan</code> operation.</p>\n "
},
"LastEvaluatedKey": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to\n continue the operation from that point. The <code>LastEvaluatedKey</code> is null when the entire scan result\n set is complete (i.e. the operation processed the \"last page\").</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Retrieves one or more items and its attributes by performing a full scan of a table.</p>\n\n <p>Provide a <code>ScanFilter</code> to get more specific results.</p>\n\n "
},
"UpdateItem": {
"name": "UpdateItem",
"input": {
"shape_name": "UpdateItemInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table in which you want to update an item. Allowed characters are <code>a-z</code>,\n <code>A-Z</code>, <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code>\n (period).</p>\n ",
"required": true
},
"Key": {
"shape_name": "Key",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"S": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash)\n primary key or a two attribute (hash-and-range) primary key.</p>\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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"Action": {
"shape_name": "AttributeAction",
"type": "string",
"enum": [
"ADD",
"PUT",
"DELETE"
],
"documentation": "\n <p>The type of action for an item update operation. Only use the add action for numbers or sets; the specified\n value is added to the existing value. If a set of values is specified, the values are added to the existing\n set. Adds the specified attribute. If the attribute exists, it is replaced by the new value. If no value is\n specified, this removes the attribute and its value. If a set of values is specified, then the values in the\n specified set are removed from the old set.</p>\n "
}
},
"documentation": "\n <p>Specifies the attribute to update and how to perform the update. Possible values: <code>PUT</code> (default),\n <code>ADD</code> or <code>DELETE</code>.</p>\n "
},
"documentation": "\n <p>Map of attribute name to the new value and action for the update. The attribute names specify the attributes to\n modify, and cannot contain any primary key attributes.</p>\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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>Specify whether or not a value already exists and has a specific content for the attribute name-value pair.</p>\n "
},
"Exists": {
"shape_name": "BooleanObject",
"type": "boolean",
"documentation": "\n <p>Specify whether or not a value already exists for the attribute name-value pair.</p>\n "
}
},
"documentation": "\n <p>Allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute\n value already exists; or if the attribute value exists and has a particular value before changing it.</p>\n "
},
"documentation": "\n <p>Designates an attribute for a conditional modification. The <code>Expected</code> parameter allows you to provide\n an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value\n before modifying it.</p>\n "
},
"ReturnValues": {
"shape_name": "ReturnValue",
"type": "string",
"enum": [
"NONE",
"ALL_OLD",
"UPDATED_OLD",
"ALL_NEW",
"UPDATED_NEW"
],
"documentation": "\n <p>Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For\n <code>PUT</code> operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>. For update operations, the possible parameter values are <code>NONE</code> (default) or\n <code>ALL_OLD</code>, <code>UPDATED_OLD</code>, <code>ALL_NEW</code> or <code>UPDATED_NEW</code>.</p>\n <ul>\n <li>\n<code>NONE</code>: Nothing is returned.</li>\n <li>\n<code>ALL_OLD</code>: Returns the attributes of the item as they were before the operation.</li>\n <li>\n<code>UPDATED_OLD</code>: Returns the values of the updated attributes, only, as they were before the operation.</li>\n <li>\n<code>ALL_NEW</code>: Returns all the attributes and their new values after the operation.</li>\n <li>\n<code>UPDATED_NEW</code>: Returns the values of the updated attributes, only, as they are after the operation.</li>\n </ul>\n "
}
},
"documentation": null
},
"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": "\n <p>Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024\n bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).</p>\n "
},
"N": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": "\n <p>Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision\n and can be between 10^-128 to 10^+126.</p>\n "
},
"B": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": "\n <p>Binary attributes are sequences of unsigned bytes.</p>\n "
},
"SS": {
"shape_name": "StringSetAttributeValue",
"type": "list",
"members": {
"shape_name": "StringAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of strings.</p>\n "
},
"NS": {
"shape_name": "NumberSetAttributeValue",
"type": "list",
"members": {
"shape_name": "NumberAttributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A set of numbers.</p>\n "
},
"BS": {
"shape_name": "BinarySetAttributeValue",
"type": "list",
"members": {
"shape_name": "BinaryAttributeValue",
"type": "blob",
"documentation": null
},
"documentation": "\n <p>A set of binary attributes.</p>\n "
}
},
"documentation": "\n <p>AttributeValue can be <code>String</code>, <code>Number</code>, <code>Binary</code>, <code>StringSet</code>, <code>NumberSet</code>, <code>BinarySet</code>.</p>\n "
},
"documentation": "\n <p>A map of attribute name-value pairs, but only if the <code>ReturnValues</code> parameter is specified as something\n other than <code>NONE</code> in the request.</p>\n "
},
"ConsumedCapacityUnits": {
"shape_name": "ConsumedCapacityUnits",
"type": "double",
"documentation": "\n <p>The number of Capacity Units of the provisioned throughput of the table consumed during the operation.\n <code>GetItem</code>, <code>BatchGetItem</code>, <code>BatchWriteItem</code>, <code>Query</code>, and <code>Scan</code> operations consume\n <code>ReadCapacityUnits</code>, while <code>PutItem</code>, <code>UpdateItem</code>, and <code>DeleteItem</code>\n operations consume <code>WriteCapacityUnits</code>.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ConditionalCheckFailedException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when an expected value does not match what was found in the system.</p>\n "
},
{
"shape_name": "ProvisionedThroughputExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the level of provisioned throughput defined for the table is exceeded.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Edits an existing item's attributes.</p>\n\n <p>You can perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an\n existing name-value pair if it has certain expected attribute values).</p>\n\n "
},
"UpdateTable": {
"name": "UpdateTable",
"input": {
"shape_name": "UpdateTableInput",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table you want to update. Allowed characters are <code>a-z</code>, <code>A-Z</code>,\n <code>0-9</code>, <code>_</code> (underscore), <code>-</code> (hyphen) and <code>.</code> (period).</p>\n ",
"required": true
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughput",
"type": "structure",
"members": {
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": "\n <p><code>ReadCapacityUnits</code> are in terms of strictly consistent reads, assuming items of 1k. 2k items\n require twice the <code>ReadCapacityUnits</code>. Eventually-consistent reads only require half the\n <code>ReadCapacityUnits</code> of stirctly consistent reads.</p>\n ",
"required": true
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": "\n <p><code>WriteCapacityUnits</code> are in terms of strictly consistent reads, assuming items of 1k. 2k items\n require twice the <code>WriteCapacityUnits</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Provisioned throughput reserves the required read and write resources for your table in terms of\n <code>ReadCapacityUnits</code> and <code>WriteCapacityUnits</code>. Values for provisioned throughput depend\n upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write\n operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value.\n For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent\n reads.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "UpdateTableOutput",
"type": "structure",
"members": {
"TableDescription": {
"shape_name": "TableDescription",
"type": "structure",
"members": {
"TableName": {
"shape_name": "TableName",
"type": "string",
"min_length": 3,
"max_length": 255,
"pattern": "[a-zA-Z0-9_.-]+",
"documentation": "\n <p>The name of the table being described.</p>\n "
},
"KeySchema": {
"shape_name": "KeySchema",
"type": "structure",
"members": {
"HashKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys\n have one index value. The value can be <code>String</code>, <code>Number</code>, <code>StringSet</code>,\n <code>NumberSet</code>.</p>\n ",
"required": true
},
"RangeKeyElement": {
"shape_name": "KeySchemaElement",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "KeySchemaAttributeName",
"type": "string",
"min_length": 1,
"max_length": 255,
"documentation": "\n <p>The <code>AttributeName</code> of the <code>KeySchemaElement</code>.</p>\n ",
"required": true
},
"AttributeType": {
"shape_name": "ScalarAttributeType",
"type": "string",
"enum": [
"S",
"N",
"B"
],
"documentation": "\n <p>The <code>AttributeType</code> of the <code>KeySchemaElement</code> which can be a <code>String</code> or a\n <code>Number</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string\n or a number, and is only used for hash-and-range primary keys. The value can be <code>String</code>,\n <code>Number</code>, <code>StringSet</code>, <code>NumberSet</code>.</p>\n "
}
},
"documentation": "\n <p>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute\n (hash-and-range) primary key. Single attribute primary keys have one index value: a <code>HashKeyElement</code>.\n A composite hash-and-range primary key contains two attribute values: a <code>HashKeyElement</code> and a\n <code>RangeKeyElement</code>.</p>\n "
},
"TableStatus": {
"shape_name": "TableStatus",
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
],
"documentation": null
},
"CreationDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"ProvisionedThroughput": {
"shape_name": "ProvisionedThroughputDescription",
"type": "structure",
"members": {
"LastIncreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"LastDecreaseDateTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": null
},
"NumberOfDecreasesToday": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"ReadCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
},
"WriteCapacityUnits": {
"shape_name": "PositiveLongObject",
"type": "long",
"min_length": 1,
"documentation": null
}
},
"documentation": null
},
"TableSizeBytes": {
"shape_name": "Long",
"type": "long",
"documentation": null
},
"ItemCount": {
"shape_name": "Long",
"type": "long",
"documentation": null
}
},
"documentation": null
}
},
"documentation": null
},
"errors": [
{
"shape_name": "ResourceInUseException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "ResourceNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the resource which is being attempted to be changed is in use.</p>\n "
},
{
"shape_name": "LimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.</p>\n "
},
{
"shape_name": "InternalServerError",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>This exception is thrown when the service has a problem when trying to process the request.</p>\n "
}
],
"documentation": "\n <p>Updates the provisioned throughput for the given table.</p>\n\n <p>Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature\n of Amazon DynamoDB.</p>\n\n "
}
},
"metadata": {
"regions": {
"us-east-1": null,
"ap-northeast-1": null,
"sa-east-1": null,
"ap-southeast-1": null,
"ap-southeast-2": null,
"us-west-2": null,
"us-west-1": null,
"eu-west-1": null,
"us-gov-west-1": null
},
"protocols": [
"https",
"http"
]
},
"retry": {
"__default__": {
"max_attempts": 10,
"delay": {
"type": "exponential",
"base": 0.05,
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
},
"throughput_exceeded": {
"applies_when": {
"response": {
"service_error_code": "ProvisionedThroughputExceededException",
"http_status_code": 400
}
}
},
"throttling": {
"applies_when": {
"response": {
"service_error_code": "ThrottlingException",
"http_status_code": 400
}
}
},
"crc32": {
"applies_when": {
"response": {
"crc32body": "x-amz-crc32"
}
}
}
}
}
}
}
Reference in a new issue View git blame Copy permalink