You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DynamoDB::Types::AttributeValue

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass AttributeValue data as a hash:

{
  s: "StringAttributeValue",
  n: "NumberAttributeValue",
  b: "data",
  ss: ["StringAttributeValue"],
  ns: ["NumberAttributeValue"],
  bs: ["data"],
  m: {
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  l: ["value"], # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  null: false,
  bool: false,
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#bString

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Returns:

  • (String)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#boolBoolean

An attribute of type Boolean. For example:

"BOOL": true

Returns:

  • (Boolean)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#bsArray<String>

An attribute of type Binary Set. For example:

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

Returns:

  • (Array<String>)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#lArray<Types::AttributeValue>

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#mHash<String,Types::AttributeValue>

An attribute of type Map. For example:

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

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#nString

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.

Returns:

  • (String)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#nsArray<String>

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.

Returns:

  • (Array<String>)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#nullBoolean

An attribute of type Null. For example:

"NULL": true

Returns:

  • (Boolean)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#sString

An attribute of type String. For example:

"S": "Hello"

Returns:

  • (String)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end

#ssArray<String>

An attribute of type String Set. For example:

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

Returns:

  • (Array<String>)


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 146

class AttributeValue < Struct.new(
  :s,
  :n,
  :b,
  :ss,
  :ns,
  :bs,
  :m,
  :l,
  :null,
  :bool)
  include Aws::Structure
end