What is the proper decoration for a {proxy+}

[gwlester]

What were you trying to accomplish?
We want to have a function handle proxying to an ELB.

  MicroServices:
    Type: AWS::Serverless::Function
    Properties:
      Handler: 'microServices.api_call_dispatcher'
      FunctionName: !Sub "micro-services"
      CodeUri: ../../src/microServices/
      Description: Implements calls to all of the micro servcies
      Runtime: python3.8
      Timeout: 60
      Layers:
        - !GetAtt rAwsLambdaPowertoolsPythonLayer.Outputs.LayerVersionArn
      Events:
        OnPremiseApiEvent:
          Type: Api
          Properties:
            Path: /proxy/{proxy+}
            Method: Any
            RestApiId:
              Ref: rApiGateway

from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver

app = ApiGatewayResolver()

@app.get("/proxy/<proxy>")
def proxy(proxy):
    try:
        return on_premise_api_handler(app, proxy)  #

def lambda_handler(event, context):
    return app.resolve(event, context)

Expected Behavior

Documentation containing the correct decoration for a proxy handler.

Current Behavior

No documentation containing the correct decoration for a proxy handler.

Possible Solution

Steps to Reproduce (for bugs)

Environment

• Powertools version used: 1.20.2
• Packaging format (Layers, PyPi): Layer
• AWS Lambda function runtime: 3.8
• Debugging logs

How to enable debug mode**

# paste logs here

[heitorlessa]

Hey @gwlester, could you try the following and let us know if it works for you?

@app.get("/proxy/.+")

We made a conscious decision not to support "proxy+" to prevent customers into having a single Lambda function for everything.

That said, we understand there are edge cases and we support regex in the route definition, so "/proxy/.+" should match the greedy pattern you defined up there.

[gwlester]

@heitorlessa, thanks for the fast reply!

We will try first thing Monday morning.

Any chance of documenting this in the docs?

[heitorlessa]

Absolutely - I'd love to hear from you first before we add in. In fact, I'll be jet lagged by Monday, so I highly appreciate a PR if you could help.

PS: You can run docs locally by using make docs-local-docker.

[gwlester]

I will take a crack at it.

It would have been assume if

@app.get("/proxy/<.+">)
def proxy_service(**kwargs):

would have worked to get everything pass /proxy/ passed into proxy_service.

[heitorlessa]

Yep. I know it works for API GW so it should also work for ALB. Lemme know ;-)

…

On Sat, 25 Sep 2021 at 14:31, Gerald Leter ***@***.***> wrote: I will take a crack at it. It would have been assume if @app.get("/proxy/<.+">)def proxy_service(**kwargs): would have worked to get everything pass */proxy/* passed into *proxy_service*. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#700 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBDLYUIGPCYZVVUXBU3UDYBPLANCNFSM5EXFUQZQ> .

[heitorlessa]

hey @gwlester just tested and @app.get("/.+") works as a greedy pattern. You do lose the named parameters as you can't use <.+> though.

I'm gonna send a PR updating the docs

[heitorlessa]

This is now available in the stage docs: https://awslabs.github.io/aws-lambda-powertools-python/develop/core/event_handler/api_gateway/#catch-all-routes

I'm gonna resolve this for now as the feature is already available but was undocumented in the latest doc.