apigateway/rest_api: Improve diff handling for policies

[YakDriver]

Description

Relations

Relates #23288

References

Output from Acceptance Testing

% make testacc TESTS=TestAccAPIGatewayRestAPIPolicy_ PKG=apigateway
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/apigateway/... -v -count 1 -parallel 20 -run='TestAccAPIGatewayRestAPIPolicy_'  -timeout 180m
=== RUN   TestAccAPIGatewayRestAPIPolicy_basic
=== PAUSE TestAccAPIGatewayRestAPIPolicy_basic
=== RUN   TestAccAPIGatewayRestAPIPolicy_disappears
=== PAUSE TestAccAPIGatewayRestAPIPolicy_disappears
=== RUN   TestAccAPIGatewayRestAPIPolicy_Disappears_restAPI
=== PAUSE TestAccAPIGatewayRestAPIPolicy_Disappears_restAPI
=== CONT  TestAccAPIGatewayRestAPIPolicy_basic
=== CONT  TestAccAPIGatewayRestAPIPolicy_Disappears_restAPI
=== CONT  TestAccAPIGatewayRestAPIPolicy_disappears
--- PASS: TestAccAPIGatewayRestAPIPolicy_Disappears_restAPI (14.36s)
--- PASS: TestAccAPIGatewayRestAPIPolicy_basic (41.81s)
--- PASS: TestAccAPIGatewayRestAPIPolicy_disappears (97.23s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	100.111s
% make testacc TESTS=TestAccAPIGatewayRestAPI_ PKG=apigateway
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/apigateway/... -v -count 1 -parallel 20 -run='TestAccAPIGatewayRestAPI_'  -timeout 180m
=== RUN   TestAccAPIGatewayRestAPI_basic
=== PAUSE TestAccAPIGatewayRestAPI_basic
=== RUN   TestAccAPIGatewayRestAPI_tags
=== PAUSE TestAccAPIGatewayRestAPI_tags
=== RUN   TestAccAPIGatewayRestAPI_disappears
=== PAUSE TestAccAPIGatewayRestAPI_disappears
=== RUN   TestAccAPIGatewayRestAPI_endpoint
=== PAUSE TestAccAPIGatewayRestAPI_endpoint
=== RUN   TestAccAPIGatewayRestAPI_Endpoint_private
=== PAUSE TestAccAPIGatewayRestAPI_Endpoint_private
=== RUN   TestAccAPIGatewayRestAPI_apiKeySource
=== PAUSE TestAccAPIGatewayRestAPI_apiKeySource
=== RUN   TestAccAPIGatewayRestAPI_APIKeySource_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_APIKeySource_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_APIKeySource_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_APIKeySource_setByBody
=== RUN   TestAccAPIGatewayRestAPI_binaryMediaTypes
=== PAUSE TestAccAPIGatewayRestAPI_binaryMediaTypes
=== RUN   TestAccAPIGatewayRestAPI_BinaryMediaTypes_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_BinaryMediaTypes_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_BinaryMediaTypes_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_BinaryMediaTypes_setByBody
=== RUN   TestAccAPIGatewayRestAPI_body
=== PAUSE TestAccAPIGatewayRestAPI_body
=== RUN   TestAccAPIGatewayRestAPI_description
=== PAUSE TestAccAPIGatewayRestAPI_description
=== RUN   TestAccAPIGatewayRestAPI_Description_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_Description_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_Description_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_Description_setByBody
=== RUN   TestAccAPIGatewayRestAPI_disableExecuteAPIEndpoint
=== PAUSE TestAccAPIGatewayRestAPI_disableExecuteAPIEndpoint
=== RUN   TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_setByBody
=== RUN   TestAccAPIGatewayRestAPI_Endpoint_vpcEndpointIDs
=== PAUSE TestAccAPIGatewayRestAPI_Endpoint_vpcEndpointIDs
=== RUN   TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_mergeBody
=== PAUSE TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_mergeBody
=== RUN   TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideToMergeBody
=== PAUSE TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideToMergeBody
=== RUN   TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_setByBody
=== RUN   TestAccAPIGatewayRestAPI_minimumCompressionSize
=== PAUSE TestAccAPIGatewayRestAPI_minimumCompressionSize
=== RUN   TestAccAPIGatewayRestAPI_MinimumCompressionSize_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_MinimumCompressionSize_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_MinimumCompressionSize_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_MinimumCompressionSize_setByBody
=== RUN   TestAccAPIGatewayRestAPI_Name_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_Name_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_parameters
=== PAUSE TestAccAPIGatewayRestAPI_parameters
=== RUN   TestAccAPIGatewayRestAPI_Policy_basic
=== PAUSE TestAccAPIGatewayRestAPI_Policy_basic
=== RUN   TestAccAPIGatewayRestAPI_Policy_order
=== PAUSE TestAccAPIGatewayRestAPI_Policy_order
=== RUN   TestAccAPIGatewayRestAPI_Policy_overrideBody
=== PAUSE TestAccAPIGatewayRestAPI_Policy_overrideBody
=== RUN   TestAccAPIGatewayRestAPI_Policy_setByBody
=== PAUSE TestAccAPIGatewayRestAPI_Policy_setByBody
=== CONT  TestAccAPIGatewayRestAPI_basic
=== CONT  TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_setByBody
=== CONT  TestAccAPIGatewayRestAPI_BinaryMediaTypes_overrideBody
=== CONT  TestAccAPIGatewayRestAPI_Policy_overrideBody
=== CONT  TestAccAPIGatewayRestAPI_apiKeySource
=== CONT  TestAccAPIGatewayRestAPI_endpoint
=== CONT  TestAccAPIGatewayRestAPI_Endpoint_private
=== CONT  TestAccAPIGatewayRestAPI_Description_setByBody
=== CONT  TestAccAPIGatewayRestAPI_body
=== CONT  TestAccAPIGatewayRestAPI_MinimumCompressionSize_setByBody
=== CONT  TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideToMergeBody
=== CONT  TestAccAPIGatewayRestAPI_MinimumCompressionSize_overrideBody
=== CONT  TestAccAPIGatewayRestAPI_minimumCompressionSize
=== CONT  TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_setByBody
=== CONT  TestAccAPIGatewayRestAPI_tags
=== CONT  TestAccAPIGatewayRestAPI_Description_overrideBody
=== CONT  TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_overrideBody
=== CONT  TestAccAPIGatewayRestAPI_disableExecuteAPIEndpoint
=== CONT  TestAccAPIGatewayRestAPI_disappears
=== CONT  TestAccAPIGatewayRestAPI_Policy_setByBody
--- PASS: TestAccAPIGatewayRestAPI_Description_setByBody (49.36s)
=== CONT  TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideBody
--- PASS: TestAccAPIGatewayRestAPI_Endpoint_private (87.49s)
=== CONT  TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_mergeBody
--- PASS: TestAccAPIGatewayRestAPI_body (97.34s)
=== CONT  TestAccAPIGatewayRestAPI_APIKeySource_setByBody
--- PASS: TestAccAPIGatewayRestAPI_Description_overrideBody (111.97s)
=== CONT  TestAccAPIGatewayRestAPI_binaryMediaTypes
--- PASS: TestAccAPIGatewayRestAPI_minimumCompressionSize (146.03s)
=== CONT  TestAccAPIGatewayRestAPI_Policy_basic
--- PASS: TestAccAPIGatewayRestAPI_basic (200.47s)
=== CONT  TestAccAPIGatewayRestAPI_Endpoint_vpcEndpointIDs
--- PASS: TestAccAPIGatewayRestAPI_MinimumCompressionSize_setByBody (252.83s)
=== CONT  TestAccAPIGatewayRestAPI_parameters
--- PASS: TestAccAPIGatewayRestAPI_MinimumCompressionSize_overrideBody (281.87s)
=== CONT  TestAccAPIGatewayRestAPI_Name_overrideBody
--- PASS: TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_mergeBody (198.55s)
=== CONT  TestAccAPIGatewayRestAPI_Policy_order
--- PASS: TestAccAPIGatewayRestAPI_disableExecuteAPIEndpoint (291.08s)
=== CONT  TestAccAPIGatewayRestAPI_APIKeySource_overrideBody
--- PASS: TestAccAPIGatewayRestAPI_Name_overrideBody (49.68s)
=== CONT  TestAccAPIGatewayRestAPI_BinaryMediaTypes_setByBody
--- PASS: TestAccAPIGatewayRestAPI_BinaryMediaTypes_setByBody (22.03s)
=== CONT  TestAccAPIGatewayRestAPI_description
--- PASS: TestAccAPIGatewayRestAPI_APIKeySource_overrideBody (62.86s)
--- PASS: TestAccAPIGatewayRestAPI_description (36.61s)
--- PASS: TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_overrideBody (441.55s)
--- PASS: TestAccAPIGatewayRestAPI_binaryMediaTypes (361.91s)
--- PASS: TestAccAPIGatewayRestAPI_Policy_overrideBody (510.88s)
--- PASS: TestAccAPIGatewayRestAPI_Endpoint_vpcEndpointIDs (338.60s)
--- PASS: TestAccAPIGatewayRestAPI_Policy_basic (443.98s)
--- PASS: TestAccAPIGatewayRestAPI_parameters (370.58s)
--- PASS: TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_setByBody (653.05s)
--- PASS: TestAccAPIGatewayRestAPI_tags (654.13s)
--- PASS: TestAccAPIGatewayRestAPI_disappears (698.83s)
--- PASS: TestAccAPIGatewayRestAPI_Policy_setByBody (746.50s)
--- PASS: TestAccAPIGatewayRestAPI_BinaryMediaTypes_overrideBody (785.89s)
--- PASS: TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideToMergeBody (791.21s)
--- PASS: TestAccAPIGatewayRestAPI_DisableExecuteAPIEndpoint_setByBody (837.71s)
--- PASS: TestAccAPIGatewayRestAPI_Policy_order (600.00s)
--- PASS: TestAccAPIGatewayRestAPI_APIKeySource_setByBody (813.07s)
--- PASS: TestAccAPIGatewayRestAPI_endpoint (1012.46s)
--- PASS: TestAccAPIGatewayRestAPI_EndpointVPCEndpointIDs_overrideBody (1093.83s)
--- PASS: TestAccAPIGatewayRestAPI_apiKeySource (1162.23s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	1165.316s

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

• Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
• Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

[github-actions]

This functionality has been released in v4.50.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.