Error: KeyError Data

Issue

Connection syncs fail, and the API response returns the following error:

KeyError data

Environment

Connector: AWS Lambda

Resolution

To troubleshoot this issue, follow these steps:

1. Review the Lamba logs in CloudWatch.

   i. Go to the AWS Console.

   ii. Navigate to Lambda and select the relevant function.

   iii. Select the Monitor tab, then click View CloudWatch logs.

   iv. Find the log stream for the failure timestamp and review the API response.

2. Validate the Lambda function response.

   i. Make sure the api_response function in your Lambda script can handle unexpected API responses.

   ii. Use response.get('data') instead of response['data'] to avoid a KeyError.

3. Check for third party API changes.

   i. Confirm whether the vendor changed the API response structure.

   ii. If the structure changed, update the code to accommodate the new structure.

4. Add a try-except block around the code that accesses the data field, and log the full response when the field is missing.

5. If the API structure changed unexpectedly, contact the vendor for clarification.

6. Test the function locally or in a development environment to confirm that the error is resolved.

Cause

This issue occurs when the third-party API returns an unexpected response structure. For example, the response may be missing the expected data field due to an API change, a temporary vendor issue, or an unhandled edge case.

When this happens, the Lambda function tries to access the missing field using response['data']. Since the field does not exist, the function raises a KeyError, causing the sync to fail.