Provide Smithy models for default API Gateway errors
See original GitHub issueWhenever we deploy our services using API Gateway from AWS, there are errors that we have no control over (as described here). The details of those errors are needed in order to allow the proper deserialization within the client SDKs. We have tried to solve this with two different approaches, although without success:
- By defining the model for them ourselves, but we have not been able to find what are the possible
X-Amzn-ErrorTypeHTTP headers that are being sent by API Gateway. The closest possibility can apparently be found here. - By overriding the
X-Amzn-ErrorTypeHTTP header using the OpenAPI extensionx-amazon-apigateway-gateway-responses. That caused the header to be sent two times containing our override valueBadRequestExceptionand the default valueIncompleteSignatureExceptionfrom API Gateway (as shown in the attached image). The client SDK does not seem to like that, and simply ignore our value.
Is is possible for AWS to provide the Smithy models only of those default API Gateway errors (similar to this here), please?
Issue Analytics
- State:
- Created a year ago
- Reactions:1
- Comments:5 (2 by maintainers)
Top Results From Across the Web
Working with models and mapping templates - Amazon API ...
In API Gateway models are defined using the JSON schema draft 4 . ... If no model is provided, API Gateway uses the...
Read more >Amazon API Gateway traits - Smithy 1.0
If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300....
Read more >Scaling APIs with Smithy - Michael Dowling, Amazon Web ...
Scaling APIs with Smithy - Michael Dowling, Amazon Web ServicesSpeakers: Michael DowlingAWS builds SDKs in 9 programming languages for over ...
Read more >AWS Core Specification - Smithy 2.0 - Open Source at AWS
The cloudFormationName property is a string value that specifies the AWS CloudFormation service name (e.g., ApiGateway ). When not set, this value defaults...
Read more >Get detailed error messages from AWS API Gateway Request ...
(Developer on API Gateway). Unfortunately, this is not supported right now. We are actively working on fixing this issue, but I can't give...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

@eduardomourar @DanielBauman88 are you unblocked with the change to js repo?
On the Smithy side, we’d still want to add a protocol test for this, so other language SDKs can also support this. So leaving this issue open for that followup.
This does unblock me.
Appreciate you keeping this open - would be great to have the same support for all the supported languages!