Amazon Web Services - API Amazon DynamoDB

Amazon Web Services / Amazon DynamoDB

Amazon DynamoDB

Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

License: Apache 2.0 License

Resources

POST

/#X-Amz-Target=DynamoDB_20120810.BatchGetItem

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Request

Query

Name	Data Type	Description
`RequestItems`	string	Pagination token

Header

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

Body

Name	Data Type	Description
`BatchGetItemInput`	object	Represents the input of a `BatchGetItem` operation.

Properties

ReturnConsumedCapacity ReturnConsumedCapacity


                        ReturnConsumedCapacity

string
Allowed values:
- INDEXES
- TOTAL
- NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.


                        RequestItems

BatchGetRequestMap

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:
- To access an attribute whose name conflicts with a DynamoDB reserved word.
- To create a placeholder for repeating occurrences of an attribute name in an expression.
- To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
- Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
- {"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
- #P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.
ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

BatchGetRequestMap object
Minimum: 1
Maximum: 100

Properties


                        ExpressionAttributeNames

ExpressionAttributeNameMap

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNameMap object

Extends

AttributeName

Name	Data Type	Description
`AttributeName`	string Maximum: 65535


                        ProjectionExpression

ProjectionExpression

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ProjectionExpression string


                        ConsistentRead

ConsistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

ConsistentRead boolean


                        AttributesToGet

AttributeNameList

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

AttributeNameList array [AttributeName]
Maximum: 65535


                        Keys

KeyList

The primary key attribute values that define the items and the attributes associated with the items.

KeyList array [Key]

Extends

KeysAndAttributes

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

Properties

Name Data Type Description


                        ExpressionAttributeNames

ExpressionAttributeNameMap

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNameMap object

Extends


                        ProjectionExpression

ProjectionExpression

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ProjectionExpression string


                        ConsistentRead

ConsistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

ConsistentRead boolean


                        AttributesToGet

AttributeNameList

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

AttributeNameList array [AttributeName]
Maximum: 65535

AttributeName string
Maximum: 65535


                        Keys

KeyList

The primary key attribute values that define the items and the attributes associated with the items.

KeyList array [Key]

Key object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

Responses

200Success

Body

Name	Data Type	Description
`BatchGetItemOutput`	object	Represents the output of a `BatchGetItem` operation.

Properties


                        ConsumedCapacity

ConsumedCapacityMultiple

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.

ConsumedCapacityMultiple array [ConsumedCapacity]


                        ConsumedCapacity

object

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Properties

`GlobalSecondaryIndexes`	SecondaryIndexesCapacityMap	The amount of throughput consumed on each global index affected by the operation.
`LocalSecondaryIndexes`	SecondaryIndexesCapacityMap	The amount of throughput consumed on each local index affected by the operation.
`Table`	Capacity	The amount of throughput consumed on the table affected by the operation.
`WriteCapacityUnits`	ConsumedCapacityUnits	The total number of write capacity units consumed by the operation.
`ReadCapacityUnits`	ConsumedCapacityUnits	The total number of read capacity units consumed by the operation.
`CapacityUnits`	ConsumedCapacityUnits	The total number of capacity units consumed by the operation.
`TableName`	TableName	The name of the table that was affected by the operation.


                        UnprocessedKeys

BatchGetRequestMap

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

Keys - An array of primary key attribute values that define specific items in the table.
ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

BatchGetRequestMap object
Minimum: 1
Maximum: 100

Properties


                        ExpressionAttributeNames

ExpressionAttributeNameMap

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNameMap object

Extends

AttributeName

Name	Data Type	Description
`AttributeName`	string Maximum: 65535


                        ProjectionExpression

ProjectionExpression

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ProjectionExpression string


                        ConsistentRead

ConsistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

ConsistentRead boolean


                        AttributesToGet

AttributeNameList

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

AttributeNameList array [AttributeName]
Maximum: 65535


                        Keys

KeyList

The primary key attribute values that define the items and the attributes associated with the items.

KeyList array [Key]

Extends

KeysAndAttributes

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

Properties

Name Data Type Description


                        ExpressionAttributeNames

ExpressionAttributeNameMap

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNameMap object

Extends


                        ProjectionExpression

ProjectionExpression

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ProjectionExpression string


                        ConsistentRead

ConsistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

ConsistentRead boolean


                        AttributesToGet

AttributeNameList

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

AttributeNameList array [AttributeName]
Maximum: 65535

AttributeName string
Maximum: 65535


                        Keys

KeyList

The primary key attribute values that define the items and the attributes associated with the items.

KeyList array [Key]

Key object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends


                        Responses

BatchGetResponseMap

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

BatchGetResponseMap object

Extends

ItemList

Name Data Type Description

ItemList array [AttributeMap]

AttributeMap object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

Examples

{
    "Responses": {
        "Music": [
            {
                "AlbumTitle": {
                    "S": "Somewhat Famous"
                }
            },
            {
                "AlbumTitle": {
                    "S": "Blue Sky Blues"
                }
            },
            {
                "AlbumTitle": {
                    "S": "Louder Than Ever"
                }
            }
        ]
    }
}

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_20120810.BatchWriteItem

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.

Request

Header

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

Body

Name	Data Type	Description
`BatchWriteItemInput`	object	Represents the input of a `BatchWriteItem` operation.

Properties


                        ReturnItemCollectionMetrics

ReturnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

ReturnItemCollectionMetrics string
Allowed values:
- SIZE
- NONE

ReturnConsumedCapacity ReturnConsumedCapacity


                        ReturnConsumedCapacity

string
Allowed values:
- INDEXES
- TOTAL
- NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.


                        RequestItems

BatchWriteItemRequestMap

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
- Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
- Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.
  
  If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

BatchWriteItemRequestMap object
Minimum: 1
Maximum: 25

Extends

WriteRequests

Name Data Type Description

WriteRequests array [WriteRequest]


                        WriteRequest

object

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you need to provide two separate WriteRequest objects.

Properties


                        DeleteRequest

DeleteRequest

A request to perform a DeleteItem operation.


                        DeleteRequest

object

Represents a request to perform a DeleteItem operation on an item.

Properties

Key

Key

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Key object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends


                        PutRequest

PutRequest

A request to perform a PutItem operation.


                        PutRequest

object

Represents a request to perform a PutItem operation on an item.

Properties


                        Item

PutItemInputAttributeMap

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

PutItemInputAttributeMap object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

Responses

200Success

Body

Name	Data Type	Description
`BatchWriteItemOutput`	object	Represents the output of a `BatchWriteItem` operation.

Properties


                        ConsumedCapacity

ConsumedCapacityMultiple

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.

ConsumedCapacityMultiple array [ConsumedCapacity]


                        ConsumedCapacity

object

Properties

`GlobalSecondaryIndexes`	SecondaryIndexesCapacityMap	The amount of throughput consumed on each global index affected by the operation.
`LocalSecondaryIndexes`	SecondaryIndexesCapacityMap	The amount of throughput consumed on each local index affected by the operation.
`Table`	Capacity	The amount of throughput consumed on the table affected by the operation.
`WriteCapacityUnits`	ConsumedCapacityUnits	The total number of write capacity units consumed by the operation.
`ReadCapacityUnits`	ConsumedCapacityUnits	The total number of read capacity units consumed by the operation.
`CapacityUnits`	ConsumedCapacityUnits	The total number of capacity units consumed by the operation.
`TableName`	TableName	The name of the table that was affected by the operation.


                        ItemCollectionMetrics

ItemCollectionMetricsPerTable

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.
SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

ItemCollectionMetricsPerTable object

Extends

ItemCollectionMetricsMultiple

Name Data Type Description

ItemCollectionMetricsMultiple array [ItemCollectionMetrics]


                        ItemCollectionMetrics

object

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

Properties


                        SizeEstimateRangeGB

ItemCollectionSizeEstimateRange

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

ItemCollectionSizeEstimateRange array [ItemCollectionSizeEstimateBound]

ItemCollectionSizeEstimateBound double


                        ItemCollectionKey

ItemCollectionKeyAttributeMap

The partition key value of the item collection. This value is the same as the partition key value of the item.

ItemCollectionKeyAttributeMap object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends


                        UnprocessedItems

BatchWriteItemRequestMap

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
- Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
- Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
  
  If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

BatchWriteItemRequestMap object
Minimum: 1
Maximum: 25

Extends

WriteRequests

Name Data Type Description

WriteRequests array [WriteRequest]


                        WriteRequest

object

Properties


                        DeleteRequest

DeleteRequest

A request to perform a DeleteItem operation.


                        DeleteRequest

object

Represents a request to perform a DeleteItem operation on an item.

Properties

Key

Key

Key object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends


                        PutRequest

PutRequest

A request to perform a PutItem operation.


                        PutRequest

object

Represents a request to perform a PutItem operation on an item.

Properties


                        Item

PutItemInputAttributeMap

PutItemInputAttributeMap object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

480ProvisionedThroughputExceededException

Body

Name	Data Type	Description
`ProvisionedThroughputExceededException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

482ItemCollectionSizeLimitExceededException

Body

Name	Data Type	Description
`ItemCollectionSizeLimitExceededException`

483RequestLimitExceeded

Body

Name	Data Type	Description
`RequestLimitExceeded`

484InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20120810.CreateBackup

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Streams
Provisioned read and write capacity

Request

Header

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

Body

Name	Data Type	Description
`CreateBackupInput`	object

Properties


                        BackupName

BackupName

Specified name for the backup.

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


                        TableName

TableName

The name of the table.

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

Responses

200Success

Body

Name	Data Type	Description
`CreateBackupOutput`	object

Properties


                        BackupDetails

BackupDetails

Contains the details of the backup created for the table.


                        BackupDetails

object

Contains the details of the backup created for the table.

Properties


                        BackupExpiryDateTime

Date

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

Date dateTime


                        BackupCreationDateTime

BackupCreationDateTime

Time at which the backup was created. This is the request time of the backup.

BackupCreationDateTime dateTime


                        BackupType

BackupType

BackupType:

USER - You create and manage these using the on-demand backup feature.
SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
AWS_BACKUP - On-demand backup created by you from AWS Backup service.

BackupType string
Allowed values:
- USER
- SYSTEM
- AWS_BACKUP


                        BackupStatus

BackupStatus

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

BackupStatus string
Allowed values:
- CREATING
- DELETED
- AVAILABLE


                        BackupSizeBytes

BackupSizeBytes

Size of the backup in bytes.

BackupSizeBytes integer
Minimum: 0


                        BackupName

BackupName

Name of the requested backup.

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


                        BackupArn

BackupArn

ARN associated with the backup.

BackupArn string
Minimum: 37
Maximum: 1024

480TableNotFoundException

Body

Name	Data Type	Description
`TableNotFoundException`

481TableInUseException

Body

Name	Data Type	Description
`TableInUseException`

482ContinuousBackupsUnavailableException

Body

Name	Data Type	Description
`ContinuousBackupsUnavailableException`

483BackupInUseException

Body

Name	Data Type	Description
`BackupInUseException`

484LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

485InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20120810.CreateGlobalTable

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

This method only applies to Version 2017.11.29 of global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Request

Header

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

Body

Name	Data Type	Description
`CreateGlobalTableInput`	object

Properties


                        ReplicationGroup

ReplicaList

The Regions where the global table needs to be created.

ReplicaList array [Replica]


                        Replica

object

Represents the properties of a replica.

Properties


                        RegionName

RegionName

The Region where the replica needs to be created.


                        GlobalTableName

TableName

The global table name.

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

Responses

200Success

Body

Name	Data Type	Description
`CreateGlobalTableOutput`	object

Properties


                        GlobalTableDescription

GlobalTableDescription

Contains the details of the global table.


                        GlobalTableDescription

object

Contains details about the global table.

Properties


                        GlobalTableName

TableName

The global table name.

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


                        GlobalTableStatus

GlobalTableStatus

The current state of the global table:

CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.

GlobalTableStatus string
Allowed values:
- CREATING
- ACTIVE
- DELETING
- UPDATING


                        CreationDateTime

Date

The creation time of the global table.

Date dateTime


                        GlobalTableArn

GlobalTableArnString

The unique identifier of the global table.

GlobalTableArnString string


                        ReplicationGroup

ReplicaDescriptionList

The Regions where the global table has replicas.

ReplicaDescriptionList array [ReplicaDescription]

480LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

481InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

482GlobalTableAlreadyExistsException

Body

Name	Data Type	Description
`GlobalTableAlreadyExistsException`

483TableNotFoundException

Body

Name	Data Type	Description
`TableNotFoundException`

POST

/#X-Amz-Target=DynamoDB_20120810.CreateTable

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

Request

Header

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

Body

Name	Data Type	Description
`CreateTableInput`	object	Represents the input of a `CreateTable` operation.

Properties


                        Tags

TagList

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

TagList array [Tag]

Tag

object

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Properties

`Value`	TagValueString	The value of the tag. Tag values are case-sensitive and can be null.
`Key`	TagKeyString	The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.


                        SSESpecification

SSESpecification

Represents the settings used to enable server-side encryption.


                        SSESpecification

object

Represents the settings used to enable server-side encryption.

Properties


                        KMSMasterKeyId

KMSMasterKeyId

The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb.

KMSMasterKeyId string


                        SSEType

SSEType

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account and is managed by AWS KMS (AWS KMS charges apply).

SSEType string
Allowed values:
- AES256
- KMS


                        Enabled

SSEEnabled

Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

SSEEnabled boolean


                        StreamSpecification

StreamSpecification

The settings for DynamoDB Streams on the table. These settings consist of:

StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
- KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
- NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
- OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
- NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.


                        StreamSpecification

object

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Properties


                        StreamViewType

StreamViewType

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

StreamViewType string
Allowed values:
- NEW_IMAGE
- OLD_IMAGE
- NEW_AND_OLD_IMAGES
- KEYS_ONLY


                        StreamEnabled

StreamEnabled

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

StreamEnabled boolean


                        ProvisionedThroughput

ProvisionedThroughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.


                        ProvisionedThroughput

object

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Properties


                        WriteCapacityUnits

PositiveLongObject

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

PositiveLongObject integer
Minimum: 1


                        ReadCapacityUnits

PositiveLongObject

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

PositiveLongObject integer
Minimum: 1


                        BillingMode

BillingMode

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

BillingMode string
Allowed values:
- PROVISIONED
- PAY_PER_REQUEST


                        GlobalSecondaryIndexes

GlobalSecondaryIndexList

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

GlobalSecondaryIndexList array [GlobalSecondaryIndex]


                        GlobalSecondaryIndex

object

Represents the properties of a global secondary index.

Properties

`ProvisionedThroughput`	ProvisionedThroughput	Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
`Projection`	Projection	Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
`KeySchema`	KeySchema	The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: `HASH` - partition key `RANGE` - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
`IndexName`	IndexName	The name of the global secondary index. The name must be unique among all other indexes on this table.


                        LocalSecondaryIndexes

LocalSecondaryIndexList

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

LocalSecondaryIndexList array [LocalSecondaryIndex]


                        LocalSecondaryIndex

object

Represents the properties of a local secondary index.

Properties

`Projection`	Projection	Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
`KeySchema`	KeySchema	The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: `HASH` - partition key `RANGE` - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
`IndexName`	IndexName	The name of the local secondary index. The name must be unique among all other indexes on this table.


                        KeySchema

KeySchema

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

AttributeName - The name of this key attribute.
KeyType - The role that the key attribute will assume:
- HASH - partition key
- RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

KeySchema array [KeySchemaElement]


                        KeySchemaElement

object

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

Properties

`KeyType`	KeyType	The role that this key attribute will assume: `HASH` - partition key `RANGE` - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
`AttributeName`	KeySchemaAttributeName	The name of a key attribute.


                        TableName

TableName

The name of the table to create.

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


                        AttributeDefinitions

AttributeDefinitions

An array of attributes that describe the key schema for the table and indexes.

AttributeDefinitions array [AttributeDefinition]


                        AttributeDefinition

object

Represents an attribute for describing the key schema for the table and indexes.

Properties

`AttributeType`	ScalarAttributeType	The data type for the attribute, where: `S` - the attribute is of type String `N` - the attribute is of type Number `B` - the attribute is of type Binary
`AttributeName`	KeySchemaAttributeName	A name for the attribute.

Responses

200Success

Body

Name	Data Type	Description
`CreateTableOutput`	object	Represents the output of a `CreateTable` operation.

Properties


                        TableDescription

TableDescription

Represents the properties of the table.


                        TableDescription

object

Represents the properties of a table.

Properties


                        ArchivalSummary

ArchivalSummary

Contains information about the table archive.


                        ArchivalSummary

object

Contains details of a table archival operation.

Properties

`ArchivalBackupArn`	BackupArn	The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
`ArchivalReason`	ArchivalReason	The reason DynamoDB archived the table. Currently, the only possible value is: `INACCESSIBLE_ENCRYPTION_CREDENTIALS` - The table was archived due to the table's AWS KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
`ArchivalDateTime`	Date	The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.


                        SSEDescription

SSEDescription

The description of the server-side encryption status on the specified table.


                        SSEDescription

object

The description of the server-side encryption status on the specified table.

Properties

`InaccessibleEncryptionDateTime`	Date	Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table archival process when table's AWS KMS key remains inaccessible for more than seven days from this date.
`KMSMasterKeyArn`	KMSMasterKeyArn	The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
`SSEType`	SSEType	Server-side encryption type. The only supported value is: `KMS` - Server-side encryption that uses AWS Key Management Service. The key is stored in your account and is managed by AWS KMS (AWS KMS charges apply).
`Status`	SSEStatus	Represents the current state of server-side encryption. The only supported values are: `ENABLED` - Server-side encryption is enabled. `UPDATING` - Server-side encryption is being updated.


                        RestoreSummary

RestoreSummary

Contains details for the restore.


                        RestoreSummary

object

Contains details for the restore.

Properties

`RestoreInProgress`	RestoreInProgress	Indicates if a restore is in progress or not.
`RestoreDateTime`	Date	Point in time or source backup time.
`SourceTableArn`	TableArn	The ARN of the source table of the backup that is being restored.
`SourceBackupArn`	BackupArn	The Amazon Resource Name (ARN) of the backup from which the table was restored.


                        Replicas

ReplicaDescriptionList

Represents replicas of the table.

ReplicaDescriptionList array [ReplicaDescription]


                        GlobalTableVersion

String

Represents the version of global tables in use, if the table is replicated across AWS Regions.

String string


                        LatestStreamArn

StreamArn

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

StreamArn string
Minimum: 37
Maximum: 1024


                        LatestStreamLabel

String

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

AWS customer ID
Table name
StreamLabel

String string


                        StreamSpecification

StreamSpecification

The current DynamoDB Streams configuration for the table.


                        StreamSpecification

object

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Properties

`StreamViewType`	StreamViewType	When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table. Valid values for `StreamViewType` are: `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream. `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream. `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream. `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
`StreamEnabled`	StreamEnabled	Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.


                        GlobalSecondaryIndexes

GlobalSecondaryIndexDescriptionList

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
- CREATING - The index is being created.
- UPDATING - The index is being updated.
- DELETING - The index is being deleted.
- ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

GlobalSecondaryIndexDescriptionList array [GlobalSecondaryIndexDescription]


                        LocalSecondaryIndexes

LocalSecondaryIndexDescriptionList

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

LocalSecondaryIndexDescriptionList array [LocalSecondaryIndexDescription]


                        BillingModeSummary

BillingModeSummary

Contains the details for the read/write capacity mode.


                        BillingModeSummary

object

Contains the details for the read/write capacity mode.

Properties

`LastUpdateToPayPerRequestDateTime`	Date	Represents the time when `PAY_PER_REQUEST` was last set as the read/write capacity mode.
`BillingMode`	BillingMode	Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. `PROVISIONED` - Sets the read/write capacity mode to `PROVISIONED`. We recommend using `PROVISIONED` for predictable workloads. `PAY_PER_REQUEST` - Sets the read/write capacity mode to `PAY_PER_REQUEST`. We recommend using `PAY_PER_REQUEST` for unpredictable workloads.


                        TableId

TableId

Unique identifier for the table for which the backup was created.

TableId string
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}


                        TableArn

String

The Amazon Resource Name (ARN) that uniquely identifies the table.

String string


                        ItemCount

Long

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Long integer


                        TableSizeBytes

Long

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Long integer


                        ProvisionedThroughput

ProvisionedThroughputDescription

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.


                        ProvisionedThroughputDescription

object

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Properties

`WriteCapacityUnits`	NonNegativeLongObject	The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`ReadCapacityUnits`	NonNegativeLongObject	The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 `ReadCapacityUnits` per second provides 100 eventually consistent `ReadCapacityUnits` per second.
`NumberOfDecreasesToday`	PositiveLongObject	The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
`LastDecreaseDateTime`	Date	The date and time of the last provisioned throughput decrease for this table.
`LastIncreaseDateTime`	Date	The date and time of the last provisioned throughput increase for this table.


                        CreationDateTime

Date

The date and time when the table was created, in UNIX epoch time format.

Date dateTime


                        TableStatus

TableStatus

The current state of the table:

CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED - The table has been archived. See the ArchivalReason for more information.

TableStatus string
Allowed values:
- CREATING
- UPDATING
- DELETING
- ACTIVE
- INACCESSIBLE_ENCRYPTION_CREDENTIALS
- ARCHIVING
- ARCHIVED


                        KeySchema

KeySchema

The primary key structure for the table. Each KeySchemaElement consists of:

AttributeName - The name of the attribute.
KeyType - The role of the attribute:
- HASH - partition key
- RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

KeySchema array [KeySchemaElement]


                        TableName

TableName

The name of the table.

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


                        AttributeDefinitions

AttributeDefinitions

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.

AttributeDefinitions array [AttributeDefinition]

Examples

{
    "TableDescription": {
        "AttributeDefinitions": [
            {
                "AttributeName": "Artist",
                "AttributeType": "S"
            },
            {
                "AttributeName": "SongTitle",
                "AttributeType": "S"
            }
        ],
        "CreationDateTime": "1421866952.062",
        "ItemCount": 0,
        "KeySchema": [
            {
                "AttributeName": "Artist",
                "KeyType": "HASH"
            },
            {
                "AttributeName": "SongTitle",
                "KeyType": "RANGE"
            }
        ],
        "ProvisionedThroughput": {
            "ReadCapacityUnits": 5,
            "WriteCapacityUnits": 5
        },
        "TableName": "Music",
        "TableSizeBytes": 0,
        "TableStatus": "CREATING"
    }
}

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_20120810.DeleteBackup

Deletes an existing backup of a table.

You can call DeleteBackup at a maximum rate of 10 times per second.

Request

Header

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

Body

Name	Data Type	Description
`DeleteBackupInput`	object

Properties


                        BackupArn

BackupArn

The ARN associated with the backup.

BackupArn string
Minimum: 37
Maximum: 1024

Responses

200Success

Body

Name	Data Type	Description
`DeleteBackupOutput`	object

Properties


                        BackupDescription

BackupDescription

Contains the description of the backup created for the table.


                        BackupDescription

object

Contains the description of the backup created for the table.

Properties


                        SourceTableFeatureDetails

SourceTableFeatureDetails

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.


                        SourceTableFeatureDetails

object

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

Properties

`SSEDescription`	SSEDescription	The description of the server-side encryption status on the table when the backup was created.
`TimeToLiveDescription`	TimeToLiveDescription	Time to Live settings on the table when the backup was created.
`StreamDescription`	StreamSpecification	Stream settings on the table when the backup was created.
`GlobalSecondaryIndexes`	GlobalSecondaryIndexes	Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.
`LocalSecondaryIndexes`	LocalSecondaryIndexes	Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.


                        SourceTableDetails

SourceTableDetails

Contains the details of the table when the backup was created.


                        SourceTableDetails

object

Contains the details of the table when the backup was created.

Properties

`BillingMode`	BillingMode	Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. `PROVISIONED` - Sets the read/write capacity mode to `PROVISIONED`. We recommend using `PROVISIONED` for predictable workloads. `PAY_PER_REQUEST` - Sets the read/write capacity mode to `PAY_PER_REQUEST`. We recommend using `PAY_PER_REQUEST` for unpredictable workloads.
`ItemCount`	ItemCount	Number of items in the table. Note that this is an approximate value.
`ProvisionedThroughput`	ProvisionedThroughput	Read IOPs and Write IOPS on the table when the backup was created.
`TableCreationDateTime`	TableCreationDateTime	Time when the source table was created.
`KeySchema`	KeySchema	Schema of the table.
`TableSizeBytes`	Long	Size of the table in bytes. Note that this is an approximate value.
`TableArn`	TableArn	ARN of the table for which backup was created.
`TableId`	TableId	Unique identifier for the table for which the backup was created.
`TableName`	TableName	The name of the table for which the backup was created.


                        BackupDetails

BackupDetails

Contains the details of the backup created for the table.


                        BackupDetails

object

Contains the details of the backup created for the table.

Properties

`BackupExpiryDateTime`	Date	Time at which the automatic on-demand backup created by DynamoDB will expire. This `SYSTEM` on-demand backup expires automatically 35 days after its creation.
`BackupCreationDateTime`	BackupCreationDateTime	Time at which the backup was created. This is the request time of the backup.
`BackupType`	BackupType	BackupType: `USER` - You create and manage these using the on-demand backup feature. `SYSTEM` - If you delete a table with point-in-time recovery enabled, a `SYSTEM` backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. `AWS_BACKUP` - On-demand backup created by you from AWS Backup service.
`BackupStatus`	BackupStatus	Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
`BackupSizeBytes`	BackupSizeBytes	Size of the backup in bytes.
`BackupName`	BackupName	Name of the requested backup.
`BackupArn`	BackupArn	ARN associated with the backup.

480BackupNotFoundException

Body

Name	Data Type	Description
`BackupNotFoundException`

481BackupInUseException

Body

Name	Data Type	Description
`BackupInUseException`

482LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

483InternalServerError

Body

Name	Data Type	Description
`InternalServerError`

POST

/#X-Amz-Target=DynamoDB_20120810.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.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Request

Header

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

Body

Name	Data Type	Description
`DeleteItemInput`	object	Represents the input of a `DeleteItem` operation.

Properties


                        ExpressionAttributeValues

ExpressionAttributeValueMap

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValueMap object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

AttributeValue

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

Name Data Type Description


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

AttributeValue

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

Name Data Type Description


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string


                        ExpressionAttributeNames

ExpressionAttributeNameMap

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNameMap object

Extends

AttributeName

Name	Data Type	Description
`AttributeName`	string Maximum: 65535


                        ConditionExpression

ConditionExpression

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

ConditionExpression string


                        ReturnItemCollectionMetrics

ReturnItemCollectionMetrics

ReturnItemCollectionMetrics string
Allowed values:
- SIZE
- NONE

ReturnConsumedCapacity ReturnConsumedCapacity


                        ReturnConsumedCapacity

string
Allowed values:
- INDEXES
- TOTAL
- NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.


                        ReturnValues

ReturnValue

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

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


                        ConditionalOperator

ConditionalOperator

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

ConditionalOperator string
Allowed values:
- AND
- OR


                        Expected

ExpectedAttributeMap

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

ExpectedAttributeMap object

Properties


                        AttributeValueList

AttributeValueList

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

AttributeValueList array [AttributeValue]


                        ComparisonOperator

ComparisonOperator

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

EQ : Equal. EQ is supported for all data types, including lists and maps.

AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.

AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.

AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.

AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements in a list.

AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

ComparisonOperator string
Allowed values:
- EQ
- NE
- IN
- LE
- LT
- GE
- GT
- BETWEEN
- NOT_NULL
- NULL
- CONTAINS
- NOT_CONTAINS
- BEGINS_WITH


                        Exists

BooleanObject

Causes DynamoDB to evaluate the value before attempting a conditional operation:

If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

BooleanObject boolean


                        Value

AttributeValue

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

ExpectedAttributeValue

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.
Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

Properties

Name Data Type Description


                        AttributeValueList

AttributeValueList

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

AttributeValueList array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string


                        ComparisonOperator

ComparisonOperator

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

EQ : Equal. EQ is supported for all data types, including lists and maps.

AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.

AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.

AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.

AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements in a list.

AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

ComparisonOperator string
Allowed values:
- EQ
- NE
- IN
- LE
- LT
- GE
- GT
- BETWEEN
- NOT_NULL
- NULL
- CONTAINS
- NOT_CONTAINS
- BEGINS_WITH


                        Exists

BooleanObject

Causes DynamoDB to evaluate the value before attempting a conditional operation:

If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

BooleanObject boolean


                        Value

AttributeValue

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Key

Key

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Key object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

AttributeValue

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

Name Data Type Description


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

NumberAttributeValue string

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

StringAttributeValue string

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

AttributeValue

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

Name Data Type Description


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]


                        AttributeValue

object

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties


                        BOOL

BooleanAttributeValue

An attribute of type Boolean. For example:

"BOOL": true

BooleanAttributeValue boolean


                        NULL

NullAttributeValue

An attribute of type Null. For example:

"NULL": true

NullAttributeValue boolean

ListAttributeValue

An attribute of type List. For example:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

ListAttributeValue array [AttributeValue]

MapAttributeValue

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

MapAttributeValue object

Properties

`BOOL`	BooleanAttributeValue	An attribute of type Boolean. For example: `"BOOL": true`
`NULL`	NullAttributeValue	An attribute of type Null. For example: `"NULL": true`
`L`	ListAttributeValue	An attribute of type List. For example: `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]`
`M`	MapAttributeValue	An attribute of type Map. For example: `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}`
`BS`	BinarySetAttributeValue	An attribute of type Binary Set. For example: `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]`
`NS`	NumberSetAttributeValue	An attribute of type Number Set. For example: `"NS": ["42.2", "-19", "7.5", "3.14"]` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`SS`	StringSetAttributeValue	An attribute of type String Set. For example: `"SS": ["Giraffe", "Hippo" ,"Zebra"]`
`B`	BinaryAttributeValue	An attribute of type Binary. For example: `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"`
`N`	NumberAttributeValue	An attribute of type Number. For example: `"N": "123.45"` Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
`S`	StringAttributeValue	An attribute of type String. For example: `"S": "Hello"`

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

NS

NumberSetAttributeValue

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

NumberSetAttributeValue array [NumberAttributeValue]

SS

StringSetAttributeValue

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

StringSetAttributeValue array [StringAttributeValue]

BinaryAttributeValue

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

BinaryAttributeValue string

NumberAttributeValue

An attribute of type Number. For example:

"N": "123.45"

NumberAttributeValue string

StringAttributeValue

An attribute of type String. For example:

"S": "Hello"

StringAttributeValue string

Extends

BS

BinarySetAttributeValue

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

BinarySetAttributeValue array [BinaryAttributeValue]

BinaryAttributeValue string