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 2 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
5 changes: 4 additions & 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,10 @@ async function deleteItem() {
try {
const restOperation = del({
apiName: 'myRestApi',
path: 'items/1'
path: 'items/1',
retryStrategy: {
strategy: 'no-retry'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would also add comment to these on what default will be somethign like

Suggested change
strategy: 'no-retry'
strategy: 'no-retry' // This overrides default automatic retry strategy

},
});
await restOperation.response;
console.log('DELETE call succeeded');
Expand Down
9 changes: 6 additions & 3 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,9 +36,12 @@ import { get } from 'aws-amplify/api';
async function getItem() {
try {
const restOperation = get({
apiName: 'myRestApi',
path: 'items'
});
apiName: 'myRestApi',
path: 'items'
retryStrategy: {
strategy: 'no-retry'
},
});
const response = await restOperation.response;
console.log('GET call succeeded: ', response);
} catch (error) {
Expand Down
5 changes: 4 additions & 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,10 @@ async function postItem() {
body: {
message: 'Mow the lawn'
}
}
},
retryStrategy: {
strategy: 'no-retry'
},
});

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'
},
}
},
}
);
```
</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'
},
}
}
}
);
```
</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'
},
}
}
}
);
```
</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'
},
}
}
}
);
```
</InlineFilter>

Expand Down
5 changes: 4 additions & 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,10 @@ async function updateItems() {
path: 'items/1',
options: {
body: Item
}
},
retryStrategy: {
strategy: 'no-retry'
},
});
const response = await restOperation.response;
console.log('PUT call succeeded: ', response);
Expand Down