Idempotency tokens in DynamoDB

Introduction

Idempotency tokens help make sure that when you send the same request more than once, it only happens once in the database. This stops duplicate data or actions.

When a user clicks a button multiple times but you want to save only one record.

When a network error causes you to resend a request and you want to avoid duplicate processing.

When processing payments to ensure the same payment is not charged twice.

When creating orders or bookings where duplicates would cause problems.

When retrying API calls that modify data to keep the operation safe and consistent.

Syntax

DynamoDB

Use a unique token (string) as an attribute in your item, for example:
{
  "IdempotencyToken": "unique-string-value"
}

When writing to DynamoDB, use a condition expression to check if an item with this token already exists before inserting.

The token should be unique for each unique request.

Store the token as a key or attribute to check for duplicates.

Examples

This example inserts an order only if the token does not already exist, preventing duplicates.

DynamoDB

PutItem with idempotency token:
{
  "TableName": "Orders",
  "Item": {
    "OrderId": {"S": "123"},
    "IdempotencyToken": {"S": "abc-123-token"},
    "Amount": {"N": "50"}
  },
  "ConditionExpression": "attribute_not_exists(IdempotencyToken)"
}

This checks if the token is already stored before processing a new request.

DynamoDB

Query to check if token exists:
{
  "TableName": "Orders",
  "IndexName": "IdempotencyToken-index",
  "KeyConditionExpression": "IdempotencyToken = :token",
  "ExpressionAttributeValues": {
    ":token": {"S": "abc-123-token"}
  }
}

Sample Program

This command tries to add a new order with a unique idempotency token. If the token already exists, DynamoDB will reject the request, preventing duplicates.

DynamoDB

aws dynamodb put-item \
  --table-name Orders \
  --item '{"OrderId": {"S": "123"}, "IdempotencyToken": {"S": "token-xyz"}, "Amount": {"N": "100"}}' \
  --condition-expression "attribute_not_exists(IdempotencyToken)"

Important Notes

Always generate a new unique token for each new request.

Use condition expressions to enforce uniqueness in DynamoDB.

If a request fails due to token conflict, handle it gracefully in your app.

Summary

Idempotency tokens prevent duplicate actions in databases.

Use unique tokens and condition checks to enforce one-time operations.

This helps keep data clean and consistent, especially with retries.

Practice

1. What is the main purpose of using idempotency tokens in DynamoDB operations?

easy

A. To encrypt data stored in the database

B. To prevent duplicate writes when the same request is retried

C. To speed up query performance by caching results

D. To automatically backup data at regular intervals

Solution

1. Step 1: Understand idempotency token role

   Idempotency tokens are unique values sent with requests to ensure the same operation is not applied multiple times.

2. Step 2: Identify the main benefit in DynamoDB

   This prevents duplicate writes if a request is retried due to network issues or timeouts.

3. Final Answer:

   To prevent duplicate writes when the same request is retried -> Option B

4. Quick Check:

   Idempotency tokens prevent duplicates = C [OK]

Hint: Idempotency tokens stop repeated writes on retries [OK]

Common Mistakes:

• Confusing idempotency tokens with encryption keys
• Thinking they improve query speed
• Assuming they trigger backups automatically

2. Which of the following is the correct way to include an idempotency token in a DynamoDB PutItem request using AWS SDK?

easy

A. "IdempotencyToken": "unique-token-value" inside the item attributes

B. Adding IdempotencyToken as a reserved keyword in the table schema

C. Setting IdempotencyToken as a parameter outside the item attributes

D. Using a conditional expression with attribute_not_exists(IdempotencyToken)

Solution

1. Step 1: Understand how idempotency tokens work in DynamoDB

   They are used with conditional expressions to ensure the item is only created if the token does not exist.

2. Step 2: Identify correct syntax for conditional check

   The expression attribute_not_exists(IdempotencyToken) prevents overwriting if the token is already present.

3. Final Answer:

   Using a conditional expression with attribute_not_exists(IdempotencyToken) -> Option D

4. Quick Check:

   Conditional check with attribute_not_exists = B [OK]

Hint: Use conditional expression attribute_not_exists for idempotency [OK]

Common Mistakes:

• Placing token inside item without condition causes duplicates
• Trying to set token outside request parameters incorrectly
• Assuming token is a reserved schema keyword

3. Given the following DynamoDB PutItem request with idempotency token condition:

{
  "TableName": "Orders",
  "Item": {"OrderId": {"S": "123"}, "IdempotencyToken": {"S": "abc-123"}},
  "ConditionExpression": "attribute_not_exists(IdempotencyToken)"
}

What happens if this request is sent twice with the same token?

medium

A. The first request succeeds; the second fails with a conditional check error

B. Both requests succeed and create duplicate items

C. Both requests fail due to token conflict

D. The second request overwrites the first item silently

Solution

1. Step 1: Analyze the condition expression effect

   The condition attribute_not_exists(IdempotencyToken) allows the write only if the token is not present.

2. Step 2: Predict behavior on repeated requests with same token

   The first request writes the item and token. The second request fails because the token now exists, triggering a conditional check failure.

3. Final Answer:

   The first request succeeds; the second fails with a conditional check error -> Option A

4. Quick Check:

   First write OK, second fails condition = D [OK]

Hint: Same token blocks second write with condition failure [OK]

Common Mistakes:

• Assuming both writes succeed causing duplicates
• Thinking second write silently overwrites
• Believing both writes fail

4. You wrote this DynamoDB PutItem request with idempotency token:

{
  "TableName": "Payments",
  "Item": {"PaymentId": {"S": "p001"}, "IdempotencyToken": {"S": "token-xyz"}},
  "ConditionExpression": "attribute_not_exists(IdempotencyToken)"
}

But you get a ConditionalCheckFailedException on the first request. What is the likely cause?

medium

A. An item with the same IdempotencyToken already exists in the table

B. The IdempotencyToken attribute is missing from the item

C. The table does not have a primary key defined

D. The ConditionExpression syntax is invalid

Solution

1. Step 1: Understand the meaning of ConditionalCheckFailedException

   This error means the condition attribute_not_exists(IdempotencyToken) was false, so the token attribute already exists.

2. Step 2: Identify why the first request fails

   If the token already exists in an item, the condition prevents overwriting, causing the failure.

3. Final Answer:

   An item with the same IdempotencyToken already exists in the table -> Option A

4. Quick Check:

   Token exists causes condition failure = A [OK]

Hint: Condition fails if token already exists in table [OK]

Common Mistakes:

• Assuming missing token causes this error
• Thinking primary key absence triggers this error
• Believing condition syntax is wrong

5. You want to design a DynamoDB table to support idempotent order creation using tokens. Which approach best ensures no duplicate orders are created when clients retry requests?

hard

A. Use a composite primary key with OrderId and IdempotencyToken and allow overwrites

B. Use OrderId as the primary key and store IdempotencyToken as a unique attribute with a conditional write checking attribute_not_exists(IdempotencyToken)

C. Use IdempotencyToken as the primary key and reject writes if the token exists

D. Do not store tokens; rely on client-side checks to avoid duplicates

Solution

1. Step 1: Consider uniqueness enforcement for idempotency

   Using IdempotencyToken as the primary key ensures each token is unique and prevents duplicates at the database level.

2. Step 2: Evaluate other options

   Use OrderId as the primary key and store IdempotencyToken as a unique attribute with a conditional write checking attribute_not_exists(IdempotencyToken) risks duplicates if tokens are not primary keys. Use a composite primary key with OrderId and IdempotencyToken and allow overwrites allows overwrites, breaking idempotency. Do not store tokens; rely on client-side checks to avoid duplicates relies on unreliable client checks.

3. Final Answer:

   Use IdempotencyToken as the primary key and reject writes if the token exists -> Option C

4. Quick Check:

   Primary key on token ensures uniqueness = A [OK]

Hint: Make token primary key to enforce uniqueness [OK]

Common Mistakes:

• Storing token as non-key attribute without condition
• Allowing overwrites with composite keys
• Relying only on client-side checks