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§
- Attribute
Definition - An attribute definition specifying the attribute name and its scalar type.
- Attribute
Value Update - An attribute value update for the legacy
AttributeUpdatesparameter. - Billing
Mode Summary - Summary of the billing mode for a table.
- Cancellation
Reason - 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.
- Condition
Check - A condition check within a transaction (no mutation).
- Consumed
Capacity - Total capacity consumed by an operation across table and indexes.
- Delete
Request - A request to delete an item within a
BatchWriteItemoperation. - Expected
Attribute Value - Expected attribute value for the legacy
Expectedparameter (conditional writes). - Get
- A get operation targeting a single item by primary key.
- Global
Secondary Index - Global secondary index definition (input for
CreateTable). - Global
Secondary Index Description - Global secondary index description (output from
DescribeTable). - Item
Collection Metrics - Metrics about an item collection (items sharing the same partition key).
- Item
Response - A response item from a
TransactGetItemsoperation. - KeySchema
Element - An element of the key schema for a table or index.
- Keys
AndAttributes - A set of keys and optional projection for
BatchGetItem. - Local
Secondary Index - Local secondary index definition (input for
CreateTable). - Local
Secondary Index Description - Local secondary index description (output from
DescribeTable). - Projection
- Projection settings for a secondary index.
- Provisioned
Throughput - Provisioned throughput settings for a table or GSI (input).
- Provisioned
Throughput Description - Provisioned throughput description (output) including timestamps.
- PutRequest
- A request to put an item within a
BatchWriteItemoperation. - SSEDescription
- SSE description (output from
DescribeTable). - SSESpecification
- SSE specification (input for
CreateTable/UpdateTable). - Stream
Specification - Stream specification for enabling DynamoDB Streams on a table.
- Table
Description - Comprehensive description of a DynamoDB table.
- Tag
- A key-value tag associated with a DynamoDB resource.
- Time
ToLive Description - Time-to-Live description with status information.
- Time
ToLive Specification - Time-to-Live specification for enabling or disabling TTL on a table.
- Transact
Delete - A delete action within a transaction.
- Transact
GetItem - A single get action within a
TransactGetItemsrequest. - Transact
Put - A put action within a transaction.
- Transact
Update - An update action within a transaction.
- Transact
Write Item - A single write action within a
TransactWriteItemsrequest. - Write
Request - A single write request within a
BatchWriteItemoperation.
Enums§
- Attribute
Action - Action to perform on an attribute during an
UpdateItemoperation (legacy API). - Billing
Mode - Billing mode for a DynamoDB table.
- Comparison
Operator - Comparison operator for legacy
Conditionfilters. - Conditional
Operator - Logical operator for combining multiple conditions (legacy API).
- Index
Status - Index status for global secondary indexes.
- KeyType
- Key type within a key schema element.
- Projection
Type - Projection type for secondary indexes.
- Return
Consumed Capacity - Controls whether consumed capacity information is returned.
- Return
Item Collection Metrics - Controls whether item collection metrics are returned for writes.
- Return
Value - Determines what values are returned by write operations.
- Scalar
Attribute Type - Scalar attribute types supported in key schema and attribute definitions.
- Select
- Attributes to retrieve in a
QueryorScanoperation. - SseStatus
- SSE status.
- SseType
- SSE (Server-Side Encryption) type.
- Stream
View Type - Stream view type controlling what data is captured in DynamoDB Streams.
- Table
Status - Current status of a DynamoDB table.
Type Aliases§
- Expression
Attribute Names - Expression attribute names mapping (
#nameplaceholders to attribute names). - Expression
Attribute Values - Expression attribute values mapping (
:valueplaceholders 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.