Skip to content

Commit 48634c1

Browse files
committed
docs(idempotency): make terminologies crispier
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
1 parent 44059d4 commit 48634c1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/utilities/idempotency.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ The idempotency utility allows you to retry operations with the same input withi
1818

1919
The property of idempotency means that an operation does not cause additional side effects if it is called more than once with the same input parameters.
2020

21-
**Idempotent operations will return the same result when they are called multiple times with the same parameters**. This makes idempotent operations safe to retry.
21+
**Idempotency key** is a combination of **(a)** Lambda function name, **(b)** fully qualified name of your function, and **(c)** a hash of the entire payload or part(s) of the payload you specify.
2222

23-
**Idempotency key** is a hash representation of either the entire event or a specific configured subset of the event, and invocation results are **JSON serialized** and stored in your persistence storage layer.
23+
**Idempotent request** is an operation with the same input previously processed that is not expired in your persistent storage or in-memory cache.
2424

25-
**Idempotency record** is the data representation of an idempotent request saved in your preferred storage layer. We use it to coordinate whether a request is idempotent, whether it's still valid or expired based on timestamps, etc.
25+
**Persistence layer** is a storage we use to read, create, expire, and delete idempotency records.
26+
27+
**Idempotency record** is the data representation of an idempotent request in its various status. We use it to coordinate whether **(a)** a request is idempotent, **(b)** it's not expired, **(c)** JSON response to return, and more.
2628

2729
<center>
2830
```mermaid

0 commit comments

Comments
 (0)