Skip to content

Commit 62b6ff0

Browse files
committed
docs: fix broken links after sections renaming
1 parent 718476d commit 62b6ff0

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

docs/utilities/idempotency.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ classDiagram
5252

5353
## Getting started
5454

55-
We use Amazon DynamoDB as the default persistence layer in the documentation. If you prefer Redis, you can learn more from [this section](#redis-as-persistent-storage-layer-provider).
55+
We use Amazon DynamoDB as the default persistence layer in the documentation. If you prefer Redis, you can learn more from [this section](#redis-cluster).
5656

5757
### IAM Permissions
5858

@@ -80,7 +80,7 @@ To start, you'll need:
8080

8181
---
8282

83-
[Amazon DynamoDB](#dynamodb-table) or [Redis](#redis-as-persistent-storage-layer-provider)
83+
[Amazon DynamoDB](#dynamodb-table) or [Redis](#redis-cluster)
8484

8585
* :simple-awslambda:{ .lg .middle } **AWS Lambda function**
8686

@@ -126,7 +126,7 @@ Note that `fn_qualified_name` means the [qualified name for classes and function
126126

127127
##### Limitations
128128

129-
* **DynamoDB restricts [item sizes to 400KB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html#limits-items){target="_blank"}**. This means that if your annotated function's response must be smaller than 400KB, otherwise your function will fail. Consider [Redis](#redis-as-persistent-storage-layer-provider) as an alternative.
129+
* **DynamoDB restricts [item sizes to 400KB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html#limits-items){target="_blank"}**. This means that if your annotated function's response must be smaller than 400KB, otherwise your function will fail. Consider [Redis](#redis-cluster) as an alternative.
130130

131131
* **Expect 2 WCU per non-idempotent call**. During the first invocation, we use `PutItem` for locking and `UpdateItem` for completion. Consider reviewing [DynamoDB pricing documentation](https://aws.amazon.com/dynamodb/pricing/){target="_blank"} to estimate cost.
132132

@@ -153,19 +153,19 @@ In both services and self-hosting Redis, you'll need to configure [VPC access](h
153153
1. Replace the Security Group ID and Subnet ID to match your VPC settings.
154154
2. Replace the Security Group ID and Subnet ID to match your VPC settings.
155155

156-
Once setup, you can find a quick start and advanced examples for Redis in [the persistent layers section](RedisCachePersistenceLayer).
156+
Once setup, you can find a quick start and advanced examples for Redis in [the persistent layers section](#redispersistencelayer).
157157

158158
<!-- markdownlint-enable MD013 -->
159159

160160
### Idempotent decorator
161161

162162
For simple use cases, you can use the `idempotent` decorator on your Lambda handler function.
163163

164-
It will treat the entire event as an idempotency key. That is, the same event will return the previously stored result within a [configurable time window](#expiring-idempotency-records) _(1 hour, by default)_.
164+
It will treat the entire event as an idempotency key. That is, the same event will return the previously stored result within a [configurable time window](#adjusting-expiration-window) _(1 hour, by default)_.
165165

166166
=== "Idempotent decorator"
167167

168-
!!! tip "You can also choose [one or more fields](#choosing-a-payload-subset-for-idempotency) as an idempotency key."
168+
!!! tip "You can also choose [one or more fields](#choosing-a-payload-subset) as an idempotency key."
169169

170170
```python title="getting_started_with_idempotency.py" hl_lines="5-8 12 25"
171171
--8<-- "examples/idempotency/src/getting_started_with_idempotency.py"
@@ -352,7 +352,7 @@ You can change this expiration window with the **`expires_after_seconds`** param
352352

353353
!!! note "You can skip this section if you are using the [`@idempotent` decorator](#idempotent-decorator)"
354354

355-
By default, we protect against [concurrent executions](#handling-concurrent-executions-with-the-same-payload) with the same payload using a locking mechanism. However, if your Lambda function times out before completing the first invocation it will only accept the same request when the [idempotency record expire](#expiring-idempotency-records).
355+
By default, we protect against [concurrent executions](#handling-concurrent-executions-with-the-same-payload) with the same payload using a locking mechanism. However, if your Lambda function times out before completing the first invocation it will only accept the same request when the [idempotency record expire](#adjusting-expiration-window).
356356

357357
To prevent extended failures, use **`register_lambda_context`** function from your idempotency config to calculate and include the remaining invocation time in your idempotency record.
358358

@@ -517,7 +517,7 @@ You can can easily integrate with [Batch](batch.md){target="_blank"} using the [
517517
???+ "Choosing an unique batch record attribute"
518518
In this example, we choose `messageId` as our idempotency key since we know it'll be unique.
519519

520-
Depending on your use case, it might be more accurate [to choose another field](#choosing-a-payload-subset-for-idempotency) your producer intentionally set to define uniqueness.
520+
Depending on your use case, it might be more accurate [to choose another field](#choosing-a-payload-subset) your producer intentionally set to define uniqueness.
521521

522522
=== "Integration with Batch Processor"
523523

@@ -968,10 +968,6 @@ When using response hooks to manipulate returned data from idempotent operations
968968

969969
## Compatibility with other utilities
970970

971-
### Batch
972-
973-
See [Batch integration](#batch-integration) above.
974-
975971
### JSON Schema Validation
976972

977973
The idempotency utility can be used with the `validator` decorator. Ensure that idempotency is the innermost decorator.
@@ -982,7 +978,7 @@ The idempotency utility can be used with the `validator` decorator. Ensure that
982978

983979
Make sure to account for this behavior, if you set the `event_key_jmespath`.
984980

985-
=== "Using Idempotency with JSONSchema Validation utility"
981+
=== "Using Idempotency with validation utility"
986982

987983
```python hl_lines="16"
988984
--8<-- "examples/idempotency/src/integrate_idempotency_with_validator.py"

0 commit comments

Comments
 (0)