502 BAD GATEWAY for file upload through SAM with local API Gateway

Description

When attempting to upload a photo to a local Lambda running using sam local start-api --debug, it fails with a 502 BAD GATEWAY. No code within the Lambda is executed.

Steps to reproduce

I used curl to do the upload.

curl -v -X POST 'http://localhost:3000/v1/photo-gallery' -F 'uploadedFile=@IMG_5071.JPG

This Lambda uses Flask to handle multiple endpoints and the others are working as expected.

Observed result

Please provide command output with --debug flag set.

SAM does not display any debug output. It just logs the request with the response set as a 502.

Expected result

I would expect that the lambda would be executed.

Additional environment details (Ex: Windows, Mac, Amazon Linux etc)

1. OS: Mac
2. sam --version: SAM CLI, version 0.17.0

Add --debug flag to command you are running

[pyrabbit]

/ need to be written as ~1 as per the documentation. After playing around I finally got the following to work. Keep in mind that this allows all binary media types.

Globals:
  Api:
    BinaryMediaTypes: ['*~1*']

[benjaminfiliatrault]

same issue here when uploading a .txt file it’s working fine but I’m trying a .zip file which throw an 502 BAD GATEWAY error. API Gateway binary type set is

BinaryMediaTypes:
    - "application/zip"
    - "application/octet-stream"

Work around

As mentioned by pyrabbit, set the BinaryMediaTypes to ['*~1*']

In the documentation AWS says "Use ~1 instead of / in the mime types. " but "application~1zip" doesn’t work, maybe the documentation should add more examples of how to use the BinaryMediaTypes with working examples

Also on the doc AWS says “This property is similar to the BinaryMediaTypes property of an AWS::ApiGateway::RestApi resource.” which uses the / maybe a change on the SAM CLI to support the / should be good as we keep the same behaviors and consistency