hot.dev/aws-dynamodb / ::aws::dynamodb

Functions

batch-get-item alias of ::aws::dynamodb::batch/batch-get-item

fn (request_items: Map): BatchGetResponse | ::aws::core/AwsError

Get multiple items from one or more tables in a single request. Max 100 items.

Example

request-items ::aws::dynamodb::batch/batch-get-keys("my-table", [
    {pk: {S: "user-1"}, sk: {S: "profile"}},
    {pk: {S: "user-2"}, sk: {S: "profile"}}
])
result ::aws::dynamodb::batch/batch-get-item(request-items)
items result.responses["my-table"]

batch-write-item alias of ::aws::dynamodb::batch/batch-write-item

fn (request_items: Map): BatchWriteResponse | ::aws::core/AwsError

Put or delete multiple items in one or more tables in a single request. Max 25 items.

Example

// Batch put items
request-items ::aws::dynamodb::batch/batch-put-items("my-table", [
    {pk: {S: "user-1"}, sk: {S: "profile"}, name: {S: "Alice"}},
    {pk: {S: "user-2"}, sk: {S: "profile"}, name: {S: "Bob"}}
])
result ::aws::dynamodb::batch/batch-write-item(request-items)

// Batch delete items
request-items ::aws::dynamodb::batch/batch-delete-keys("my-table", [
    {pk: {S: "user-1"}, sk: {S: "profile"}},
    {pk: {S: "user-2"}, sk: {S: "profile"}}
])
::aws::dynamodb::batch/batch-write-item(request-items)

delete-item alias of ::aws::dynamodb::items/delete-item

fn (table_name: Str, key: Map, condition_expression: Str, expression_attribute_values: Map): DeleteItemResponse | ::aws::core/AwsError
fn (table_name: Str, key: Map): DeleteItemResponse | ::aws::core/AwsError

Delete an item from a DynamoDB table by its primary key.

Example

key {pk: {S: "user-123"}, sk: {S: "profile"}}
::aws::dynamodb::items/delete-item("my-table", key)

describe-table alias of ::aws::dynamodb::tables/describe-table

fn (table_name: Str): DescribeTableResponse | ::aws::core/AwsError

Get detailed information about a DynamoDB table.

Example

result ::aws::dynamodb::tables/describe-table("my-table")
result.table.table_name    // => "my-table"
result.table.table_status  // => "ACTIVE"
result.table.item_count    // => 1500

get-item alias of ::aws::dynamodb::items/get-item

fn (table_name: Str, key: Map, consistent_read: Bool, projection_expression: Str): GetItemResponse | ::aws::core/AwsError
fn (table_name: Str, key: Map, consistent_read: Bool): GetItemResponse | ::aws::core/AwsError
fn (table_name: Str, key: Map): GetItemResponse | ::aws::core/AwsError

Get an item from a DynamoDB table by its primary key.

Example

key {pk: {S: "user-123"}, sk: {S: "profile"}}
result ::aws::dynamodb::items/get-item("my-table", key)
result.item.name.S  // => "Alice"
result.item.age.N   // => "30"

list-tables alias of ::aws::dynamodb::tables/list-tables

fn (limit: Int, exclusive_start_table_name: Str): ListTablesResponse | ::aws::core/AwsError
fn (limit: Int): ListTablesResponse | ::aws::core/AwsError
fn (): ListTablesResponse | ::aws::core/AwsError

List all DynamoDB tables in the account/region.

Example

result ::aws::dynamodb::tables/list-tables()
result.table_names
// => ["users", "orders", "products"]

// With limit
result ::aws::dynamodb::tables/list-tables(10)

put-item alias of ::aws::dynamodb::items/put-item

fn (table_name: Str, item: Map, condition_expression: Str, expression_attribute_values: Map): PutItemResponse | ::aws::core/AwsError
fn (table_name: Str, item: Map): PutItemResponse | ::aws::core/AwsError

Put an item into a DynamoDB table. Item should use DynamoDB attribute value format.

Example

item {
    pk: {S: "user-123"},
    sk: {S: "profile"},
    name: {S: "Alice"},
    age: {N: "30"}
}

result ::aws::dynamodb::items/put-item("my-table", item)

query alias of ::aws::dynamodb::query/query

fn (table_name: Str, key_condition_expression: Str, expression_attribute_values: Map, expression_attribute_names: Map, filter_expression: Str, limit: Int, exclusive_start_key: Map, scan_index_forward: Bool, index_name: Str): QueryResponse | ::aws::core/AwsError
fn (table_name: Str, key_condition_expression: Str, expression_attribute_values: Map): QueryResponse | ::aws::core/AwsError
fn (table_name: Str, key_condition_expression: Str, expression_attribute_values: Map, limit: Int): QueryResponse | ::aws::core/AwsError

Query items from a DynamoDB table using a key condition expression.

Example

// Query all items with a partition key
result ::aws::dynamodb::query/query(
    "my-table",
    "pk = :pk",
    {":pk": {S: "user-123"}}
)
result.count   // => 3
result.items   // => [{pk: {S: "user-123"}, sk: {S: "order:1"}, ...}, ...]

// Query with sort key prefix (begins_with)
result ::aws::dynamodb::query/query(
    "my-table",
    "pk = :pk AND begins_with(sk, :prefix)",
    {":pk": {S: "user-123"}, ":prefix": {S: "order:"}},
    null, null, null, null, true, null
)

scan alias of ::aws::dynamodb::query/scan

fn (table_name: Str, filter_expression: Str, expression_attribute_values: Map, expression_attribute_names: Map, limit: Int, exclusive_start_key: Map): ScanResponse | ::aws::core/AwsError
fn (table_name: Str, filter_expression: Str, expression_attribute_values: Map): ScanResponse | ::aws::core/AwsError
fn (table_name: Str, limit: Int): ScanResponse | ::aws::core/AwsError
fn (table_name: Str): ScanResponse | ::aws::core/AwsError

Scan all items from a DynamoDB table.

Scans read every item in the table and optionally apply a filter expression. For large tables, prefer query when possible.

Example

// Scan with a filter
result ::aws::dynamodb::query/scan(
    "my-table",
    "status = :s",
    {":s": {S: "active"}}
)
result.items  // => [{pk: {S: "..."}, status: {S: "active"}, ...}, ...]

// Scan with limit
result ::aws::dynamodb::query/scan("my-table", 5)

update-item alias of ::aws::dynamodb::items/update-item

fn (table_name: Str, key: Map, update_expression: Str, expression_attribute_values: Map, expression_attribute_names: Map): UpdateItemResponse | ::aws::core/AwsError
fn (table_name: Str, key: Map, update_expression: Str, expression_attribute_values: Map): UpdateItemResponse | ::aws::core/AwsError

Update an item in a DynamoDB table using update expressions.

Returns the updated attributes (ALL_NEW).

Example

key {pk: {S: "user-123"}, sk: {S: "profile"}}
result ::aws::dynamodb::items/update-item(
    "my-table",
    key,
    "SET hit_count = hit_count + :inc, updated_at = :now",
    {":inc": {N: "1"}, ":now": {S: "2026-02-16"}}
)
result.attributes.hit_count.N  // => "1"

Types

AwsError alias of ::aws::core/AwsError

BatchGetResponse alias of ::aws::dynamodb::batch/BatchGetResponse

BatchGetResponse type {
    responses: Map,
    unprocessed_keys: Map?,
    consumed_capacity: Vec

BatchWriteResponse alias of ::aws::dynamodb::batch/BatchWriteResponse

BatchWriteResponse type {
    unprocessed_items: Map?,
    consumed_capacity: Vec

Credentials alias of ::aws::core/Credentials

DeleteItemResponse alias of ::aws::dynamodb::items/DeleteItemResponse

DeleteItemResponse type {
    attributes: Map?,
    consumed_capacity: Map?
}

GetItemResponse alias of ::aws::dynamodb::items/GetItemResponse

GetItemResponse type {
    item: Map?,
    consumed_capacity: Map?
}

PutItemResponse alias of ::aws::dynamodb::items/PutItemResponse

PutItemResponse type {
    attributes: Map?,
    consumed_capacity: Map?
}

QueryResponse alias of ::aws::dynamodb::query/QueryResponse

QueryResponse type {
    items: Vec

ScanResponse alias of ::aws::dynamodb::query/ScanResponse

ScanResponse type {
    items: Vec

UpdateItemResponse alias of ::aws::dynamodb::items/UpdateItemResponse

UpdateItemResponse type {
    attributes: Map?,
    consumed_capacity: Map?
}