dynamodb/aws.sdk.kotlin.services.dynamodb.model/AttributeValue

AttributeValue

sealed class 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.

Inheritors

Bool

Null

SdkUnknown

Types

data class B(val value: ByteArray) : AttributeValue

An attribute of type Binary. For example:

Bool

data class Bool(val value: Boolean) : AttributeValue

An attribute of type Boolean. For example:

data class Bs(val value: List<ByteArray>) : AttributeValue

An attribute of type Binary Set. For example:

data class L(val value: List<AttributeValue>) : AttributeValue

An attribute of type List. For example:

data class M(val value: Map<String, AttributeValue>) : AttributeValue

An attribute of type Map. For example:

data class N(val value: String) : AttributeValue

An attribute of type Number. For example:

data class Ns(val value: List<String>) : AttributeValue

An attribute of type Number Set. For example:

Null

data class Null(val value: Boolean) : AttributeValue

An attribute of type Null. For example:

data class S(val value: String) : AttributeValue

An attribute of type String. For example:

SdkUnknown

object SdkUnknown : AttributeValue

data class Ss(val value: List<String>) : AttributeValue

An attribute of type String Set. For example:

Functions

asB

fun asB(): ByteArray

Casts this AttributeValue as a B and retrieves its kotlin.ByteArray value. Throws an exception if the AttributeValue is not a B.

asBool

fun asBool(): Boolean

Casts this AttributeValue as a Bool and retrieves its kotlin.Boolean value. Throws an exception if the AttributeValue is not a Bool.

asBoolOrNull

fun asBoolOrNull(): Boolean?

Casts this AttributeValue as a Bool and retrieves its kotlin.Boolean value. Returns null if the AttributeValue is not a Bool.

asBOrNull

fun asBOrNull(): ByteArray?

Casts this AttributeValue as a B and retrieves its kotlin.ByteArray value. Returns null if the AttributeValue is not a B.

asBs

fun asBs(): List<ByteArray>

Casts this AttributeValue as a Bs and retrieves its kotlin.collections.List value. Throws an exception if the AttributeValue is not a Bs.

asBsOrNull

fun asBsOrNull(): List<ByteArray>?

Casts this AttributeValue as a Bs and retrieves its kotlin.collections.List value. Returns null if the AttributeValue is not a Bs.

asL

fun asL(): List<AttributeValue>

Casts this AttributeValue as a L and retrieves its kotlin.collections.List value. Throws an exception if the AttributeValue is not a L.

asLOrNull

fun asLOrNull(): List<AttributeValue>?

Casts this AttributeValue as a L and retrieves its kotlin.collections.List value. Returns null if the AttributeValue is not a L.

asM

fun asM(): Map<String, AttributeValue>

Casts this AttributeValue as a M and retrieves its kotlin.collections.Map value. Throws an exception if the AttributeValue is not a M.

asMOrNull

fun asMOrNull(): Map<String, AttributeValue>?

Casts this AttributeValue as a M and retrieves its kotlin.collections.Map value. Returns null if the AttributeValue is not a M.

asN

fun asN(): String

Casts this AttributeValue as a N and retrieves its kotlin.String value. Throws an exception if the AttributeValue is not a N.

asNOrNull

fun asNOrNull(): String?

Casts this AttributeValue as a N and retrieves its kotlin.String value. Returns null if the AttributeValue is not a N.

asNs

fun asNs(): List<String>

Casts this AttributeValue as a Ns and retrieves its kotlin.collections.List value. Throws an exception if the AttributeValue is not a Ns.

asNsOrNull

fun asNsOrNull(): List<String>?

Casts this AttributeValue as a Ns and retrieves its kotlin.collections.List value. Returns null if the AttributeValue is not a Ns.

asNull

fun asNull(): Boolean

Casts this AttributeValue as a Null and retrieves its kotlin.Boolean value. Throws an exception if the AttributeValue is not a Null.

asNullOrNull

fun asNullOrNull(): Boolean?

Casts this AttributeValue as a Null and retrieves its kotlin.Boolean value. Returns null if the AttributeValue is not a Null.

asS

fun asS(): String

Casts this AttributeValue as a S and retrieves its kotlin.String value. Throws an exception if the AttributeValue is not a S.

asSOrNull

fun asSOrNull(): String?

Casts this AttributeValue as a S and retrieves its kotlin.String value. Returns null if the AttributeValue is not a S.

asSs

fun asSs(): List<String>

Casts this AttributeValue as a Ss and retrieves its kotlin.collections.List value. Throws an exception if the AttributeValue is not a Ss.

asSsOrNull

fun asSsOrNull(): List<String>?

Casts this AttributeValue as a Ss and retrieves its kotlin.collections.List value. Returns null if the AttributeValue is not a Ss.