http4k-connect-amazon-dynamodb/org.http4k.connect.amazon.dynamodb.model

Package-level declarations

Types

@JsonSerializable

data class ArchivalSummary(val ArchivalBackupArn: ARN? = null, val ArchivalDateTime: Timestamp? = null, val ArchivalReason: String? = null)

Attribute

class Attribute<FINAL>(val dataType: DynamoDataType, meta: Meta, get: (Item) -> FINAL, lensSet: (FINAL, Item) -> Item, ignoreNull: Boolean = false) : LensInjector<FINAL, Item> , Lens<Item, FINAL>

Constructs typesafe Lenses for the various Item/Key attributes. The lenses can be used to inject values with Item(attr of "123") or extract with attr(item).

AttributeDefinition

@JsonSerializable

data class AttributeDefinition(val AttributeName: AttributeName, val AttributeType: DynamoDataType)

AttributeName

class AttributeName : AbstractValue<String> , Comparable<AttributeName>

AttributeValue

@JsonSerializable

data class AttributeValue : Comparable<AttributeValue>

Represents the on-the-wire format of an Attribute Value with it's requisite type. Only one of these fields is ever populated at once in an entry. So you can get { "S": "hello" } or { "BOOL": true } or { "NS": "123" }

BatchItemFailure

@JsonSerializable

data class BatchItemFailure(val itemIdentifier: String)

BatchStatementError

@JsonSerializable

data class BatchStatementError(val Code: ErrorCode? = null, val Message: String? = null)

BillingMode

@JsonSerializable

enum BillingMode : Enum<BillingMode>

BillingModeSummary

@JsonSerializable

data class BillingModeSummary(val BillingMode: BillingMode? = null, val LastUpdateToPayPerRequestDateTime: Timestamp? = null)

Capacity

@JsonSerializable

data class Capacity(val CapacityUnits: Long? = null, val ReadCapacityUnits: Long? = null, val WriteCapacityUnits: Long? = null)

ClientToken

class ClientToken : AbstractComparableValue<ClientToken, String>

ConsumedCapacity

@JsonSerializable

data class ConsumedCapacity(val TableName: TableName? = null, val CapacityUnits: Double? = null, val GlobalSecondaryIndexes: Map<String, Capacity>? = null, val LocalSecondaryIndexes: Map<String, Capacity>? = null, val ReadCapacityUnits: Double? = null, val Table: Capacity? = null, val WriteCapacityUnits: Double? = null)

CsvOptions

@JsonSerializable

data class CsvOptions(val Delimiter: Char? = null, val HeaderList: List<String>? = null)

DynamoDataType

@JsonSerializable

enum DynamoDataType : Enum<DynamoDataType>

ErrorCode

@JsonSerializable

enum ErrorCode : Enum<ErrorCode>

Get

@JsonSerializable

data class Get(val TableName: TableName, val Key: Key, val ProjectionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null)

GetItemsResponseItem

@JsonSerializable

data class GetItemsResponseItem(val Item: ItemResult? = null)

GlobalSecondaryIndex

@JsonSerializable

data class GlobalSecondaryIndex(val IndexName: IndexName, val KeySchema: List<KeySchema>, val Projection: Projection, val ProvisionedThroughput: ProvisionedThroughput? = null)

GlobalSecondaryIndexCreate

@JsonSerializable

data class GlobalSecondaryIndexCreate(val IndexName: IndexName? = null, val KeySchema: List<KeySchema>? = null, val Projection: Projection? = null, val ProvisionedThroughput: ProvisionedThroughput? = null)

GlobalSecondaryIndexDelete

@JsonSerializable

data class GlobalSecondaryIndexDelete(val IndexName: IndexName? = null)

GlobalSecondaryIndexesUpdate

@JsonSerializable

data class GlobalSecondaryIndexesUpdate(val IndexName: IndexName? = null, val ProvisionedThroughputOverride: ProvisionedThroughputOverride? = null)

GlobalSecondaryIndexReplica

@JsonSerializable

data class GlobalSecondaryIndexReplica(val IndexName: IndexName? = null, val ProvisionedThroughputOverride: ProvisionedThroughputOverride? = null)

GlobalSecondaryIndexResponse

@JsonSerializable

data class GlobalSecondaryIndexResponse(val Backfilling: Boolean? = null, val IndexArn: ARN? = null, val IndexName: String? = null, val IndexSizeBytes: Long? = null, val IndexStatus: IndexStatus? = null, val ItemCount: Long? = null, val KeySchema: List<KeySchema>? = null, val Projection: Projection? = null, val ProvisionedThroughput: ProvisionedThroughputResponse? = null)

GlobalSecondaryIndexUpdate

@JsonSerializable

data class GlobalSecondaryIndexUpdate(val IndexName: IndexName? = null, val ProvisionedThroughput: ProvisionedThroughput? = null)

GlobalSecondaryIndexUpdates

@JsonSerializable

data class GlobalSecondaryIndexUpdates(val Create: GlobalSecondaryIndexCreate? = null, val Delete: GlobalSecondaryIndexDelete? = null, val Update: GlobalSecondaryIndexUpdate? = null)

ImportStatus

@JsonSerializable

enum ImportStatus : Enum<ImportStatus>

ImportSummary

@JsonSerializable

data class ImportSummary(val CloudWatchLogGroupArn: ARN? = null, val EndTime: Timestamp? = null, val ImportArn: ARN? = null, val ImportStatus: ImportStatus? = null, val InputFormat: InputFormat? = null, val S3BucketSource: S3BucketSource? = null, val StartTime: Timestamp? = null, val TableArn: ARN? = null)

ImportTableDescription

@JsonSerializable

data class ImportTableDescription(val ClientToken: ClientToken? = null, val CloudWatchLogGroupArn: ARN? = null, val EndTime: Timestamp? = null, val ErrorCount: Long? = null, val FailureCode: String? = null, val FailureMessage: String? = null, val ImportArn: ARN? = null, val ImportedItemCount: Long? = null, val ImportStatus: ImportStatus? = null, val InputCompressionType: InputCompressionType? = null, val InputFormat: InputFormat? = null, val InputFormatOptions: InputFormatOptions? = null, val ProcessedItemCount: Long? = null, val ProcessedSizeBytes: Long? = null, val S3BucketSource: S3BucketSource? = null, val StartTime: Timestamp? = null, val TableArn: ARN? = null, val TableCreationParameters: TableCreationParameters? = null, val TableId: String? = null)

IndexName

class IndexName : AbstractValue<String>

IndexStatus

@JsonSerializable

enum IndexStatus : Enum<IndexStatus>

InputCompressionType

@JsonSerializable

enum InputCompressionType : Enum<InputCompressionType>

InputFormat

@JsonSerializable

enum InputFormat : Enum<InputFormat>

InputFormatOptions

@JsonSerializable

data class InputFormatOptions(val Csv: CsvOptions?)

Item

typealias Item = Map<AttributeName, AttributeValue>

ItemCollectionMetrics

@JsonSerializable

data class ItemCollectionMetrics(val ItemCollectionKey: Key? = null, val SizeEstimateRangeGB: List<Long>? = null)

ItemResult

typealias ItemResult = Map<String, Map<String, Any>>

Key

typealias Key = Item

KeySchema

@JsonSerializable

data class KeySchema(val AttributeName: AttributeName, val KeyType: KeyType)

KeyType

@JsonSerializable

enum KeyType : Enum<KeyType>

LocalSecondaryIndex

@JsonSerializable

data class LocalSecondaryIndex(val IndexName: IndexName, val KeySchema: List<KeySchema>, val Projection: Projection)

LocalSecondaryIndexResponse

@JsonSerializable

data class LocalSecondaryIndexResponse(val IndexArn: ARN? = null, val IndexName: String? = null, val IndexSizeBytes: Long? = null, val ItemCount: Long? = null, val KeySchema: List<KeySchema>? = null, val Projection: Projection? = null)

NextToken

class NextToken : AbstractComparableValue<NextToken, String>

ParameterizedStatement

@JsonSerializable

data class ParameterizedStatement(val Statement: String, val parameters: List<AttributeValue>? = null)

Projection

@JsonSerializable

data class Projection(val NonKeyAttributes: List<AttributeName>? = null, val ProjectionType: ProjectionType? = null)

ProjectionType

@JsonSerializable

enum ProjectionType : Enum<ProjectionType>

ProvisionedThroughput

@JsonSerializable

data class ProvisionedThroughput(val ReadCapacityUnits: Long, val WriteCapacityUnits: Long)

ProvisionedThroughputOverride

@JsonSerializable

data class ProvisionedThroughputOverride(val ReadCapacityUnits: Long? = null)

ProvisionedThroughputResponse

@JsonSerializable

data class ProvisionedThroughputResponse(val LastDecreaseDateTime: Timestamp? = null, val LastIncreaseDateTime: Timestamp? = null, val NumberOfDecreasesToday: Long? = null, val ReadCapacityUnits: Long? = null, val WriteCapacityUnits: Long? = null)

Replica

@JsonSerializable

data class Replica(val GlobalSecondaryIndexes: List<GlobalSecondaryIndexReplica>? = null, val KMSMasterKeyId: KMSKeyId? = null, val ProvisionedThroughputOverride: ProvisionedThroughputOverride? = null, val RegionName: String? = null, val ReplicaInaccessibleDateTime: Timestamp? = null, val ReplicaStatus: ReplicaStatus? = null, val ReplicaStatusDescription: String? = null, val ReplicaStatusPercentProgress: String? = null)

ReplicaCreate

@JsonSerializable

data class ReplicaCreate(val GlobalSecondaryIndexes: List<GlobalSecondaryIndexesUpdate>? = null, val KMSMasterKeyId: KMSKeyId? = null, val ProvisionedThroughputOverride: ProvisionedThroughputOverride? = null, val RegionName: Region? = null)

ReplicaDelete

@JsonSerializable

data class ReplicaDelete(val RegionName: Region?)

ReplicaStatus

@JsonSerializable

enum ReplicaStatus : Enum<ReplicaStatus>

ReplicaUpdate

@JsonSerializable

data class ReplicaUpdate(val GlobalSecondaryIndexes: List<GlobalSecondaryIndexesUpdate>? = null, val KMSMasterKeyId: KMSKeyId? = null, val ProvisionedThroughputOverride: ProvisionedThroughputOverride? = null, val RegionName: String? = null)

ReplicaUpdates

@JsonSerializable

data class ReplicaUpdates(val Create: ReplicaCreate? = null, val Delete: ReplicaDelete? = null, val Update: ReplicaUpdate? = null)

ReqGetItem

@JsonSerializable

data class ReqGetItem

ReqStatement

@JsonSerializable

data class ReqStatement(val Statement: String, val ConsistentRead: Boolean? = null, val Parameters: List<AttributeValue>? = null)

ReqWriteItem

@JsonSerializable

data class ReqWriteItem

RestoreSummary

@JsonSerializable

data class RestoreSummary(val RestoreDateTime: Timestamp? = null, val RestoreInProgress: Boolean? = null, val SourceBackupArn: ARN? = null, val SourceTableArn: ARN? = null)

ReturnConsumedCapacity

@JsonSerializable

enum ReturnConsumedCapacity : Enum<ReturnConsumedCapacity>

ReturnItemCollectionMetrics

@JsonSerializable

enum ReturnItemCollectionMetrics : Enum<ReturnItemCollectionMetrics>

ReturnValues

@JsonSerializable

enum ReturnValues : Enum<ReturnValues>

ReturnValuesOnConditionCheckFailure

@JsonSerializable

enum ReturnValuesOnConditionCheckFailure : Enum<ReturnValuesOnConditionCheckFailure>

S3BucketSource

@JsonSerializable

data class S3BucketSource(val S3Bucket: String, val S3BucketOwner: String? = null, val S3KeyPrefix: String? = null)

Select

@JsonSerializable

enum Select : Enum<Select>

SSEDescription

@JsonSerializable

data class SSEDescription(val InaccessibleEncryptionDateTime: Timestamp? = null, val KMSMasterKeyArn: ARN? = null, val SSEType: SSEType? = null, val Status: String? = null)

SSESpecification

@JsonSerializable

data class SSESpecification(val Enabled: Boolean, val KMSMasterKeyId: KMSKeyId? = null, val SSEType: SSEType? = null)

SSEType

@JsonSerializable

enum SSEType : Enum<SSEType>

StatementResponse

@JsonSerializable

data class StatementResponse(val TableName: TableName? = null, val Error: BatchStatementError? = null, Item: ItemResult? = null)

StreamsEventResponse

@JsonSerializable

data class StreamsEventResponse(val batchItemFailures: List<BatchItemFailure>)

StreamSpecification

@JsonSerializable

data class StreamSpecification(val StreamEnabled: Boolean, val StreamViewType: StreamViewType? = null)

StreamViewType

@JsonSerializable

enum StreamViewType : Enum<StreamViewType>

TableCreationParameters

@JsonSerializable

data class TableCreationParameters(val AttributeDefinitions: List<AttributeDefinition>, val KeySchema: List<KeySchema>, val TableName: TableName, val BillingMode: BillingMode? = null, val GlobalSecondaryIndexes: List<GlobalSecondaryIndex>? = null, val ProvisionedThroughput: ProvisionedThroughput? = null, val SSESpecification: SSESpecification? = null)

TableDescription

@JsonSerializable

data class TableDescription(val ArchivalSummary: ArchivalSummary? = null, val AttributeDefinitions: List<AttributeDefinition>? = null, val BillingModeSummary: BillingModeSummary? = null, val CreationDateTime: Timestamp? = null, val GlobalSecondaryIndexes: List<GlobalSecondaryIndexResponse>? = null, val GlobalTableVersion: String? = null, val ItemCount: Long? = null, val KeySchema: List<KeySchema>? = null, val LatestStreamArn: ARN? = null, val LatestStreamLabel: String? = null, val LocalSecondaryIndexes: List<LocalSecondaryIndexResponse>? = null, val ProvisionedThroughput: ProvisionedThroughputResponse? = null, val Replicas: List<Replica>? = null, val RestoreSummary: RestoreSummary? = null, val SSEDescription: SSEDescription? = null, val StreamSpecification: StreamSpecification? = null, val TableArn: ARN? = null, val TableId: String? = null, val TableName: TableName? = null, val TableSizeBytes: Long? = null, val TableStatus: TableStatus? = null)

TableName

class TableName : ResourceId

TableStatus

@JsonSerializable

enum TableStatus : Enum<TableStatus>

TimeToLiveDescription

@JsonSerializable

data class TimeToLiveDescription(val TimeToLiveStatus: TimeToLiveStatus? = null, val AttributeName: AttributeName? = null)

The current TTL configuration of a table, as returned by DescribeTimeToLive. Both fields are optional in the AWS response (mirroring the rest of this module's response models): AttributeName is present while TTL is enabled or transitioning (ENABLING/DISABLING); once fully DISABLED the table reports no attribute.

TimeToLiveSpecification

@JsonSerializable

data class TimeToLiveSpecification(val Enabled: Boolean, val AttributeName: AttributeName)

The desired TTL configuration passed to UpdateTimeToLive, and echoed back in its response. AttributeName is required even when disabling — it names the attribute TTL applies to.

TimeToLiveStatus

@JsonSerializable

enum TimeToLiveStatus : Enum<TimeToLiveStatus>

TokensToNames

typealias TokensToNames = Map<String, AttributeName>

TokensToValues

typealias TokensToValues = Map<String, AttributeValue>

TransactGetItem

@JsonSerializable

data class TransactGetItem

TransactWriteItem

@JsonSerializable