Class: AWS.Lambda

Inherits:
AWS.Service show all
Identifier:
lambda
API Version:
2015-03-31
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Lambda

var lambda = new AWS.Lambda();
lambda.addPermission(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Lambda object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lambda = new AWS.Lambda({apiVersion: '2015-03-31'});

You can also set the API version globally in AWS.config.apiVersions using the lambda service identifier:

AWS.config.apiVersions = {
  lambda: '2015-03-31',
  // other service API versions
};

var lambda = new AWS.Lambda();

Version:

  • 2015-03-31

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

new AWS.Lambda(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Lambda object

var lambda = new AWS.Lambda({apiVersion: '2015-03-31'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Lambda.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Lambda.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Lambda.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • clientSideMonitoring (Boolean)

    whether to collect and

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addPermission(params = {}, callback) ⇒ AWS.Request

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use the push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source permission to invoke the Lambda function.

Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:AddPermission action.

Service Reference:

Examples:

add-permission


/* This example adds a permission for an S3 bucket to invoke a Lambda function. */

 var params = {
  Action: "lambda:InvokeFunction", 
  FunctionName: "MyFunction", 
  Principal: "s3.amazonaws.com", 
  SourceAccount: "123456789012", 
  SourceArn: "arn:aws:s3:::examplebucket/*", 
  StatementId: "ID-1"
 };
 lambda.addPermission(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Statement: "ID-1"
   }
   */
 });

Calling the addPermission operation

var params = {
  Action: 'STRING_VALUE', /* required */
  FunctionName: 'STRING_VALUE', /* required */
  Principal: 'STRING_VALUE', /* required */
  StatementId: 'STRING_VALUE', /* required */
  EventSourceToken: 'STRING_VALUE',
  Qualifier: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE',
  SourceAccount: 'STRING_VALUE',
  SourceArn: 'STRING_VALUE'
};
lambda.addPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • StatementId — (String)

      A unique statement identifier.

    • Action — (String)

      The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.

    • Principal — (String)

      The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com or sns.amazonaws.com) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn parameter to limit who can invoke the function through that service.

    • SourceArn — (String)

      The Amazon Resource Name of the invoker.

      If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function.

    • SourceAccount — (String)

      This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.

    • EventSourceToken — (String)

      A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.

    • Qualifier — (String)

      Specify a version or alias to add permissions to a published version of the function.

    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Statement — (String)

        The permission statement you specified in the request. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAlias(params = {}, callback) ⇒ AWS.Request

Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.

Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.

Service Reference:

Examples:

Calling the createAlias operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  FunctionVersion: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RoutingConfig: {
    AdditionalVersionWeights: {
      '<AdditionalVersion>': 0.0,
      /* '<AdditionalVersion>': ... */
    }
  }
};
lambda.createAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Name — (String)

      Name for the alias you are creating.

    • FunctionVersion — (String)

      Lambda function version for which you are creating the alias.

    • Description — (String)

      Description of the alias.

    • RoutingConfig — (map)

      Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.

      • AdditionalVersionWeights — (map<Float>)

        The name of the second alias, and the percentage of traffic that is routed to it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AliasArn — (String)

        Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

      • Name — (String)

        Alias name.

      • FunctionVersion — (String)

        Function version to which the alias points.

      • Description — (String)

        Alias description.

      • RoutingConfig — (map)

        Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

        • AdditionalVersionWeights — (map<Float>)

          The name of the second alias, and the percentage of traffic that is routed to it.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEventSourceMapping(params = {}, callback) ⇒ AWS.Request

Identifies a poll-based event source for a Lambda function. It can be either an Amazon Kinesis or DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the event source.

This association between a poll-based source and a Lambda function is called the event source mapping.

You provide mapping information (for example, which stream or SQS queue to read from and which Lambda function to invoke) in the request body.

Amazon Kinesis or DynamoDB stream event sources can be associated with multiple AWS Lambda functions and a given Lambda function can be associated with multiple AWS event sources. For Amazon SQS, you can configure multiple queues as event sources for a single Lambda function, but an SQS queue can be mapped only to a single Lambda function.

You can configure an SQS queue in an account separate from your Lambda function's account. Also the queue needs to reside in the same AWS region as your function.

If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:CreateEventSourceMapping action.

Service Reference:

Examples:

Calling the createEventSourceMapping operation

var params = {
  EventSourceArn: 'STRING_VALUE', /* required */
  FunctionName: 'STRING_VALUE', /* required */
  BatchSize: 0,
  Enabled: true || false,
  StartingPosition: TRIM_HORIZON | LATEST | AT_TIMESTAMP,
  StartingPositionTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
lambda.createEventSourceMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EventSourceArn — (String)

      The Amazon Resource Name (ARN) of the event source.

    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Enabled — (Boolean)

      Set to false to disable the event source upon creation.

    • BatchSize — (Integer)

      The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default for Amazon Kinesis and Amazon DynamoDB is 100 records. Both the default and maximum for Amazon SQS are 10 messages.

    • StartingPosition — (String)

      The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading. For more information, see GetShardIterator in the Amazon Kinesis API Reference Guide or GetShardIterator in the Amazon DynamoDB API Reference Guide. The AT_TIMESTAMP value is supported only for Kinesis streams.

      Possible values include:
      • "TRIM_HORIZON"
      • "LATEST"
      • "AT_TIMESTAMP"
    • StartingPositionTimestamp — (Date)

      The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). Valid only for Kinesis streams.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UUID — (String)

        The AWS Lambda assigned opaque identifier for the mapping.

      • BatchSize — (Integer)

        The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

      • EventSourceArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream that is the source of events.

      • FunctionArn — (String)

        The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

      • LastModified — (Date)

        The UTC time string indicating the last time the event mapping was updated.

      • LastProcessingResult — (String)

        The result of the last AWS Lambda invocation of your Lambda function. This value will be null if an SQS queue is the event source.

      • State — (String)

        The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

      • StateTransitionReason — (String)

        The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFunction(params = {}, callback) ⇒ AWS.Request

Creates a new Lambda function. The function configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

Service Reference:

Examples:

create-function


/* This example creates a Lambda function. */

 var params = {
  Code: {
  }, 
  Description: "", 
  FunctionName: "MyFunction", 
  Handler: "souce_file.handler_name", // is of the form of the name of your source file and then name of your function handler
  MemorySize: 128, 
  Publish: true, 
  Role: "arn:aws:iam::123456789012:role/service-role/role-name", // replace with the actual arn of the execution role you created
  Runtime: "nodejs4.3", 
  Timeout: 15, 
  VpcConfig: {
  }
 };
 lambda.createFunction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CodeSha256: "", 
    CodeSize: 123, 
    Description: "", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:MyFunction", 
    FunctionName: "MyFunction", 
    Handler: "source_file.handler_name", 
    LastModified: "2016-11-21T19:49:20.006+0000", 
    MemorySize: 128, 
    Role: "arn:aws:iam::123456789012:role/service-role/role-name", 
    Runtime: "nodejs4.3", 
    Timeout: 123, 
    Version: "1", 
    VpcConfig: {
    }
   }
   */
 });

Calling the createFunction operation

var params = {
  Code: { /* required */
    S3Bucket: 'STRING_VALUE',
    S3Key: 'STRING_VALUE',
    S3ObjectVersion: 'STRING_VALUE',
    ZipFile: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
  },
  FunctionName: 'STRING_VALUE', /* required */
  Handler: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  Runtime: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | java8 | python2.7 | python3.6 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | nodejs4.3-edge | go1.x, /* required */
  DeadLetterConfig: {
    TargetArn: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  Environment: {
    Variables: {
      '<EnvironmentVariableName>': 'STRING_VALUE',
      /* '<EnvironmentVariableName>': ... */
    }
  },
  KMSKeyArn: 'STRING_VALUE',
  MemorySize: 0,
  Publish: true || false,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Timeout: 0,
  TracingConfig: {
    Mode: Active | PassThrough
  },
  VpcConfig: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
lambda.createFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Runtime — (String)

      The runtime version for the function.

      Possible values include:
      • "nodejs"
      • "nodejs4.3"
      • "nodejs6.10"
      • "nodejs8.10"
      • "java8"
      • "python2.7"
      • "python3.6"
      • "dotnetcore1.0"
      • "dotnetcore2.0"
      • "dotnetcore2.1"
      • "nodejs4.3-edge"
      • "go1.x"
    • Role — (String)

      The Amazon Resource Name (ARN) of the function's execution role.

    • Handler — (String)

      The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.

    • Code — (map)

      The code for the function.

      • ZipFile — (Buffer, Typed Array, Blob, String)

        The base64-encoded contents of your zip file containing your deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

      • S3Bucket — (String)

        An Amazon S3 bucket in the same region as your function.

      • S3Key — (String)

        The Amazon S3 key of the deployment package.

      • S3ObjectVersion — (String)

        For versioned objects, the version of the deployment package object to use.

    • Description — (String)

      A description of the function.

    • Timeout — (Integer)

      The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

    • MemorySize — (Integer)

      The amount of memory that your function has access to. Increasing the function's memory also increases it's CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

    • Publish — (Boolean)

      Set to true to publish the first version of the function during creation.

    • VpcConfig — (map)

      If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

      • SubnetIds — (Array<String>)

        A list of VPC subnet IDs.

      • SecurityGroupIds — (Array<String>)

        A list of VPC security groups IDs.

    • DeadLetterConfig — (map)

      A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

      • TargetArn — (String)

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • Environment — (map)

      Environment variables that are accessible from function code during execution.

      • Variables — (map<String>)

        Environment variable key-value pairs.

    • KMSKeyArn — (String)

      The ARN of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.

    • TracingConfig — (map)

      Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

      • Mode — (String)

        The tracing mode.

        Possible values include:
        • "Active"
        • "PassThrough"
    • Tags — (map<String>)

      The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name.

      • Runtime — (String)

        The runtime environment for the Lambda function.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "java8"
        • "python2.7"
        • "python3.6"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "nodejs4.3-edge"
        • "go1.x"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function Lambda calls to begin executing your function.

      • CodeSize — (Integer)

        The size of the function's deployment package in bytes.

      • Description — (String)

        The function's description.

      • Timeout — (Integer)

        The amount of time that Lambda allows a function to run before terminating it.

      • MemorySize — (Integer)

        The memory allocated to the function

      • LastModified — (String)

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 — (String)

        The SHA256 hash of the function's deployment package.

      • Version — (String)

        The version of the Lambda function.

      • VpcConfig — (map)

        The function's networking configuration.

        • SubnetIds — (Array<String>)

          A list of VPC subnet IDs.

        • SecurityGroupIds — (Array<String>)

          A list of VPC security groups IDs.

        • VpcId — (String)

          The ID of the VPC.

      • DeadLetterConfig — (map)

        The function's dead letter queue.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment — (map)

        The function's environment variables.

        • Variables — (map<String>)

          Environment variable key-value pairs.

        • Error — (map)

          Error messages for environment variables that could not be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

      • TracingConfig — (map)

        The function's AWS X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

          Possible values include:
          • "Active"
          • "PassThrough"
      • MasterArn — (String)

        The ARN of the master function.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAlias(params = {}, callback) ⇒ AWS.Request

Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:DeleteAlias action.

Service Reference:

Examples:

To delete a Lambda function alias


/* This operation deletes a Lambda function alias */

 var params = {
  FunctionName: "myFunction", 
  Name: "alias"
 };
 lambda.deleteAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteAlias operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
lambda.deleteAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Name — (String)

      Name of the alias to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEventSourceMapping(params = {}, callback) ⇒ AWS.Request

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

Service Reference:

Examples:

To delete a Lambda function event source mapping


/* This operation deletes a Lambda function event source mapping */

 var params = {
  UUID: "12345kxodurf3443"
 };
 lambda.deleteEventSourceMapping(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    BatchSize: 123, 
    EventSourceArn: "arn:aws:s3:::examplebucket/*", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    LastModified: <Date Representation>, 
    LastProcessingResult: "", 
    State: "", 
    StateTransitionReason: "", 
    UUID: "12345kxodurf3443"
   }
   */
 });

Calling the deleteEventSourceMapping operation

var params = {
  UUID: 'STRING_VALUE' /* required */
};
lambda.deleteEventSourceMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UUID — (String)

      The event source mapping ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UUID — (String)

        The AWS Lambda assigned opaque identifier for the mapping.

      • BatchSize — (Integer)

        The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

      • EventSourceArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream that is the source of events.

      • FunctionArn — (String)

        The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

      • LastModified — (Date)

        The UTC time string indicating the last time the event mapping was updated.

      • LastProcessingResult — (String)

        The result of the last AWS Lambda invocation of your Lambda function. This value will be null if an SQS queue is the event source.

      • State — (String)

        The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

      • StateTransitionReason — (String)

        The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFunction(params = {}, callback) ⇒ AWS.Request

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. Event source mappings are not deleted.

This operation requires permission for the lambda:DeleteFunction action.

Service Reference:

Examples:

To delete a Lambda function


/* This operation deletes a Lambda function */

 var params = {
  FunctionName: "myFunction", 
  Qualifier: "1"
 };
 lambda.deleteFunction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteFunction operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.deleteFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Qualifier — (String)

      Specify a version to delete. You cannot delete a version that is referenced by an alias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFunctionConcurrency(params = {}, callback) ⇒ AWS.Request

Removes concurrent execution limits from this function. For more information, see Managing Concurrency.

Service Reference:

Examples:

Calling the deleteFunctionConcurrency operation

var params = {
  FunctionName: 'STRING_VALUE' /* required */
};
lambda.deleteFunctionConcurrency(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Retrieves details about your account's limits and usage in a region.

Service Reference:

Examples:

To retrieves a Lambda customer's account settings


/* This operation retrieves a Lambda customer's account settings */

 var params = {
 };
 lambda.getAccountSettings(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AccountLimit: {
    }, 
    AccountUsage: {
    }
   }
   */
 });

Calling the getAccountSettings operation

var params = {
};
lambda.getAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountLimit — (map)

        Limits related to concurrency and code storage.

        • TotalCodeSize — (Integer)

          Maximum size, in bytes, of a code package you can upload per region. The default size is 75 GB.

        • CodeSizeUnzipped — (Integer)

          Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.

        • CodeSizeZipped — (Integer)

          Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.

        • ConcurrentExecutions — (Integer)

          Number of simultaneous executions of your function per region. The default limit is 1000.

        • UnreservedConcurrentExecutions — (Integer)

          The number of concurrent executions available to functions that do not have concurrency limits set. For more information, see Managing Concurrency.

      • AccountUsage — (map)

        The number of functions and amount of storage in use.

        • TotalCodeSize — (Integer)

          Total size, in bytes, of the account's deployment packages per region.

        • FunctionCount — (Integer)

          The number of your account's existing functions per region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAlias(params = {}, callback) ⇒ AWS.Request

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:GetAlias action.

Service Reference:

Examples:

To retrieve a Lambda function alias


/* This operation retrieves a Lambda function alias */

 var params = {
  FunctionName: "myFunction", 
  Name: "myFunctionAlias"
 };
 lambda.getAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AliasArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias", 
    Description: "", 
    FunctionVersion: "1", 
    Name: "myFunctionAlias"
   }
   */
 });

Calling the getAlias operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
lambda.getAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Name — (String)

      Name of the alias for which you want to retrieve information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AliasArn — (String)

        Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

      • Name — (String)

        Alias name.

      • FunctionVersion — (String)

        Function version to which the alias points.

      • Description — (String)

        Alias description.

      • RoutingConfig — (map)

        Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

        • AdditionalVersionWeights — (map<Float>)

          The name of the second alias, and the percentage of traffic that is routed to it.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEventSourceMapping(params = {}, callback) ⇒ AWS.Request

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).

This operation requires permission for the lambda:GetEventSourceMapping action.

Service Reference:

Examples:

To retrieve a Lambda function's event source mapping


/* This operation retrieves a Lambda function's event source mapping */

 var params = {
  UUID: "123489-xxxxx-kdla8d89d7"
 };
 lambda.getEventSourceMapping(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    BatchSize: 123, 
    EventSourceArn: "arn:aws:iam::123456789012:eventsource", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    LastModified: <Date Representation>, 
    LastProcessingResult: "", 
    State: "", 
    StateTransitionReason: "", 
    UUID: "123489-xxxxx-kdla8d89d7"
   }
   */
 });

Calling the getEventSourceMapping operation

var params = {
  UUID: 'STRING_VALUE' /* required */
};
lambda.getEventSourceMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UUID — (String)

      The AWS Lambda assigned ID of the event source mapping.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UUID — (String)

        The AWS Lambda assigned opaque identifier for the mapping.

      • BatchSize — (Integer)

        The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

      • EventSourceArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream that is the source of events.

      • FunctionArn — (String)

        The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

      • LastModified — (Date)

        The UTC time string indicating the last time the event mapping was updated.

      • LastProcessingResult — (String)

        The result of the last AWS Lambda invocation of your Lambda function. This value will be null if an SQS queue is the event source.

      • State — (String)

        The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

      • StateTransitionReason — (String)

        The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFunction(params = {}, callback) ⇒ AWS.Request

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

Use the Qualifier parameter to retrieve a published version of the function. Otherwise, returns the unpublished version ($LATEST). For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

Service Reference:

Examples:

To retrieve a Lambda function's event source mapping


/* This operation retrieves a Lambda function's event source mapping */

 var params = {
  FunctionName: "myFunction", 
  Qualifier: "1"
 };
 lambda.getFunction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Code: {
     Location: "somelocation", 
     RepositoryType: "S3"
    }, 
    Configuration: {
     CodeSha256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
     CodeSize: 262, 
     Description: "A starter AWS Lambda function.", 
     Environment: {
      Variables: {
       "S3_BUCKET": "test"
      }
     }, 
     FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
     FunctionName: "myFunction", 
     Handler: "index.handler", 
     LastModified: "2016-11-21T19:49:20.006+0000", 
     MemorySize: 128, 
     Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
     Runtime: "nodejs4.3", 
     Timeout: 3, 
     Version: "$LATEST", 
     VpcConfig: {
      SecurityGroupIds: [
      ], 
      SubnetIds: [
      ]
     }
    }
   }
   */
 });

Calling the getFunction operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.getFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Qualifier — (String)

      Specify a version or alias to get details about a published version of the function.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Configuration — (map)

        The function's configuration.

        • FunctionName — (String)

          The name of the function.

        • FunctionArn — (String)

          The function's Amazon Resource Name.

        • Runtime — (String)

          The runtime environment for the Lambda function.

          Possible values include:
          • "nodejs"
          • "nodejs4.3"
          • "nodejs6.10"
          • "nodejs8.10"
          • "java8"
          • "python2.7"
          • "python3.6"
          • "dotnetcore1.0"
          • "dotnetcore2.0"
          • "dotnetcore2.1"
          • "nodejs4.3-edge"
          • "go1.x"
        • Role — (String)

          The function's execution role.

        • Handler — (String)

          The function Lambda calls to begin executing your function.

        • CodeSize — (Integer)

          The size of the function's deployment package in bytes.

        • Description — (String)

          The function's description.

        • Timeout — (Integer)

          The amount of time that Lambda allows a function to run before terminating it.

        • MemorySize — (Integer)

          The memory allocated to the function

        • LastModified — (String)

          The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

        • CodeSha256 — (String)

          The SHA256 hash of the function's deployment package.

        • Version — (String)

          The version of the Lambda function.

        • VpcConfig — (map)

          The function's networking configuration.

          • SubnetIds — (Array<String>)

            A list of VPC subnet IDs.

          • SecurityGroupIds — (Array<String>)

            A list of VPC security groups IDs.

          • VpcId — (String)

            The ID of the VPC.

        • DeadLetterConfig — (map)

          The function's dead letter queue.

          • TargetArn — (String)

            The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

        • Environment — (map)

          The function's environment variables.

          • Variables — (map<String>)

            Environment variable key-value pairs.

          • Error — (map)

            Error messages for environment variables that could not be applied.

            • ErrorCode — (String)

              The error code.

            • Message — (String)

              The error message.

        • KMSKeyArn — (String)

          The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

        • TracingConfig — (map)

          The function's AWS X-Ray tracing configuration.

          • Mode — (String)

            The tracing mode.

            Possible values include:
            • "Active"
            • "PassThrough"
        • MasterArn — (String)

          The ARN of the master function.

        • RevisionId — (String)

          Represents the latest updated revision of the function or alias.

      • Code — (map)

        The function's code.

        • RepositoryType — (String)

          The repository from which you can download the function.

        • Location — (String)

          The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

      • Tags — (map<String>)

        Returns the list of tags associated with the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

      • Concurrency — (map)

        The concurrent execution limit set for this function. For more information, see Managing Concurrency.

        • ReservedConcurrentExecutions — (Integer)

          The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFunctionConfiguration(params = {}, callback) ⇒ AWS.Request

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

Service Reference:

Examples:

To retrieve a Lambda function's event source mapping


/* This operation retrieves a Lambda function's event source mapping */

 var params = {
  FunctionName: "myFunction", 
  Qualifier: "1"
 };
 lambda.getFunctionConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CodeSha256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
    CodeSize: 123, 
    DeadLetterConfig: {
    }, 
    Description: "", 
    Environment: {
    }, 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    FunctionName: "myFunction", 
    Handler: "index.handler", 
    KMSKeyArn: "", 
    LastModified: "2016-11-21T19:49:20.006+0000", 
    MemorySize: 128, 
    Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
    Runtime: "python2.7", 
    Timeout: 123, 
    Version: "1", 
    VpcConfig: {
    }
   }
   */
 });

Calling the getFunctionConfiguration operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.getFunctionConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Qualifier — (String)

      Specify a version or alias to get details about a published version of the function.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name.

      • Runtime — (String)

        The runtime environment for the Lambda function.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "java8"
        • "python2.7"
        • "python3.6"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "nodejs4.3-edge"
        • "go1.x"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function Lambda calls to begin executing your function.

      • CodeSize — (Integer)

        The size of the function's deployment package in bytes.

      • Description — (String)

        The function's description.

      • Timeout — (Integer)

        The amount of time that Lambda allows a function to run before terminating it.

      • MemorySize — (Integer)

        The memory allocated to the function

      • LastModified — (String)

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 — (String)

        The SHA256 hash of the function's deployment package.

      • Version — (String)

        The version of the Lambda function.

      • VpcConfig — (map)

        The function's networking configuration.

        • SubnetIds — (Array<String>)

          A list of VPC subnet IDs.

        • SecurityGroupIds — (Array<String>)

          A list of VPC security groups IDs.

        • VpcId — (String)

          The ID of the VPC.

      • DeadLetterConfig — (map)

        The function's dead letter queue.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment — (map)

        The function's environment variables.

        • Variables — (map<String>)

          Environment variable key-value pairs.

        • Error — (map)

          Error messages for environment variables that could not be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

      • TracingConfig — (map)

        The function's AWS X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

          Possible values include:
          • "Active"
          • "PassThrough"
      • MasterArn — (String)

        The ARN of the master function.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPolicy(params = {}, callback) ⇒ AWS.Request

Returns the resource policy associated with the specified Lambda function.

This action requires permission for the lambda:GetPolicy action.

Service Reference:

Examples:

To retrieve a Lambda function policy


/* This operation retrieves a Lambda function policy */

 var params = {
  FunctionName: "myFunction", 
  Qualifier: "1"
 };
 lambda.getPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: ""
   }
   */
 });

Calling the getPolicy operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.getPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Qualifier — (String)

      You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

        The resource policy associated with the specified function. The response returns the same as a string using a backslash ("\") as an escape character in the JSON.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

invoke(params = {}, callback) ⇒ AWS.Request

Invokes a Lambda function. For an example, see Create the Lambda Function and Test It Manually.

Specify just a function name to invoke the latest version of the function. To invoke a published version, use the Qualifier parameter to specify a version or alias.

If you use the RequestResponse (synchronous) invocation option, the function will be invoked only once. If you use the Event (asynchronous) invocation option, the function will be invoked at least once in response to an event and the function must be idempotent to handle this.

For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action.

The TooManyRequestsException noted below will return the following: ConcurrentInvocationLimitExceeded will be returned if you have no functions with reserved concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded will be returned when a function with reserved concurrency exceeds its configured concurrency limit.

Service Reference:

Examples:

To invoke a Lambda function


/* This operation invokes a Lambda function */

 var params = {
  ClientContext: "MyApp", 
  FunctionName: "MyFunction", 
  InvocationType: "Event", 
  LogType: "Tail", 
  Payload: <Binary String>, 
  Qualifier: "1"
 };
 lambda.invoke(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FunctionError: "", 
    LogResult: "", 
    Payload: <Binary String>, 
    StatusCode: 123
   }
   */
 });

Calling the invoke operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  ClientContext: 'STRING_VALUE',
  InvocationType: Event | RequestResponse | DryRun,
  LogType: None | Tail,
  Payload: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  Qualifier: 'STRING_VALUE'
};
lambda.invoke(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • InvocationType — (String)

      Choose from the following options.

      • RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.

      • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).

      • DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

      Possible values include:
      • "Event"
      • "RequestResponse"
      • "DryRun"
    • LogType — (String)

      You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

      Possible values include:
      • "None"
      • "Tail"
    • ClientContext — (String)

      Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

      The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.

      Note: ClientContext information is returned only if you use the synchronous (RequestResponse) invocation type.
    • Payload — (Buffer, Typed Array, Blob, String)

      JSON that you want to provide to your Lambda function as input.

    • Qualifier — (String)

      Specify a version or alias to invoke a published version of the function.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StatusCode — (Integer)

        The HTTP status code will be in the 200 range for successful request. For the RequestResponse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204.

      • FunctionError — (String)

        Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

      • LogResult — (String)

        It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested.

      • Payload — (Buffer, Typed Array, Blob, String)

        It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse.

        In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

      • ExecutedVersion — (String)

        The function version that has been executed. This value is returned only if the invocation type is RequestResponse. For more information, see Traffic Shifting Using Aliases.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

invokeAsync(params = {}, callback) ⇒ AWS.Request

For asynchronous function invocation, use Invoke.

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.

This operation requires permission for the lambda:InvokeFunction action.

Service Reference:

Examples:

To invoke a Lambda function asynchronously


/* This operation invokes a Lambda function asynchronously */

 var params = {
  FunctionName: "myFunction", 
  InvokeArgs: <Binary String>
 };
 lambda.invokeAsync(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Status: 123
   }
   */
 });

Calling the invokeAsync operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  InvokeArgs: new Buffer('...') || 'STRING_VALUE' || streamObject /* required */
};
lambda.invokeAsync(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • InvokeArgs — (Buffer, Typed Array, Blob, String, ReadableStream)

      JSON that you want to provide to your Lambda function as input.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (Integer)

        It will be 202 upon success.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAliases(params = {}, callback) ⇒ AWS.Request

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:ListAliases action.

Service Reference:

Examples:

To retrieve a Lambda function aliases


/* This operation retrieves a Lambda function's aliases */

 var params = {
  FunctionName: "myFunction", 
  FunctionVersion: "1", 
  Marker: "", 
  MaxItems: 123
 };
 lambda.listAliases(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Aliases: [
    ], 
    NextMarker: ""
   }
   */
 });

Calling the listAliases operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  FunctionVersion: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxItems: 0
};
lambda.listAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • FunctionVersion — (String)

      If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.

    • Marker — (String)

      Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.

    • MaxItems — (Integer)

      Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        A string, present if there are more aliases.

      • Aliases — (Array<map>)

        A list of aliases.

        • AliasArn — (String)

          Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

        • Name — (String)

          Alias name.

        • FunctionVersion — (String)

          Function version to which the alias points.

        • Description — (String)

          Alias description.

        • RoutingConfig — (map)

          Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

          • AdditionalVersionWeights — (map<Float>)

            The name of the second alias, and the percentage of traffic that is routed to it.

        • RevisionId — (String)

          Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEventSourceMappings(params = {}, callback) ⇒ AWS.Request

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSourceMappings action.

Service Reference:

Examples:

Calling the listEventSourceMappings operation

var params = {
  EventSourceArn: 'STRING_VALUE',
  FunctionName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxItems: 0
};
lambda.listEventSourceMappings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EventSourceArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream. (This parameter is optional.)

    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Marker — (String)

      Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

    • MaxItems — (Integer)

      Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        A string, present if there are more event source mappings.

      • EventSourceMappings — (Array<map>)

        An array of EventSourceMappingConfiguration objects.

        • UUID — (String)

          The AWS Lambda assigned opaque identifier for the mapping.

        • BatchSize — (Integer)

          The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

        • EventSourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream that is the source of events.

        • FunctionArn — (String)

          The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

        • LastModified — (Date)

          The UTC time string indicating the last time the event mapping was updated.

        • LastProcessingResult — (String)

          The result of the last AWS Lambda invocation of your Lambda function. This value will be null if an SQS queue is the event source.

        • State — (String)

          The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

        • StateTransitionReason — (String)

          The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFunctions(params = {}, callback) ⇒ AWS.Request

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

If you are using the versioning feature, you can list all of your functions or only $LATEST versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

Service Reference:

Examples:

To retrieve a list of Lambda functions


/* This operation retrieves a Lambda functions */

 var params = {
  Marker: "", 
  MaxItems: 123
 };
 lambda.listFunctions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Functions: [
    ], 
    NextMarker: ""
   }
   */
 });

Calling the listFunctions operation

var params = {
  FunctionVersion: ALL,
  Marker: 'STRING_VALUE',
  MasterRegion: 'STRING_VALUE',
  MaxItems: 0
};
lambda.listFunctions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MasterRegion — (String)

      Specify a region (e.g. us-east-2) to only list functions that were created in that region, or ALL to include functions replicated from any region. If specified, you also must specify the FunctionVersion.

    • FunctionVersion — (String)

      Set to ALL to list all published versions. If not specified, only the latest unpublished version ARN is returned.

      Possible values include:
      • "ALL"
    • Marker — (String)

      Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

    • MaxItems — (Integer)

      Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0. The absolute maximum of AWS Lambda functions that can be returned is 50.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        A string, present if there are more functions.

      • Functions — (Array<map>)

        A list of Lambda functions.

        • FunctionName — (String)

          The name of the function.

        • FunctionArn — (String)

          The function's Amazon Resource Name.

        • Runtime — (String)

          The runtime environment for the Lambda function.

          Possible values include:
          • "nodejs"
          • "nodejs4.3"
          • "nodejs6.10"
          • "nodejs8.10"
          • "java8"
          • "python2.7"
          • "python3.6"
          • "dotnetcore1.0"
          • "dotnetcore2.0"
          • "dotnetcore2.1"
          • "nodejs4.3-edge"
          • "go1.x"
        • Role — (String)

          The function's execution role.

        • Handler — (String)

          The function Lambda calls to begin executing your function.

        • CodeSize — (Integer)

          The size of the function's deployment package in bytes.

        • Description — (String)

          The function's description.

        • Timeout — (Integer)

          The amount of time that Lambda allows a function to run before terminating it.

        • MemorySize — (Integer)

          The memory allocated to the function

        • LastModified — (String)

          The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

        • CodeSha256 — (String)

          The SHA256 hash of the function's deployment package.

        • Version — (String)

          The version of the Lambda function.

        • VpcConfig — (map)

          The function's networking configuration.

          • SubnetIds — (Array<String>)

            A list of VPC subnet IDs.

          • SecurityGroupIds — (Array<String>)

            A list of VPC security groups IDs.

          • VpcId — (String)

            The ID of the VPC.

        • DeadLetterConfig — (map)

          The function's dead letter queue.

          • TargetArn — (String)

            The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

        • Environment — (map)

          The function's environment variables.

          • Variables — (map<String>)

            Environment variable key-value pairs.

          • Error — (map)

            Error messages for environment variables that could not be applied.

            • ErrorCode — (String)

              The error code.

            • Message — (String)

              The error message.

        • KMSKeyArn — (String)

          The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

        • TracingConfig — (map)

          The function's AWS X-Ray tracing configuration.

          • Mode — (String)

            The tracing mode.

            Possible values include:
            • "Active"
            • "PassThrough"
        • MasterArn — (String)

          The ARN of the master function.

        • RevisionId — (String)

          Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTags(params = {}, callback) ⇒ AWS.Request

Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  Resource: 'STRING_VALUE' /* required */
};
lambda.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Resource — (String)

      The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        The list of tags assigned to the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVersionsByFunction(params = {}, callback) ⇒ AWS.Request

Lists all versions of a function. For information about versioning, see AWS Lambda Function Versioning and Aliases.

Service Reference:

Examples:

To retrieve a list of Lambda function versions


/* This operation retrieves a Lambda function versions */

 var params = {
  FunctionName: "myFunction", 
  Marker: "", 
  MaxItems: 123
 };
 lambda.listVersionsByFunction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextMarker: "", 
    Versions: [
    ]
   }
   */
 });

Calling the listVersionsByFunction operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxItems: 0
};
lambda.listVersionsByFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Marker — (String)

      Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.

    • MaxItems — (Integer)

      Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        A string, present if there are more function versions.

      • Versions — (Array<map>)

        A list of Lambda function versions.

        • FunctionName — (String)

          The name of the function.

        • FunctionArn — (String)

          The function's Amazon Resource Name.

        • Runtime — (String)

          The runtime environment for the Lambda function.

          Possible values include:
          • "nodejs"
          • "nodejs4.3"
          • "nodejs6.10"
          • "nodejs8.10"
          • "java8"
          • "python2.7"
          • "python3.6"
          • "dotnetcore1.0"
          • "dotnetcore2.0"
          • "dotnetcore2.1"
          • "nodejs4.3-edge"
          • "go1.x"
        • Role — (String)

          The function's execution role.

        • Handler — (String)

          The function Lambda calls to begin executing your function.

        • CodeSize — (Integer)

          The size of the function's deployment package in bytes.

        • Description — (String)

          The function's description.

        • Timeout — (Integer)

          The amount of time that Lambda allows a function to run before terminating it.

        • MemorySize — (Integer)

          The memory allocated to the function

        • LastModified — (String)

          The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

        • CodeSha256 — (String)

          The SHA256 hash of the function's deployment package.

        • Version — (String)

          The version of the Lambda function.

        • VpcConfig — (map)

          The function's networking configuration.

          • SubnetIds — (Array<String>)

            A list of VPC subnet IDs.

          • SecurityGroupIds — (Array<String>)

            A list of VPC security groups IDs.

          • VpcId — (String)

            The ID of the VPC.

        • DeadLetterConfig — (map)

          The function's dead letter queue.

          • TargetArn — (String)

            The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

        • Environment — (map)

          The function's environment variables.

          • Variables — (map<String>)

            Environment variable key-value pairs.

          • Error — (map)

            Error messages for environment variables that could not be applied.

            • ErrorCode — (String)

              The error code.

            • Message — (String)

              The error message.

        • KMSKeyArn — (String)

          The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

        • TracingConfig — (map)

          The function's AWS X-Ray tracing configuration.

          • Mode — (String)

            The tracing mode.

            Possible values include:
            • "Active"
            • "PassThrough"
        • MasterArn — (String)

          The ARN of the master function.

        • RevisionId — (String)

          Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

publishVersion(params = {}, callback) ⇒ AWS.Request

Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

Service Reference:

Examples:

To publish a version of a Lambda function


/* This operation publishes a version of a Lambda function */

 var params = {
  CodeSha256: "", 
  Description: "", 
  FunctionName: "myFunction"
 };
 lambda.publishVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CodeSha256: "", 
    CodeSize: 123, 
    Description: "", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    FunctionName: "myFunction", 
    Handler: "index.handler", 
    LastModified: "2016-11-21T19:49:20.006+0000", 
    MemorySize: 128, 
    Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
    Runtime: "python2.7", 
    Timeout: 123, 
    Version: "1", 
    VpcConfig: {
    }
   }
   */
 });

Calling the publishVersion operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  CodeSha256: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE'
};
lambda.publishVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • CodeSha256 — (String)

      The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.

    • Description — (String)

      The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.

    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name.

      • Runtime — (String)

        The runtime environment for the Lambda function.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "java8"
        • "python2.7"
        • "python3.6"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "nodejs4.3-edge"
        • "go1.x"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function Lambda calls to begin executing your function.

      • CodeSize — (Integer)

        The size of the function's deployment package in bytes.

      • Description — (String)

        The function's description.

      • Timeout — (Integer)

        The amount of time that Lambda allows a function to run before terminating it.

      • MemorySize — (Integer)

        The memory allocated to the function

      • LastModified — (String)

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 — (String)

        The SHA256 hash of the function's deployment package.

      • Version — (String)

        The version of the Lambda function.

      • VpcConfig — (map)

        The function's networking configuration.

        • SubnetIds — (Array<String>)

          A list of VPC subnet IDs.

        • SecurityGroupIds — (Array<String>)

          A list of VPC security groups IDs.

        • VpcId — (String)

          The ID of the VPC.

      • DeadLetterConfig — (map)

        The function's dead letter queue.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment — (map)

        The function's environment variables.

        • Variables — (map<String>)

          Environment variable key-value pairs.

        • Error — (map)

          Error messages for environment variables that could not be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

      • TracingConfig — (map)

        The function's AWS X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

          Possible values include:
          • "Active"
          • "PassThrough"
      • MasterArn — (String)

        The ARN of the master function.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putFunctionConcurrency(params = {}, callback) ⇒ AWS.Request

Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see Managing Concurrency.

Service Reference:

Examples:

Calling the putFunctionConcurrency operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  ReservedConcurrentExecutions: 0 /* required */
};
lambda.putFunctionConcurrency(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • ReservedConcurrentExecutions — (Integer)

      The concurrent execution limit reserved for this function.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedConcurrentExecutions — (Integer)

        The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removePermission(params = {}, callback) ⇒ AWS.Request

Removes permissions from a function. You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. When you remove permissions, disable the event source mapping or trigger configuration first to avoid errors.

Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

You need permission for the lambda:RemovePermission action.

Service Reference:

Examples:

To remove a Lambda function's permissions


/* This operation removes a Lambda function's permissions */

 var params = {
  FunctionName: "myFunction", 
  Qualifier: "1", 
  StatementId: "role-statement-id"
 };
 lambda.removePermission(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the removePermission operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  StatementId: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE'
};
lambda.removePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • StatementId — (String)

      Statement ID of the permission to remove.

    • Qualifier — (String)

      Specify a version or alias to remove permissions from a published version of the function.

    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  Resource: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lambda.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Resource — (String)

      The ARN (Amazon Resource Name) of the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

    • Tags — (map<String>)

      The list of tags (key-value pairs) you are assigning to the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  Resource: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
lambda.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Resource — (String)

      The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

    • TagKeys — (Array<String>)

      The list of tag keys to be deleted from the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAlias(params = {}, callback) ⇒ AWS.Request

Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:UpdateAlias action.

Service Reference:

Examples:

To update a Lambda function alias


/* This operation updates a Lambda function alias */

 var params = {
  Description: "", 
  FunctionName: "myFunction", 
  FunctionVersion: "1", 
  Name: "functionAlias"
 };
 lambda.updateAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AliasArn: "arn:aws:lambda:us-west-2:123456789012:function:functionAlias", 
    Description: "", 
    FunctionVersion: "1", 
    Name: "functionAlias"
   }
   */
 });

Calling the updateAlias operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  FunctionVersion: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE',
  RoutingConfig: {
    AdditionalVersionWeights: {
      '<AdditionalVersion>': 0.0,
      /* '<AdditionalVersion>': ... */
    }
  }
};
lambda.updateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Name — (String)

      The alias name.

    • FunctionVersion — (String)

      Using this parameter you can change the Lambda function version to which the alias points.

    • Description — (String)

      You can change the description of the alias using this parameter.

    • RoutingConfig — (map)

      Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.

      • AdditionalVersionWeights — (map<Float>)

        The name of the second alias, and the percentage of traffic that is routed to it.

    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AliasArn — (String)

        Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

      • Name — (String)

        Alias name.

      • FunctionVersion — (String)

        Function version to which the alias points.

      • Description — (String)

        Alias description.

      • RoutingConfig — (map)

        Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.

        • AdditionalVersionWeights — (map<Float>)

          The name of the second alias, and the percentage of traffic that is routed to it.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEventSourceMapping(params = {}, callback) ⇒ AWS.Request

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

Service Reference:

Examples:

To update a Lambda function event source mapping


/* This operation updates a Lambda function event source mapping */

 var params = {
  BatchSize: 123, 
  Enabled: true, 
  FunctionName: "myFunction", 
  UUID: "1234xCy789012"
 };
 lambda.updateEventSourceMapping(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    BatchSize: 123, 
    EventSourceArn: "arn:aws:s3:::examplebucket/*", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    LastModified: <Date Representation>, 
    LastProcessingResult: "", 
    State: "", 
    StateTransitionReason: "", 
    UUID: "1234xCy789012"
   }
   */
 });

Calling the updateEventSourceMapping operation

var params = {
  UUID: 'STRING_VALUE', /* required */
  BatchSize: 0,
  Enabled: true || false,
  FunctionName: 'STRING_VALUE'
};
lambda.updateEventSourceMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UUID — (String)

      The event source mapping identifier.

    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Enabled — (Boolean)

      Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

    • BatchSize — (Integer)

      The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UUID — (String)

        The AWS Lambda assigned opaque identifier for the mapping.

      • BatchSize — (Integer)

        The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

      • EventSourceArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream that is the source of events.

      • FunctionArn — (String)

        The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.

      • LastModified — (Date)

        The UTC time string indicating the last time the event mapping was updated.

      • LastProcessingResult — (String)

        The result of the last AWS Lambda invocation of your Lambda function. This value will be null if an SQS queue is the event source.

      • State — (String)

        The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

      • StateTransitionReason — (String)

        The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFunctionCode(params = {}, callback) ⇒ AWS.Request

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionCode action.

Service Reference:

Examples:

To update a Lambda function's code


/* This operation updates a Lambda function's code */

 var params = {
  FunctionName: "myFunction", 
  Publish: true, 
  S3Bucket: "myBucket", 
  S3Key: "myKey", 
  S3ObjectVersion: "1", 
  ZipFile: <Binary String>
 };
 lambda.updateFunctionCode(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CodeSha256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
    CodeSize: 123, 
    Description: "", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    FunctionName: "myFunction", 
    Handler: "index.handler", 
    LastModified: "2016-11-21T19:49:20.006+0000", 
    MemorySize: 128, 
    Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
    Runtime: "python2.7", 
    Timeout: 123, 
    Version: "1", 
    VpcConfig: {
    }
   }
   */
 });

Calling the updateFunctionCode operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  DryRun: true || false,
  Publish: true || false,
  RevisionId: 'STRING_VALUE',
  S3Bucket: 'STRING_VALUE',
  S3Key: 'STRING_VALUE',
  S3ObjectVersion: 'STRING_VALUE',
  ZipFile: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
};
lambda.updateFunctionCode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • ZipFile — (Buffer, Typed Array, Blob, String)

      The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.

    • S3Bucket — (String)

      Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.

    • S3Key — (String)

      The Amazon S3 object (the deployment package) key name you want to upload.

    • S3ObjectVersion — (String)

      The Amazon S3 object (the deployment package) version you want to upload.

    • Publish — (Boolean)

      This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

    • DryRun — (Boolean)

      This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256 hash value of the provided code will also be computed and returned in the response.

    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either using using either GetFunction or GetAlias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name.

      • Runtime — (String)

        The runtime environment for the Lambda function.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "java8"
        • "python2.7"
        • "python3.6"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "nodejs4.3-edge"
        • "go1.x"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function Lambda calls to begin executing your function.

      • CodeSize — (Integer)

        The size of the function's deployment package in bytes.

      • Description — (String)

        The function's description.

      • Timeout — (Integer)

        The amount of time that Lambda allows a function to run before terminating it.

      • MemorySize — (Integer)

        The memory allocated to the function

      • LastModified — (String)

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 — (String)

        The SHA256 hash of the function's deployment package.

      • Version — (String)

        The version of the Lambda function.

      • VpcConfig — (map)

        The function's networking configuration.

        • SubnetIds — (Array<String>)

          A list of VPC subnet IDs.

        • SecurityGroupIds — (Array<String>)

          A list of VPC security groups IDs.

        • VpcId — (String)

          The ID of the VPC.

      • DeadLetterConfig — (map)

        The function's dead letter queue.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment — (map)

        The function's environment variables.

        • Variables — (map<String>)

          Environment variable key-value pairs.

        • Error — (map)

          Error messages for environment variables that could not be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

      • TracingConfig — (map)

        The function's AWS X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

          Possible values include:
          • "Active"
          • "PassThrough"
      • MasterArn — (String)

        The ARN of the master function.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFunctionConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

Service Reference:

Examples:

To update a Lambda function's configuration


/* This operation updates a Lambda function's configuration */

 var params = {
  Description: "", 
  FunctionName: "myFunction", 
  Handler: "index.handler", 
  MemorySize: 128, 
  Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
  Runtime: "python2.7", 
  Timeout: 123, 
  VpcConfig: {
  }
 };
 lambda.updateFunctionConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CodeSha256: "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", 
    CodeSize: 123, 
    Description: "", 
    FunctionArn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
    FunctionName: "myFunction", 
    Handler: "index.handler", 
    LastModified: "2016-11-21T19:49:20.006+0000", 
    MemorySize: 128, 
    Role: "arn:aws:iam::123456789012:role/lambda_basic_execution", 
    Runtime: "python2.7", 
    Timeout: 123, 
    Version: "1", 
    VpcConfig: {
    }
   }
   */
 });

Calling the updateFunctionConfiguration operation

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  DeadLetterConfig: {
    TargetArn: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  Environment: {
    Variables: {
      '<EnvironmentVariableName>': 'STRING_VALUE',
      /* '<EnvironmentVariableName>': ... */
    }
  },
  Handler: 'STRING_VALUE',
  KMSKeyArn: 'STRING_VALUE',
  MemorySize: 0,
  RevisionId: 'STRING_VALUE',
  Role: 'STRING_VALUE',
  Runtime: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | java8 | python2.7 | python3.6 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | nodejs4.3-edge | go1.x,
  Timeout: 0,
  TracingConfig: {
    Mode: Active | PassThrough
  },
  VpcConfig: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
lambda.updateFunctionConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionName — (String)

      The name of the lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • Role — (String)

      The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

    • Handler — (String)

      The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

    • Description — (String)

      A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

    • Timeout — (Integer)

      The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

    • MemorySize — (Integer)

      The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

    • VpcConfig — (map)

      Specify security groups and subnets in a VPC to which your Lambda function needs access.

      • SubnetIds — (Array<String>)

        A list of VPC subnet IDs.

      • SecurityGroupIds — (Array<String>)

        A list of VPC security groups IDs.

    • Environment — (map)

      The parent object that contains your environment's configuration settings.

      • Variables — (map<String>)

        Environment variable key-value pairs.

    • Runtime — (String)

      The runtime version for the function.

      Possible values include:
      • "nodejs"
      • "nodejs4.3"
      • "nodejs6.10"
      • "nodejs8.10"
      • "java8"
      • "python2.7"
      • "python3.6"
      • "dotnetcore1.0"
      • "dotnetcore2.0"
      • "dotnetcore2.1"
      • "nodejs4.3-edge"
      • "go1.x"
    • DeadLetterConfig — (map)

      A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

      • TargetArn — (String)

        The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    • KMSKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.

    • TracingConfig — (map)

      Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

      • Mode — (String)

        The tracing mode.

        Possible values include:
        • "Active"
        • "PassThrough"
    • RevisionId — (String)

      An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name.

      • Runtime — (String)

        The runtime environment for the Lambda function.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "java8"
        • "python2.7"
        • "python3.6"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "nodejs4.3-edge"
        • "go1.x"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function Lambda calls to begin executing your function.

      • CodeSize — (Integer)

        The size of the function's deployment package in bytes.

      • Description — (String)

        The function's description.

      • Timeout — (Integer)

        The amount of time that Lambda allows a function to run before terminating it.

      • MemorySize — (Integer)

        The memory allocated to the function

      • LastModified — (String)

        The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).

      • CodeSha256 — (String)

        The SHA256 hash of the function's deployment package.

      • Version — (String)

        The version of the Lambda function.

      • VpcConfig — (map)

        The function's networking configuration.

        • SubnetIds — (Array<String>)

          A list of VPC subnet IDs.

        • SecurityGroupIds — (Array<String>)

          A list of VPC security groups IDs.

        • VpcId — (String)

          The ID of the VPC.

      • DeadLetterConfig — (map)

        The function's dead letter queue.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

      • Environment — (map)

        The function's environment variables.

        • Variables — (map<String>)

          Environment variable key-value pairs.

        • Error — (map)

          Error messages for environment variables that could not be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.

      • TracingConfig — (map)

        The function's AWS X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

          Possible values include:
          • "Active"
          • "PassThrough"
      • MasterArn — (String)

        The ARN of the master function.

      • RevisionId — (String)

        Represents the latest updated revision of the function or alias.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.