missing PassthroughBehavior enum in types in apigateway(v1)

[fgmarand]

Pre-Migration Checklist

• I've read the Migration Guide.
• I've checked AWS Forums and StackOverflow for similar migration issues.

Go Version Used

Go 1.23 (irrelevant).

Describe the Migration Issue

The constants apigatewayv2.PassthroughBehaviorWhenNoMatch, apigatewayv2.PassthroughBehaviorNever and apigatewayv2.PassthroughBehaviorWhenNoTemplates are missing from the v2 SDK.

As a consequence, the code in v2 uses plain magic constants in the source code instead of enum constants defined in the types package as happens for the other string constants.

Code Comparison

Client.PutIntegration method takes a PutIntegrationInput struct with a PassthroughBehavior field that is a *string in both v1 and v2, so no difference.

Observed Differences/Errors

One of the major changes in v2 is the use of the types package to store such enumerations and remove them as inline magic values, so one would expect these pre-existing constants to have been migrated, instead of just removed.

Additional Context

The likely cause is that the SDK is actually missing any use case for these constants, because there does not appear to be unit tests around their behaviour.

[RanVaknin]

Hi @fgmarand,

Are you referring to these enums?

In v2 the types are under github.com/aws/aws-sdk-go-v2/service/<service-name>/types

Thanks,
Ran~

[fgmarand]

Hi @RanVaknin Indeed. The file where they should live is https://github.com/aws/aws-sdk-go-v2/blob/main/service/apigateway/types/enums.go but they haven't been created there.

[RanVaknin]

Hi @fgmarand,

Hi @RanVaknin Indeed. The file where they should live is main/service/apigateway/types/enums.go but they haven't been created there.

These enums were only added to the APIGatewayV2 API, they were never a part of APIGW(v1) API.
https://github.com/aws/aws-sdk-go-v2/blob/main/service/apigatewayv2/types/enums.go

You need to use the correct import to be able to use the enums. If APIGW(v1) supports sending those values as a "magic constants", then it reflects an unmodeled service side behavior. Since the AWS SDKs are all code-generated from each Service's API model, the SDK team cannot introduce any new enums because those would require and upstream change on the model level. Since the missing enums is for the legacy API (APIGWv1) the service team is unlikely to modify it.

The solution here is to use APIGWv2 which has the modeled enums. (same exact behavior in Go SDK v1):

• Go SDK v1 apigateway missing enums

• Go SDK v1 apigatewayv2 having enums

• Go SDK v2 apigateway missing enums

• Go SDK v2 apigatewayv2 having enums

Thanks,
Ran~

[fgmarand]

The situation is indeed similar in V1 and V2, as you explained, so it is not entirely a matter of V1 to V2 migration, although it is to some extent:

• the V1 and V2 API Gateway functions uses these exact three same values: "WHEN_NO_MATCH", "NEVER", or "WHEN_NO_TEMPLATES", as documented on
  • GetIntegrationOutput.PassthroughBehavior
  • PutIntegrationInput.PassthroughBehavior
  • PutIntegrationOutput.PassthroughBehavior
  • UpdateIntegrationOutput.PassthroughBehavior
  • Integration.PassthroughBehavior
• the constants defined in V2 apigatewayv2.types
  • are the exact same three strings
  • are of type types.PassthroughBehavior, so cannot be used by API Gateway v1, as you mention, because those use a *string parameter
• to avoid discrepancy, in V1 the apigatewayv2.types constants could be used to provide the reference values because the types (string vs *string) and literal values matched, but the V2 constants are now a defined types PassthroughBehavior marking them as semantically specific.

But I guess the answer is "Won't fix" anyway ?