Skip to main content

Module types

Module types 

Source
Expand description

Shared DynamoDB types for the 12 MVP operations.

All types follow the DynamoDB JSON wire format with PascalCase field names. Structs use #[serde(rename_all = "PascalCase")] to match the DynamoDB API.

Enum variants use idiomatic Rust PascalCase naming with #[serde(rename)] attributes to map to the SCREAMING_SNAKE_CASE wire format that DynamoDB uses.

§MVP Operations Covered

  • Table management: CreateTable, DeleteTable, DescribeTable, ListTables
  • Item CRUD: PutItem, GetItem, UpdateItem, DeleteItem
  • Queries: Query, Scan
  • Batch: BatchGetItem, BatchWriteItem

Structs§

AttributeDefinition
An attribute definition specifying the attribute name and its scalar type.
AttributeValueUpdate
An attribute value update for the legacy AttributeUpdates parameter.
BillingModeSummary
Summary of the billing mode for a table.
CancellationReason
A reason why a transaction item was cancelled.
Capacity
Capacity units consumed by an individual table or index.
Condition
A condition for legacy filtering operations.
ConditionCheck
A condition check within a transaction (no mutation).
ConsumedCapacity
Total capacity consumed by an operation across table and indexes.
DeleteRequest
A request to delete an item within a BatchWriteItem operation.
ExpectedAttributeValue
Expected attribute value for the legacy Expected parameter (conditional writes).
Get
A get operation targeting a single item by primary key.
GlobalSecondaryIndex
Global secondary index definition (input for CreateTable).
GlobalSecondaryIndexDescription
Global secondary index description (output from DescribeTable).
ItemCollectionMetrics
Metrics about an item collection (items sharing the same partition key).
ItemResponse
A response item from a TransactGetItems operation.
KeySchemaElement
An element of the key schema for a table or index.
KeysAndAttributes
A set of keys and optional projection for BatchGetItem.
LocalSecondaryIndex
Local secondary index definition (input for CreateTable).
LocalSecondaryIndexDescription
Local secondary index description (output from DescribeTable).
Projection
Projection settings for a secondary index.
ProvisionedThroughput
Provisioned throughput settings for a table or GSI (input).
ProvisionedThroughputDescription
Provisioned throughput description (output) including timestamps.
PutRequest
A request to put an item within a BatchWriteItem operation.
SSEDescription
SSE description (output from DescribeTable).
SSESpecification
SSE specification (input for CreateTable / UpdateTable).
StreamSpecification
Stream specification for enabling DynamoDB Streams on a table.
TableDescription
Comprehensive description of a DynamoDB table.
Tag
A key-value tag associated with a DynamoDB resource.
TimeToLiveDescription
Time-to-Live description with status information.
TimeToLiveSpecification
Time-to-Live specification for enabling or disabling TTL on a table.
TransactDelete
A delete action within a transaction.
TransactGetItem
A single get action within a TransactGetItems request.
TransactPut
A put action within a transaction.
TransactUpdate
An update action within a transaction.
TransactWriteItem
A single write action within a TransactWriteItems request.
WriteRequest
A single write request within a BatchWriteItem operation.

Enums§

AttributeAction
Action to perform on an attribute during an UpdateItem operation (legacy API).
BillingMode
Billing mode for a DynamoDB table.
ComparisonOperator
Comparison operator for legacy Condition filters.
ConditionalOperator
Logical operator for combining multiple conditions (legacy API).
IndexStatus
Index status for global secondary indexes.
KeyType
Key type within a key schema element.
ProjectionType
Projection type for secondary indexes.
ReturnConsumedCapacity
Controls whether consumed capacity information is returned.
ReturnItemCollectionMetrics
Controls whether item collection metrics are returned for writes.
ReturnValue
Determines what values are returned by write operations.
ScalarAttributeType
Scalar attribute types supported in key schema and attribute definitions.
Select
Attributes to retrieve in a Query or Scan operation.
SseStatus
SSE status.
SseType
SSE (Server-Side Encryption) type.
StreamViewType
Stream view type controlling what data is captured in DynamoDB Streams.
TableStatus
Current status of a DynamoDB table.

Type Aliases§

ExpressionAttributeNames
Expression attribute names mapping (#name placeholders to attribute names).
ExpressionAttributeValues
Expression attribute values mapping (:value placeholders to attribute values).
Item
A DynamoDB item represented as a map of attribute names to values.
Key
A DynamoDB key represented as a map of key attribute names to values.