Skip to content

DynamoDB  >  Unions  >  AttributeValue

AttributeValue

Union Type

AttributeValue module-attribute 

AttributeValue = Union[AttributeValueS | AttributeValueN | AttributeValueB | AttributeValueSS | AttributeValueNS | AttributeValueBS | AttributeValueM | AttributeValueL | AttributeValueNULL | AttributeValueBOOL | AttributeValueUnknown]

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.

Union Member Types

AttributeValueS dataclass

An attribute of type String. For example:

"S": "Hello"

Attributes

value instance-attribute 
value: str

AttributeValueN dataclass

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.

Attributes

value instance-attribute 
value: str

AttributeValueB dataclass

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Attributes

value instance-attribute 
value: bytes

AttributeValueSS dataclass

An attribute of type String Set. For example:

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

Attributes

value instance-attribute 
value: list[str]

AttributeValueNS dataclass

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.

Attributes

value instance-attribute 
value: list[str]

AttributeValueBS dataclass

An attribute of type Binary Set. For example:

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

Attributes

value instance-attribute 
value: list[bytes]

AttributeValueM dataclass

An attribute of type Map. For example:

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

Attributes

value instance-attribute 
value: dict[str, AttributeValue]

AttributeValueL dataclass

An attribute of type List. For example:

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

Attributes

value instance-attribute 
value: list[AttributeValue]

AttributeValueNULL dataclass

An attribute of type Null. For example:

"NULL": true

Attributes

value instance-attribute 
value: bool

AttributeValueBOOL dataclass

An attribute of type Boolean. For example:

"BOOL": true

Attributes

value instance-attribute 
value: bool

AttributeValueUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute 
tag: str