Amazon Web Services - API Amazon DynamoDB

Amazon Web Services / Amazon DynamoDB / Releases / 2011-12-05

Amazon DynamoDB

RELEASED
2011-12-05 - Released at 2011-12-05 00:00

v4 from 2011-12-05

Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.

Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.

License: Apache 2.0 License

Resources

POST

/#X-Amz-Target=DynamoDB_20111205.BatchGetItem

Retrieves the attributes for multiple items from multiple tables using their primary keys.

The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an UnprocessedKeys value so you can retry the operation starting with the next item to get.

Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate UnprocessedKeys value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.

Request

Query

Name	Data Type	Description
`RequestItems`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.BatchGetItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`BatchGetItemInput`	object

Properties

RequestItems BatchGetRequestMap


                        BatchGetRequestMap

object
Minimum: 1
Maximum: 100

A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.

Responses

200Success

Body

Name	Data Type	Description
`BatchGetItemOutput`	object

Properties

Responses BatchGetResponseMap


                        BatchGetResponseMap

object

Table names and the respective item attributes from the tables.


                        UnprocessedKeys

BatchGetRequestMap

Contains a map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. The UnprocessedKeys value is in the same form as a RequestItems parameter (so the value can be provided directly to a subsequent BatchGetItem operation). For more information, see the above RequestItems parameter.


                        BatchGetRequestMap

object
Minimum: 1
Maximum: 100

A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.BatchWriteItem

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.

There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.BatchWriteItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`BatchWriteItemInput`	object

Properties


                        RequestItems

BatchWriteItemRequestMap

A map of table name to list-of-write-requests. Used as input to the BatchWriteItem API call


                        BatchWriteItemRequestMap

object
Minimum: 1
Maximum: 25

A map of table name to list-of-write-requests.

Key: The table name corresponding to the list of requests

Value: Essentially a list of request items. Each request item could contain either a PutRequest or DeleteRequest. Never both.

Responses

200Success

Body

Name	Data Type	Description
`BatchWriteItemOutput`	object	A container for `BatchWriteItem` response

Properties


                        Responses

BatchWriteResponseMap

The response object as a result of BatchWriteItem call. This is essentially a map of table name to ConsumedCapacityUnits.

BatchWriteResponseMap object


                        UnprocessedItems

BatchWriteItemRequestMap

The Items which we could not successfully process in a BatchWriteItem call is returned as UnprocessedItems


                        BatchWriteItemRequestMap

object
Minimum: 1
Maximum: 25

A map of table name to list-of-write-requests.

Key: The table name corresponding to the list of requests

Value: Essentially a list of request items. Each request item could contain either a PutRequest or DeleteRequest. Never both.

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

483RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

484InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.CreateTable

Adds a new table to your account.

The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. us-east-1).

The CreateTable operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table (CREATING) until the table is in the ACTIVE state. Once the table is in the ACTIVE state, you can perform data plane operations.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.CreateTable`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CreateTableInput`	object

Properties


                        TableName

TableName

The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

ProvisionedThroughput ProvisionedThroughput


                        ProvisionedThroughput

object

Provisioned throughput reserves the required read and write resources for your table in terms of ReadCapacityUnits and WriteCapacityUnits. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.

Properties

`ReadCapacityUnits`	PositiveLongObject	`ReadCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `ReadCapacityUnits`. Eventually-consistent reads only require half the `ReadCapacityUnits` of stirctly consistent reads.
`WriteCapacityUnits`	PositiveLongObject	`WriteCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `WriteCapacityUnits`.

Responses

200Success

Body

Name	Data Type	Description
`CreateTableOutput`	object

Properties

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

482InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.DeleteItem

Deletes a single item in a table by primary key.

You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.DeleteItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeleteItemInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Responses

200Success

Body

Name	Data Type	Description
`DeleteItemOutput`	object

Properties


                        Attributes

AttributeMap

If the ReturnValues parameter is provided as ALL_OLD in the request, Amazon DynamoDB returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains an empty set.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

480ConditionalCheckFailedException

Body

Name	Data Type	Description
`ConditionalCheckFailedException`

481ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

482ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

483LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

484RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

485InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.DeleteTable

Deletes a table and all of its items.

If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states then Amazon DynamoDB returns a ResourceInUseException. If the specified table does not exist, Amazon DynamoDB returns a ResourceNotFoundException.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.DeleteTable`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeleteTableInput`	object

Properties


                        TableName

TableName

The name of the table you want to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Responses

200Success

Body

Name	Data Type	Description
`DeleteTableOutput`	object

Properties

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.DescribeTable

Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.

If the table does not exist, Amazon DynamoDB returns a ResourceNotFoundException.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.DescribeTable`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DescribeTableInput`	object

Properties


                        TableName

TableName

The name of the table you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Responses

200Success

Body

Name	Data Type	Description
`DescribeTableOutput`	object

Properties

Table TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

480ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

481InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.GetItem

Retrieves a set of Attributes for an item that matches the primary key.

The GetItem operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use ConsistentRead. Although this operation might take longer than a standard read, it always returns the last updated value.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.GetItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetItemInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

ConsistentRead ConsistentRead


                        ConsistentRead

boolean

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

Responses

200Success

Body

Name	Data Type	Description
`GetItemOutput`	object

Properties


                        Item

AttributeMap

Contains the requested attributes.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.ListTables

Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. us-east-1).

Request

Query

Name	Data Type	Description
`Limit`	string	Pagination limit
`ExclusiveStartTableName`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.ListTables`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListTablesInput`	object

Properties


                        ExclusiveStartTableName

TableName

The name of the table that starts the list. If you already ran a ListTables operation and received a LastEvaluatedTableName value in the response, use that value here to continue the list.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Limit ListTablesInputLimit


                        ListTablesInputLimit

integer
Minimum: 1
Maximum: 100

A number of maximum table names to return.

Responses

200Success

Body

Name	Data Type	Description
`ListTablesOutput`	object

Properties

TableNames TableNameList

TableNameList array [TableName]
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255


                        LastEvaluatedTableName

TableName

The name of the last table in the current list. Use this value as the ExclusiveStartTableName in a new request to continue the list until all the table names are returned. If this value is null, all table names have been returned.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

480InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.PutItem

Creates a new item, or replaces an old item with a new item (including all the attributes).

If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.PutItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`PutItemInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Item PutItemInputAttributeMap


                        PutItemInputAttributeMap

object

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Responses

200Success

Body

Name	Data Type	Description
`PutItemOutput`	object

Properties


                        Attributes

AttributeMap

Attribute values before the put operation, but only if the ReturnValues parameter is specified as ALL_OLD in the request.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

480ConditionalCheckFailedException

Body

Name	Data Type	Description
`ConditionalCheckFailedException`

481ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

482ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

483LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

484RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

485InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.Query

Gets the values of one or more items and its attributes by primary key (composite primary key, only).

Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.

Request

Query

Name	Data Type	Description
`Limit`	string	Pagination limit
`ExclusiveStartKey`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.Query`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`QueryInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.


                        Limit

PositiveIntegerObject

The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a LastEvaluatedKey to apply in a subsequent operation to continue the query.

PositiveIntegerObject integer
Minimum: 1

ConsistentRead ConsistentRead


                        ConsistentRead

boolean

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.


                        Count

BooleanObject

If set to true, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

BooleanObject boolean


                        HashKeyValue

AttributeValue

Attribute value of the hash component of the composite primary key.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyCondition

Condition

A container for the attribute values and comparison operators to use for the query.

Condition object

Properties

`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator


                        ScanIndexForward

BooleanObject

Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. The default value is true (forward).

BooleanObject boolean


                        ExclusiveStartKey

Key

Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the LastEvaluatedKey if that query operation was interrupted before completing the query; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new query request to continue the operation from that point.

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Responses

200Success

Body

Name	Data Type	Description
`QueryOutput`	object

Properties

Items ItemList

ItemList array [AttributeMap]

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        Count

Integer

Number of items in the response.

Integer integer


                        LastEvaluatedKey

Key

Primary key of the item where the query operation stopped, inclusive of the previous result set. Use this value to start a new operation excluding this value in the new request. The LastEvaluatedKey is null when the entire query result set is complete (i.e. the operation processed the "last page").

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.Scan

Retrieves one or more items and its attributes by performing a full scan of a table.

Provide a ScanFilter to get more specific results.

Request

Query

Name	Data Type	Description
`Limit`	string	Pagination limit
`ExclusiveStartKey`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.Scan`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ScanInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.


                        Limit

PositiveIntegerObject

The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan.

PositiveIntegerObject integer
Minimum: 1


                        Count

BooleanObject

If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

BooleanObject boolean


                        ScanFilter

FilterConditionMap

Evaluates the scan results and returns only the desired values.

FilterConditionMap object

Properties

`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator

Extends

Condition

Properties

Name	Data Type	Description
`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator


                        ExclusiveStartKey

Key

Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new scan request to continue the operation from that point.

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Responses

200Success

Body

Name	Data Type	Description
`ScanOutput`	object

Properties

Items ItemList

ItemList array [AttributeMap]

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        Count

Integer

Number of items in the response.

Integer integer


                        ScannedCount

Integer

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

Integer integer


                        LastEvaluatedKey

Key

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.UpdateItem

Edits an existing item's attributes.

You can perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.UpdateItem`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`UpdateItemInput`	object

Properties


                        TableName

TableName

The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

AttributeUpdates AttributeUpdates


                        AttributeUpdates

object

Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Responses

200Success

Body

Name	Data Type	Description
`UpdateItemOutput`	object

Properties


                        Attributes

AttributeMap

A map of attribute name-value pairs, but only if the ReturnValues parameter is specified as something other than NONE in the request.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

480ConditionalCheckFailedException

Body

Name	Data Type	Description
`ConditionalCheckFailedException`

481ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

482ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

483LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

484RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

485InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20111205.UpdateTable

Updates the provisioned throughput for the given table.

Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.

Request

Header

Name	Data Type	Description
`X-Amz-Target`	string Allowed values: - `DynamoDB_20111205.UpdateTable`
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`UpdateTableInput`	object

Properties


                        TableName

TableName

The name of the table you want to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

ProvisionedThroughput ProvisionedThroughput


                        ProvisionedThroughput

object

Properties

`ReadCapacityUnits`	PositiveLongObject	`ReadCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `ReadCapacityUnits`. Eventually-consistent reads only require half the `ReadCapacityUnits` of stirctly consistent reads.
`WriteCapacityUnits`	PositiveLongObject	`WriteCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `WriteCapacityUnits`.

Responses

200Success

Body

Name	Data Type	Description
`UpdateTableOutput`	object

Properties

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

480ResourceInUseException

Body

Name	Data Type	Description
`ResourceInUseException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

Models

AttributeMap

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

AttributeNameList

AttributeUpdates

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

BatchGetItemInput

BatchGetItemOutput

Properties

Name Data Type Description

Responses BatchGetResponseMap


                        BatchGetResponseMap

object

Table names and the respective item attributes from the tables.


                        UnprocessedKeys

BatchGetRequestMap


                        BatchGetRequestMap

object
Minimum: 1
Maximum: 100

A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.

BatchGetRequestMap

BatchGetResponseMap

BatchWriteItemInput

BatchWriteItemOutput

A container for BatchWriteItem response

Properties

Name Data Type Description


                        Responses

BatchWriteResponseMap

The response object as a result of BatchWriteItem call. This is essentially a map of table name to ConsumedCapacityUnits.

BatchWriteResponseMap object


                        UnprocessedItems

BatchWriteItemRequestMap

The Items which we could not successfully process in a BatchWriteItem call is returned as UnprocessedItems


                        BatchWriteItemRequestMap

object
Minimum: 1
Maximum: 25

A map of table name to list-of-write-requests.

Key: The table name corresponding to the list of requests

Value: Essentially a list of request items. Each request item could contain either a PutRequest or DeleteRequest. Never both.

BatchWriteItemRequestMap

BatchWriteResponseMap

BooleanObject

Condition

ConditionalCheckFailedException

ConsistentRead

ConsumedCapacityUnits

CreateTableInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

ProvisionedThroughput ProvisionedThroughput


                        ProvisionedThroughput

object

Properties

`ReadCapacityUnits`	PositiveLongObject	`ReadCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `ReadCapacityUnits`. Eventually-consistent reads only require half the `ReadCapacityUnits` of stirctly consistent reads.
`WriteCapacityUnits`	PositiveLongObject	`WriteCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `WriteCapacityUnits`.

CreateTableOutput

Properties

Name Data Type Description

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

DeleteItemInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

DeleteItemOutput

Properties

Name Data Type Description


                        Attributes

AttributeMap

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

DeleteTableInput

DeleteTableOutput

Properties

Name Data Type Description

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

DescribeTableInput

DescribeTableOutput

Properties

Name Data Type Description

Table TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

ExpectedAttributeMap

FilterConditionMap

GetItemInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

ConsistentRead ConsistentRead


                        ConsistentRead

boolean

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

GetItemOutput

Properties

Name Data Type Description


                        Item

AttributeMap

Contains the requested attributes.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

Integer

InternalServerError

ItemList

Name Data Type Description

ItemList array [AttributeMap]

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Key

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties

Name Data Type Description


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

KeySchema

LimitExceededException

ListTablesInput

ListTablesInputLimit

ListTablesOutput

Properties

Name Data Type Description

TableNames TableNameList

TableNameList array [TableName]
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255


                        LastEvaluatedTableName

TableName

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

PositiveIntegerObject

ProvisionedThroughput

ProvisionedThroughputExceededException

PutItemInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Item PutItemInputAttributeMap


                        PutItemInputAttributeMap

object

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

PutItemInputAttributeMap

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

PutItemOutput

Properties

Name Data Type Description


                        Attributes

AttributeMap

Attribute values before the put operation, but only if the ReturnValues parameter is specified as ALL_OLD in the request.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

QueryInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.


                        Limit

PositiveIntegerObject

PositiveIntegerObject integer
Minimum: 1

ConsistentRead ConsistentRead


                        ConsistentRead

boolean

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.


                        Count

BooleanObject

BooleanObject boolean


                        HashKeyValue

AttributeValue

Attribute value of the hash component of the composite primary key.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyCondition

Condition

A container for the attribute values and comparison operators to use for the query.

Condition object

Properties

`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator


                        ScanIndexForward

BooleanObject

Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. The default value is true (forward).

BooleanObject boolean


                        ExclusiveStartKey

Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

QueryOutput

Properties

Name Data Type Description

Items ItemList

ItemList array [AttributeMap]

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        Count

Integer

Number of items in the response.

Integer integer


                        LastEvaluatedKey

Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

RequestLimitExceeded

ResourceInUseException

ResourceNotFoundException

ReturnValue

ScanInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

AttributesToGet AttributeNameList


                        AttributeNameList

array [AttributeName]
Minimum: 1

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.


                        Limit

PositiveIntegerObject

PositiveIntegerObject integer
Minimum: 1


                        Count

BooleanObject

BooleanObject boolean


                        ScanFilter

FilterConditionMap

Evaluates the scan results and returns only the desired values.

FilterConditionMap object

Properties

`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator

Extends

Condition

Properties

Name	Data Type	Description
`AttributeValueList`	AttributeValueList
`ComparisonOperator`	ComparisonOperator


                        ExclusiveStartKey

Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ScanOutput

Properties

Name Data Type Description

Items ItemList

ItemList array [AttributeMap]

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        Count

Integer

Number of items in the response.

Integer integer


                        ScannedCount

Integer

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

Integer integer


                        LastEvaluatedKey

Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

TableDescription

Properties

Name Data Type Description


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

TableName

TableNameList

UpdateItemInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

Key Key

Key

object

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

Properties


                        HashKeyElement

AttributeValue

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.


                        RangeKeyElement

AttributeValue


                        AttributeValue

object

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

AttributeUpdates AttributeUpdates


                        AttributeUpdates

object

Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes.

Expected ExpectedAttributeMap


                        ExpectedAttributeMap

object

ReturnValues ReturnValue


                        ReturnValue

string
Allowed values:
- NONE
- ALL_OLD
- UPDATED_OLD
- ALL_NEW
- UPDATED_NEW

NONE: Nothing is returned.
ALL_OLD: Returns the attributes of the item as they were before the operation.
UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
ALL_NEW: Returns all the attributes and their new values after the operation.
UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

UpdateItemOutput

Properties

Name Data Type Description


                        Attributes

AttributeMap

A map of attribute name-value pairs, but only if the ReturnValues parameter is specified as something other than NONE in the request.

AttributeMap object

Properties

`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

Extends

AttributeValue

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

Properties

Name	Data Type	Description
`S`	StringAttributeValue	Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
`N`	NumberAttributeValue	Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
`B`	BinaryAttributeValue	Binary attributes are sequences of unsigned bytes.
`SS`	StringSetAttributeValue	A set of strings.
`NS`	NumberSetAttributeValue	A set of numbers.
`BS`	BinarySetAttributeValue	A set of binary attributes.

ConsumedCapacityUnits ConsumedCapacityUnits


                        ConsumedCapacityUnits

double

UpdateTableInput

Properties

Name Data Type Description


                        TableName

TableName

The name of the table you want to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

ProvisionedThroughput ProvisionedThroughput


                        ProvisionedThroughput

object

Properties

`ReadCapacityUnits`	PositiveLongObject	`ReadCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `ReadCapacityUnits`. Eventually-consistent reads only require half the `ReadCapacityUnits` of stirctly consistent reads.
`WriteCapacityUnits`	PositiveLongObject	`WriteCapacityUnits` are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the `WriteCapacityUnits`.

UpdateTableOutput

Properties

Name Data Type Description

TableDescription TableDescription

TableDescription object

Properties


                        TableName

TableName

The name of the table being described.

TableName string
Pattern: [a-zA-Z0-9_.-]+
Minimum: 3
Maximum: 255

KeySchema KeySchema


                        KeySchema

object

Properties

`HashKeyElement`	KeySchemaElement	A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be `String`, `Number`, `StringSet`, `NumberSet`.
`RangeKeyElement`	KeySchemaElement	A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be `String`, `Number`, `StringSet`, `NumberSet`.

TableStatus TableStatus

CreationDateTime Date

ProvisionedThroughput ProvisionedThroughputDescription

TableSizeBytes Long

ItemCount Long

Authentication

Api Key

Amazon Signature authorization v4

Location: header
Header Name: Authorization
Amazon-apigateway-authtype: awsSigv4

Contact

Name	`AWS`
External URL	`https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html`

Metadata (Technical Details)

Release	`v4`
Provider Name	`amazonaws.com`
Service Name	`dynamodb`
Origin - ContentType	`application/json`
Origin - Url	`https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dynamodb-2011-12-05.normal.json`
Origin - X-apisguru-driver	`external`
Api Client Registration	`https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct`
Preferred	`No`
API Version	`2011-12-05`
Has Equivalent Paths	`Yes`

Comments

Loading comments ...