Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 1, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0567a7a
feat: add retry strategy for api-rest category
aadimch Mar 21, 2025
15fb0a6
fix: pull retryStrategy inside REST
aadimch Mar 24, 2025
55b3bea
chore: address feedbacks
aadimch Mar 27, 2025
c35f5b1
fix: placement of retryStrategy
aadimch Mar 28, 2025
516d9bd
chore: add clarifying block
aadimch Mar 31, 2025
2100cb6
chore: spelling mistake
aadimch Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ages/[platform]/build-a-backend/add-aws-services/rest-api/delete-data/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
13 changes: 11 additions & 2 deletions ...pages/[platform]/build-a-backend/add-aws-services/rest-api/fetch-data/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/[platform]/build-a-backend/add-aws-services/rest-api/post-data/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ async function postItem() {
body: {
message: 'Mow the lawn'
}
}
},
});

const { body } = await restOperation.response;
Expand Down
46 changes: 34 additions & 12 deletions .../[platform]/build-a-backend/add-aws-services/rest-api/set-up-http-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand All @@ -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>

Expand Down
48 changes: 35 additions & 13 deletions .../[platform]/build-a-backend/add-aws-services/rest-api/set-up-rest-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand All @@ -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>

Expand Down
2 changes: 1 addition & 1 deletion ...ages/[platform]/build-a-backend/add-aws-services/rest-api/update-data/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ async function updateItems() {
path: 'items/1',
options: {
body: Item
}
},
});
const response = await restOperation.response;
console.log('PUT call succeeded: ', response);
Expand Down