Creating API gateway api keys in Lambda

Question

I'm trying to create API Gateway api keys in lambda using the sdk, but I can't seem to make it work Here's my code

exports.handler = (event, context, callback) => {
        var apigateway = new AWS.APIGateway({apiVersion: '2015-07-09'});
        var params = {
      description: 'desc',
      enabled: true,
      generateDistinctId: true,
      name: 'apiKey1',
      value: 'qwerty'
    };
    apigateway.createApiKey(params, function(err, data) {
      if (err) console.log(err, err.stack); // an error occurred
      else     console.log(data);           // successful response
    });
}

The function just times out after 1 minute, without logging anything at all to CloudWatch. It feels like the callback is never actually called. Here are the policies attached to the function's role: Anyone know what I'm missing?

@Michael-sqlbot Calling the callback is not a must unless you set, context.callbackWaitsForEmptyEventLoop=false; Otherwise it should detect for empty event loop and exit — Kannaiyan
– Kannaiyan, Commented Oct 6, 2017 at 17:53

Ashan · Accepted Answer · 2017-10-06 17:15:30Z

You need to call the callback method, upon createKey success and error to avoid timeout.

exports.handler = (event, context, callback) => {
  var apigateway = new AWS.APIGateway({apiVersion: '2015-07-09'});
  var params = {
      description: 'desc',
      enabled: true,
      generateDistinctId: true,
      name: 'apiKey1',
      value: 'qwerty'
    };
    apigateway.createApiKey(params, function(err, data) {
      if (err) { 
          console.log(err, err.stack); // an error occurredelse
          callback(err);
      } else {
          console.log(data); // successful response
          callback(null, data);
      }
    });
}

Kannaiyan · Accepted Answer · 2017-10-04 13:53:27Z

Parameters are not matching as documented,

var params = {
  customerId: 'STRING_VALUE',
  description: 'STRING_VALUE',
  enabled: true || false,
  generateDistinctId: true || false,
  name: 'STRING_VALUE',
  stageKeys: [
    {
      restApiId: 'STRING_VALUE',
      stageName: 'STRING_VALUE'
    },
    /* more items */
  ],
  value: 'STRING_VALUE'
};
apigateway.createApiKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

stageKeys is missing.

Hope it helps.

I tried it with stage keys as well, but it didn't change a thing. Stage keys are deprecated too, since I am using usage plans.

洪偉豪 · Accepted Answer · 2023-09-17 04:54:40Z

You have to set the internet connectivity with lambda since the createAPIKey function sends the internet request to the lambda function. If you are using VPC for your lambda, that means you can only connect within VPC. You will need a NAT service to connect to the internet. If you don't use VPC for your lambda, lambda is connecting to the internet by default. In your case, you seem to be setting the lambda with VPC, so you can't receive the request sent by the API gateway (request to create API keys).

Solution:

If your lambda has VPC groups, create a NAT to connect with your lambda. Link
Detach your lambda with original VPC groups and it will automatically connect to the internet. (This is a dangerous approach, but if you are in a testing environment, you can use this method to check the timeout problem.)

This does not provide an answer to the question. Once you have sufficient reputation you will be able to comment on any post; instead, provide answers that don't require clarification from the asker. - From Review
I've updated the answer! These two methods solve my problem. I am not sure if this answer to the question is clear enough.

Collectives™ on Stack Overflow

Creating API gateway api keys in Lambda

3 Answers 3

Comments

1 Comment

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

2 Comments

Related