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

Package-level declarations

Types

@JsonSerializable

data class BatchExecuteStatement(val Statements: List<ReqStatement>) : DynamoDbAction<BatchStatements>

@JsonSerializable

data class BatchGetItem(val RequestItems: Map<TableName, ReqGetItem>, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null) : DynamoDbAction<BatchGetItems>

BatchGetItems

@JsonSerializable

data class BatchGetItems(val Responses: Map<String, List<Item>>? = null, val UnprocessedKeys: Map<String, ReqGetItem>? = null, val ConsumedCapacity: List<ConsumedCapacity>? = null)

BatchStatements

@JsonSerializable

data class BatchStatements(val Responses: List<StatementResponse>)

BatchWriteItem

@JsonSerializable

data class BatchWriteItem(val RequestItems: Map<TableName, List<ReqWriteItem>>, val ReturnItemCollectionMetrics: ReturnItemCollectionMetrics? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null) : DynamoDbAction<BatchWriteItems>

BatchWriteItems

@JsonSerializable

data class BatchWriteItems(val UnprocessedItems: Map<String, ReqWriteItem>? = null, val ConsumedCapacity: List<ConsumedCapacity>? = null, val ItemCollectionMetrics: ItemCollectionMetrics? = null)

CancellationReason

@JsonSerializable

data class CancellationReason(val Code: String, val Message: String? = null, val Item: ItemResult? = null)

ConditionalCheckFailed

@JsonSerializable

data class ConditionalCheckFailed(val __type: String, @Json(name = "message") val Message: String, val Item: ItemResult? = null)

The body of the error DynamoDB returns for a failed conditional write. Item holds the record which blocked the write, and is populated only when the request set ReturnValuesOnConditionCheckFailure to ALL_OLD.

CreateTable

@JsonSerializable

data class CreateTable(val TableName: TableName, val KeySchema: List<KeySchema>, val AttributeDefinitions: List<AttributeDefinition>, val GlobalSecondaryIndexes: List<GlobalSecondaryIndex>? = null, val LocalSecondaryIndexes: List<LocalSecondaryIndex>? = null, val Tags: List<Tag>? = null, val BillingMode: BillingMode? = null, val ProvisionedThroughput: ProvisionedThroughput? = null, val SSESpecification: SSESpecification? = null, val StreamSpecification: StreamSpecification? = null) : DynamoDbAction<TableDescriptionResponse>

DeleteItem

@JsonSerializable

data class DeleteItem(val TableName: TableName, val Key: Key, val ConditionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ExpressionAttributeValues: TokensToValues? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null, val ReturnItemCollectionMetrics: ReturnItemCollectionMetrics? = null, val ReturnValues: ReturnValues? = null, val ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailure? = null) : DynamoDbAction<ModifiedItem>

DeleteTable

@JsonSerializable

data class DeleteTable(val TableName: TableName) : DynamoDbAction<TableDescriptionResponse>

DescribedTable

@JsonSerializable

data class DescribedTable(val Table: TableDescription)

DescribeImport

@JsonSerializable

data class DescribeImport(val ImportArn: ARN) : DynamoDbAction<ImportTableResponse>

DescribeTable

@JsonSerializable

data class DescribeTable(val TableName: TableName) : DynamoDbAction<DescribedTable>

DescribeTimeToLive

@JsonSerializable

data class DescribeTimeToLive(val TableName: TableName) : DynamoDbAction<TimeToLiveDescriptionResponse>

DynamoDbPagedAction

abstract class DynamoDbPagedAction<R : Paged<Key, Item>, Self : PagedAction<Key, Item, R, Self>>(clazz: KClass<R>) : DynamoDbAction<R> , PagedAction<Key, Item, R, Self>

ExecutedStatement

@JsonSerializable

data class ExecutedStatement(Items: List<ItemResult>)

ExecutedTransaction

@JsonSerializable

data class ExecutedTransaction(Responses: List<ItemResult>)

ExecuteStatement

@JsonSerializable

data class ExecuteStatement(val Statement: String, val Parameters: List<AttributeValue>? = null, val ConsistentRead: Boolean? = null, val NextToken: String? = null) : DynamoDbAction<ExecutedStatement>

ExecuteTransaction

@JsonSerializable

data class ExecuteTransaction(val TransactStatements: List<ParameterizedStatement>, val ClientRequestToken: String? = null) : DynamoDbAction<ExecutedTransaction>

GetItem

@JsonSerializable

data class GetItem(val TableName: TableName, val Key: Key, val ProjectionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ConsistentRead: Boolean? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null) : DynamoDbAction<GetResponse>

GetItemsResponse

@JsonSerializable

data class GetItemsResponse(Responses: List<GetItemsResponseItem>, val ConsumedCapacity: ConsumedCapacity? = null, val ItemCollectionMetrics: ItemCollectionMetrics? = null)

GetResponse

@JsonSerializable

data class GetResponse(Item: ItemResult? = null, val ConsumedCapacity: ConsumedCapacity? = null)

ImportTable

@JsonSerializable

data class ImportTable(val InputFormat: InputFormat, val S3BucketSource: S3BucketSource, val TableCreationParameters: TableCreationParameters, val ClientToken: ClientToken = org.http4k.connect.amazon.dynamodb.model.ClientToken.random(), val InputCompressionType: InputCompressionType? = null, val InputFormatOptions: InputFormatOptions? = null) : DynamoDbAction<ImportTableResponse>

ImportTableResponse

@JsonSerializable

data class ImportTableResponse(val ImportTableDescription: ImportTableDescription)

ListImports

@JsonSerializable

data class ListImports(val NextToken: NextToken? = null, val PageSize: Int? = null, val TableArn: ARN? = null) : DynamoDbAction<ListImportsResponse>

ListImportsResponse

@JsonSerializable

data class ListImportsResponse(val ImportSummaryList: List<ImportSummary>, val NextToken: NextToken? = null)

ListTables

@JsonSerializable

data class ListTables(val ExclusiveStartTableName: TableName? = null, val Limit: Int? = null) : DynamoDbAction<TableList> , PagedAction<TableName, TableName, TableList, ListTables>

ModifiedItem

@JsonSerializable

data class ModifiedItem(val Attributes: ItemResult? = null, val ConsumedCapacity: ConsumedCapacity? = null, val ItemCollectionMetrics: ItemCollectionMetrics? = null)

ModifiedItems

@JsonSerializable

data class ModifiedItems(val ConsumedCapacity: ConsumedCapacity? = null, val ItemCollectionMetrics: ItemCollectionMetrics? = null)

PutItem

@JsonSerializable

data class PutItem(val TableName: TableName, val Item: Item, val ConditionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ExpressionAttributeValues: TokensToValues? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null, val ReturnItemCollectionMetrics: ReturnItemCollectionMetrics? = null, val ReturnValues: ReturnValues? = null, val ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailure? = null) : DynamoDbAction<ModifiedItem>

Query

@JsonSerializable

data class Query(val TableName: TableName, val KeyConditionExpression: String? = null, val FilterExpression: String? = null, val ProjectionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ExpressionAttributeValues: TokensToValues? = null, val IndexName: IndexName? = null, val Select: Select? = null, val ConsistentRead: Boolean? = null, val ExclusiveStartKey: Key? = null, val Limit: Int? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null, val ScanIndexForward: Boolean? = null) : DynamoDbPagedAction<QueryResponse, Query>

QueryResponse

@JsonSerializable

data class QueryResponse(Items: List<ItemResult>? = null, val ConsumedCapacity: ConsumedCapacity? = null, val Count: Int = 0, val LastEvaluatedKey: Key? = null, val ScannedCount: Int = 0) : Paged<Key, Item>

Scan

@JsonSerializable

data class Scan(val TableName: TableName, val FilterExpression: String? = null, val ProjectionExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ExpressionAttributeValues: TokensToValues? = null, val ExclusiveStartKey: Key? = null, val IndexName: IndexName? = null, val Limit: Int? = null, val ConsistentRead: Boolean? = null, val Segment: Int? = null, val Select: Select? = null, val TotalSegments: Int? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null) : DynamoDbPagedAction<ScanResponse, Scan>

ScanResponse

@JsonSerializable

data class ScanResponse(val ConsumedCapacity: ConsumedCapacity? = null, val Count: Int = 0, val LastEvaluatedKey: Key? = null, val ScannedCount: Int = 0, Items: List<ItemResult>? = null) : Paged<Key, Item>

TableDescriptionResponse

@JsonSerializable

data class TableDescriptionResponse(val TableDescription: TableDescription)

TableList

@JsonSerializable

data class TableList(val TableNames: List<TableName>, val LastEvaluatedTableName: TableName? = null) : Paged<TableName, TableName>

TimeToLiveDescriptionResponse

@JsonSerializable

data class TimeToLiveDescriptionResponse(val TimeToLiveDescription: TimeToLiveDescription)

TransactGetItems

@JsonSerializable

data class TransactGetItems(val TransactItems: List<TransactGetItem>, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null) : DynamoDbAction<GetItemsResponse>

TransactionCanceled

@JsonSerializable

data class TransactionCanceled(val __type: String, val Message: String, val CancellationReasons: List<CancellationReason>)

The body of the error DynamoDB returns for a cancelled transaction: one reason per member of the request, in order, with Code None for each member that passed.

TransactWriteItems

@JsonSerializable

data class TransactWriteItems(val TransactItems: List<TransactWriteItem>, val ClientRequestToken: String? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null, val ReturnItemCollectionMetrics: ReturnItemCollectionMetrics? = null) : DynamoDbAction<ModifiedItems>

UpdateItem

@JsonSerializable

data class UpdateItem(val TableName: TableName, val Key: Key, val ConditionExpression: String? = null, val UpdateExpression: String? = null, val ExpressionAttributeNames: TokensToNames? = null, val ExpressionAttributeValues: TokensToValues? = null, val ReturnConsumedCapacity: ReturnConsumedCapacity? = null, val ReturnItemCollectionMetrics: ReturnItemCollectionMetrics? = null, val ReturnValues: ReturnValues? = null, val ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailure? = null) : DynamoDbAction<ModifiedItem>

UpdateTable

@JsonSerializable

data class UpdateTable(val TableName: TableName, val AttributeDefinitions: List<AttributeDefinition>? = null, val BillingMode: BillingMode? = null, val GlobalSecondaryIndexUpdates: List<GlobalSecondaryIndexUpdates>? = null, val ProvisionedThroughput: ProvisionedThroughput? = null, val ReplicaUpdates: List<ReplicaUpdates>? = null, val SSESpecification: SSESpecification? = null, val StreamSpecification: StreamSpecification? = null) : DynamoDbAction<TableDescriptionResponse>

UpdateTimeToLive

@JsonSerializable

data class UpdateTimeToLive(val TableName: TableName, val TimeToLiveSpecification: TimeToLiveSpecification) : DynamoDbAction<UpdateTimeToLiveResponse>

UpdateTimeToLiveResponse

@JsonSerializable

data class UpdateTimeToLiveResponse(val TimeToLiveSpecification: TimeToLiveSpecification)

Functions

copy

fun <R : Paged<Key, Item>, Self : DynamoDbPagedAction<R, Self>> DynamoDb.copy(action: Self, destination: TableName, mappingFn: (Item) -> Item = { it }): Result<Map<String, ReqWriteItem>?, RemoteFailure>

Copies items that are queried into another table, using BatchWriteItem to insert, and optionally mapping. Returns the Unprocessed Items from the last insert if there were any.