feat: add retry strategy for api-rest category (#8295)

Author: aadimch

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/delete-data/index.mdx

@@ -37,7 +37,7 @@ async function deleteItem() {
   try {
     const restOperation = del({
       apiName: 'myRestApi',
-      path: 'items/1'
+      path: 'items/1',
     });
     await restOperation.response;
     console.log('DELETE call succeeded');

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/fetch-data/index.mdx

@@ -36,8 +36,13 @@ import { get } from 'aws-amplify/api';
 async function getItem() {
   try {
     const restOperation = get({ 
-      apiName: 'myRestApi',
-      path: 'items' 
+        apiName: 'myRestApi',
+        path: 'items' 
+        options: {
+          retryStrategy: {
+            strategy: 'no-retry' // Overrides default retry strategy
+          },
+        }
     });
     const response = await restOperation.response;
     console.log('GET call succeeded: ', response);
@@ -47,6 +52,10 @@ async function getItem() {
 }
 ```
 
+The `retryStrategy` can be configured with:
+- `no-retry`: Single attempt, fails immediately on error
+- `jittered-exponential-backoff`: Default strategy that retries with increasing delays, maximum 3 attempts
+
 ## Accessing response payload
 
 You can consume the response payload by accessing the `body` property of the response object. Depending on the use case and the content type of the body, you can consume they payload in string, blob, or JSON.

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/post-data/index.mdx

@@ -42,7 +42,7 @@ async function postItem() {
         body: {
           message: 'Mow the lawn'
         }
-      }
+      },
     });
 
     const { body } = await restOperation.response;

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/set-up-http-api/index.mdx

@@ -233,13 +233,24 @@ import outputs from '../amplify_outputs.json';
 
 const amplifyConfig = parseAmplifyConfig(outputs);
 
-Amplify.configure({
-  ...amplifyConfig,
-  API: {
-    ...amplifyConfig.API,
-    REST: outputs.custom.API,
+Amplify.configure(
+  {
+    ...amplifyConfig,
+    API: {
+      ...amplifyConfig.API,
+      REST: outputs.custom.API,
+    },
   },
-});
+  {
+    API: {
+      REST: {
+        retryStrategy: {
+          strategy: 'no-retry' // Overrides default retry strategy
+        },
+      }
+    },
+  }
+);
 ```
 </InlineFilter>
 
@@ -251,13 +262,24 @@ import outputs from '@/amplify_outputs.json';
 
 const amplifyConfig = parseAmplifyConfig(outputs);
 
-Amplify.configure({
-  ...amplifyConfig,
-  API: {
-    ...amplifyConfig.API,
-    REST: outputs.custom.API,
+Amplify.configure(
+  {
+    ...amplifyConfig,
+    API: {
+      ...amplifyConfig.API,
+      REST: outputs.custom.API,
+    },
   },
-});
+  {
+    API: {
+      REST: {
+        retryStrategy: {
+          strategy: 'no-retry' // Overrides default retry strategy
+        },
+      }
+    }
+  }
+);
 ```
 </InlineFilter>
 

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/set-up-rest-api/index.mdx

@@ -216,13 +216,24 @@ import outputs from '../amplify_outputs.json';
 
 const amplifyConfig = parseAmplifyConfig(outputs);
 
-Amplify.configure({
-  ...amplifyConfig,
-  API: {
-    ...amplifyConfig.API,
-    REST: outputs.custom.API,
+Amplify.configure(
+  {
+    ...amplifyConfig,
+    API: {
+      ...amplifyConfig.API,
+      REST: outputs.custom.API,
+    },
   },
-});
+  {
+    API: {
+      REST: {
+        retryStrategy: {
+          strategy: 'no-retry', // Overrides default retry strategy
+        },
+      }
+    }
+  }
+);
 ```
 </InlineFilter>
 
@@ -234,13 +245,24 @@ import outputs from '@/amplify_outputs.json';
 
 const amplifyConfig = parseAmplifyConfig(outputs);
 
-Amplify.configure({
-  ...amplifyConfig,
-  API: {
-    ...amplifyConfig.API,
-    REST: outputs.custom.API,
-  },
-});
+Amplify.configure(
+  {
+    ...amplifyConfig,
+    API: {
+      ...amplifyConfig.API,
+      REST: outputs.custom.API,
+    },
+  }, 
+  {
+    API: {
+      REST: {
+        retryStrategy: {
+          strategy: 'no-retry' // Overrides default retry strategy
+        },
+      }
+    }
+  }
+);
 ```
 </InlineFilter>
 

Diff for: src/pages/[platform]/build-a-backend/add-aws-services/rest-api/update-data/index.mdx

@@ -41,7 +41,7 @@ async function updateItems() {
       path: 'items/1',
       options: {
         body: Item
-      }
+      },
     });
     const response = await restOperation.response;
     console.log('PUT call succeeded: ', response);