Class: AWS.Lambda

var params = {
  Action: 'STRING_VALUE', /* required */
  FunctionName: 'STRING_VALUE', /* required */
  Principal: 'STRING_VALUE', /* required */
  StatementId: 'STRING_VALUE', /* required */
  EventSourceToken: 'STRING_VALUE',
  FunctionUrlAuthType: NONE | AWS_IAM,
  PrincipalOrgID: '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 or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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 statement identifier that differentiates the statement from others in the same policy.

  • Action — (String)

    The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

  • Principal — (String)

    The Amazon Web Servicesservice or Amazon Web Services account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

  • SourceArn — (String)

    For Amazon Web Servicesservices, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

    Note that Lambda configures the comparison using the StringLike operator.

  • SourceAccount — (String)

    For Amazon Web Servicesservice, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

  • EventSourceToken — (String)

    For Alexa Smart Home functions, a token that the invoker must supply.

  • Qualifier — (String)

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

  • RevisionId — (String)

    Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

  • PrincipalOrgID — (String)

    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

  • FunctionUrlAuthType — (String)

    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

    Possible values include:
    • "NONE"
    • "AWS_IAM"

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 that's added to the function policy.

Returns:

• (AWS.Request) —

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

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  FunctionVersion: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RoutingConfig: {
    AdditionalVersionWeights: {
      '<AdditionalVersion>': 'NUMBER_VALUE',
      /* '<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 or ARN 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 name of the alias.

  • FunctionVersion — (String)

    The function version that the alias invokes.

  • Description — (String)

    A description of the alias.

  • RoutingConfig — (map)

    The routing configuration of the alias.

    • AdditionalVersionWeights — (map<Float>)

      The second version, and the percentage of traffic that's 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)

      The Amazon Resource Name (ARN) of the alias.

    • Name — (String)

      The name of the alias.

    • FunctionVersion — (String)

      The function version that the alias invokes.

    • Description — (String)

      A description of the alias.

    • RoutingConfig — (map)

      The routing configuration of the alias.

      • AdditionalVersionWeights — (map<Float>)

        The second version, and the percentage of traffic that's routed to it.

    • RevisionId — (String)

      A unique identifier that changes when you update the alias.

Returns:

• (AWS.Request) —

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

var params = {
  AllowedPublishers: { /* required */
    SigningProfileVersionArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  CodeSigningPolicies: {
    UntrustedArtifactOnDeployment: Warn | Enforce
  },
  Description: 'STRING_VALUE'
};
lambda.createCodeSigningConfig(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: {}) —
  • Description — (String)

    Descriptive name for this code signing configuration.

  • AllowedPublishers — (map)

    Signing profiles for this code signing configuration.

    • SigningProfileVersionArns — required — (Array<String>)

      The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

  • CodeSigningPolicies — (map)

    The code signing policies define the actions to take if the validation checks fail.

    • UntrustedArtifactOnDeployment — (String)

      Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

      Default value: Warn

      Possible values include:
      • "Warn"
      • "Enforce"

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:

    • CodeSigningConfig — (map)

      The code signing configuration.

      • CodeSigningConfigId — required — (String)

        Unique identifer for the Code signing configuration.

      • CodeSigningConfigArn — required — (String)

        The Amazon Resource Name (ARN) of the Code signing configuration.

      • Description — (String)

        Code signing configuration description.

      • AllowedPublishers — required — (map)

        List of allowed publishers.

        • SigningProfileVersionArns — required — (Array<String>)

          The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

      • CodeSigningPolicies — required — (map)

        The code signing policy controls the validation failure action for signature mismatch or expiry.

        • UntrustedArtifactOnDeployment — (String)

          Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

          Default value: Warn

          Possible values include:
          • "Warn"
          • "Enforce"
      • LastModified — required — (String)

        The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

• (AWS.Request) —

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

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  AmazonManagedKafkaEventSourceConfig: {
    ConsumerGroupId: 'STRING_VALUE'
  },
  BatchSize: 'NUMBER_VALUE',
  BisectBatchOnFunctionError: true || false,
  DestinationConfig: {
    OnFailure: {
      Destination: 'STRING_VALUE'
    },
    OnSuccess: {
      Destination: 'STRING_VALUE'
    }
  },
  DocumentDBEventSourceConfig: {
    CollectionName: 'STRING_VALUE',
    DatabaseName: 'STRING_VALUE',
    FullDocument: UpdateLookup | Default
  },
  Enabled: true || false,
  EventSourceArn: 'STRING_VALUE',
  FilterCriteria: {
    Filters: [
      {
        Pattern: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  FunctionResponseTypes: [
    ReportBatchItemFailures,
    /* more items */
  ],
  KMSKeyArn: 'STRING_VALUE',
  MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
  MaximumRecordAgeInSeconds: 'NUMBER_VALUE',
  MaximumRetryAttempts: 'NUMBER_VALUE',
  ParallelizationFactor: 'NUMBER_VALUE',
  Queues: [
    'STRING_VALUE',
    /* more items */
  ],
  ScalingConfig: {
    MaximumConcurrency: 'NUMBER_VALUE'
  },
  SelfManagedEventSource: {
    Endpoints: {
      '<EndPointType>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<EndPointType>': ... */
    }
  },
  SelfManagedKafkaEventSourceConfig: {
    ConsumerGroupId: 'STRING_VALUE'
  },
  SourceAccessConfigurations: [
    {
      Type: BASIC_AUTH | VPC_SUBNET | VPC_SECURITY_GROUP | SASL_SCRAM_512_AUTH | SASL_SCRAM_256_AUTH | VIRTUAL_HOST | CLIENT_CERTIFICATE_TLS_AUTH | SERVER_ROOT_CA_CERTIFICATE,
      URI: 'STRING_VALUE'
    },
    /* more items */
  ],
  StartingPosition: TRIM_HORIZON | LATEST | AT_TIMESTAMP,
  StartingPositionTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Topics: [
    'STRING_VALUE',
    /* more items */
  ],
  TumblingWindowInSeconds: 'NUMBER_VALUE'
};
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.

    • Amazon Kinesis – The ARN of the data stream or a stream consumer.

    • Amazon DynamoDB Streams – The ARN of the stream.

    • Amazon Simple Queue Service – The ARN of the queue.

    • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    • Amazon MQ – The ARN of the broker.

    • Amazon DocumentDB – The ARN of the DocumentDB change stream.

  • FunctionName — (String)

    The name or ARN 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's limited to 64 characters in length.

  • Enabled — (Boolean)

    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

    Default: True

  • BatchSize — (Integer)

    The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

    • Amazon Kinesis – Default 100. Max 10,000.

    • Amazon DynamoDB Streams – Default 100. Max 10,000.

    • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    • Self-managed Apache Kafka – Default 100. Max 10,000.

    • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    • DocumentDB – Default 100. Max 10,000.

  • FilterCriteria — (map)

    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

    • Filters — (Array<map>)

      A list of filters.

      • Pattern — (String)

        A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

  • MaximumBatchingWindowInSeconds — (Integer)

    The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

    For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

    Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

  • ParallelizationFactor — (Integer)

    (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

  • StartingPosition — (String)

    The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

  • DestinationConfig — (map)

    (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

    • OnSuccess — (map)

      The destination configuration for successful invocations.

      • Destination — (String)

        The Amazon Resource Name (ARN) of the destination resource.

    • OnFailure — (map)

      The destination configuration for failed invocations.

      • Destination — (String)

        The Amazon Resource Name (ARN) of the destination resource.

        To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

        To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

        To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

  • MaximumRecordAgeInSeconds — (Integer)

    (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

  • BisectBatchOnFunctionError — (Boolean)

    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

  • MaximumRetryAttempts — (Integer)

    (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • TumblingWindowInSeconds — (Integer)

    (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

  • Topics — (Array<String>)

    The name of the Kafka topic.

  • Queues — (Array<String>)

    (MQ) The name of the Amazon MQ broker destination queue to consume.

  • SourceAccessConfigurations — (Array<map>)

    An array of authentication protocols or VPC components required to secure your event source.

    • Type — (String)

      The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

      • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

      • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

      • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

      • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

      • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

      • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

      • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

      • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

      • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

      Possible values include:
      • "BASIC_AUTH"
      • "VPC_SUBNET"
      • "VPC_SECURITY_GROUP"
      • "SASL_SCRAM_512_AUTH"
      • "SASL_SCRAM_256_AUTH"
      • "VIRTUAL_HOST"
      • "CLIENT_CERTIFICATE_TLS_AUTH"
      • "SERVER_ROOT_CA_CERTIFICATE"
    • URI — (String)

      The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

  • SelfManagedEventSource — (map)

    The self-managed Apache Kafka cluster to receive records from.

    • Endpoints — (map<Array<String>>)

      The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

  • FunctionResponseTypes — (Array<String>)

    (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

  • AmazonManagedKafkaEventSourceConfig — (map)

    Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    • ConsumerGroupId — (String)

      The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

  • SelfManagedKafkaEventSourceConfig — (map)

    Specific configuration settings for a self-managed Apache Kafka event source.

    • ConsumerGroupId — (String)

      The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

  • ScalingConfig — (map)

    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

    • MaximumConcurrency — (Integer)

      Limits the number of concurrent instances that the Amazon SQS event source can invoke.

  • DocumentDBEventSourceConfig — (map)

    Specific configuration settings for a DocumentDB event source.

    • DatabaseName — (String)

      The name of the database to consume within the DocumentDB cluster.

    • CollectionName — (String)

      The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

    • FullDocument — (String)

      Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

      Possible values include:
      • "UpdateLookup"
      • "Default"
  • KMSKeyArn — (String)

    The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

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 identifier of the event source mapping.

    • StartingPosition — (String)

      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    • BatchSize — (Integer)

      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

      Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • MaximumBatchingWindowInSeconds — (Integer)

      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

      For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

      Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • ParallelizationFactor — (Integer)

      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

    • EventSourceArn — (String)

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

    • FilterCriteria — (map)

      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

      If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

      • Filters — (Array<map>)

        A list of filters.

        • Pattern — (String)

          A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

    • FunctionArn — (String)

      The ARN of the Lambda function.

    • LastModified — (Date)

      The date that the event source mapping was last updated or that its state changed.

    • LastProcessingResult — (String)

      The result of the last Lambda invocation of your function.

    • State — (String)

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

    • StateTransitionReason — (String)

      Indicates whether a user or Lambda made the last change to the event source mapping.

    • DestinationConfig — (map)

      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

      • OnSuccess — (map)

        The destination configuration for successful invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

      • OnFailure — (map)

        The destination configuration for failed invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

          To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

          To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

          To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

    • Topics — (Array<String>)

      The name of the Kafka topic.

    • Queues — (Array<String>)

      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    • SourceAccessConfigurations — (Array<map>)

      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

      • Type — (String)

        The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

        • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

        • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

        • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

        • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

        • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

        • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

        • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

        • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

        • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

        Possible values include:
        • "BASIC_AUTH"
        • "VPC_SUBNET"
        • "VPC_SECURITY_GROUP"
        • "SASL_SCRAM_512_AUTH"
        • "SASL_SCRAM_256_AUTH"
        • "VIRTUAL_HOST"
        • "CLIENT_CERTIFICATE_TLS_AUTH"
        • "SERVER_ROOT_CA_CERTIFICATE"
      • URI — (String)

        The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

    • SelfManagedEventSource — (map)

      The self-managed Apache Kafka cluster for your event source.

      • Endpoints — (map<Array<String>>)

        The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

    • MaximumRecordAgeInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      Note: The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
    • BisectBatchOnFunctionError — (Boolean)

      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

    • MaximumRetryAttempts — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

    • TumblingWindowInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

    • FunctionResponseTypes — (Array<String>)

      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    • AmazonManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • SelfManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for a self-managed Apache Kafka event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • ScalingConfig — (map)

      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

      • MaximumConcurrency — (Integer)

        Limits the number of concurrent instances that the Amazon SQS event source can invoke.

    • DocumentDBEventSourceConfig — (map)

      Specific configuration settings for a DocumentDB event source.

      • DatabaseName — (String)

        The name of the database to consume within the DocumentDB cluster.

      • CollectionName — (String)

        The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

      • FullDocument — (String)

        Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

        Possible values include:
        • "UpdateLookup"
        • "Default"
    • KMSKeyArn — (String)

      The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

    • FilterCriteriaError — (map)

      An object that contains details about an error related to filter criteria encryption.

      • ErrorCode — (String)

        The KMS exception that resulted from filter criteria encryption or decryption.

      • Message — (String)

        The error message.

Returns:

• (AWS.Request) —

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

var params = {
  Code: { /* required */
    ImageUri: 'STRING_VALUE',
    S3Bucket: 'STRING_VALUE',
    S3Key: 'STRING_VALUE',
    S3ObjectVersion: 'STRING_VALUE',
    ZipFile: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
  },
  FunctionName: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  Architectures: [
    x86_64 | arm64,
    /* more items */
  ],
  CodeSigningConfigArn: 'STRING_VALUE',
  DeadLetterConfig: {
    TargetArn: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  Environment: {
    Variables: {
      '<EnvironmentVariableName>': 'STRING_VALUE',
      /* '<EnvironmentVariableName>': ... */
    }
  },
  EphemeralStorage: {
    Size: 'NUMBER_VALUE' /* required */
  },
  FileSystemConfigs: [
    {
      Arn: 'STRING_VALUE', /* required */
      LocalMountPath: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Handler: 'STRING_VALUE',
  ImageConfig: {
    Command: [
      'STRING_VALUE',
      /* more items */
    ],
    EntryPoint: [
      'STRING_VALUE',
      /* more items */
    ],
    WorkingDirectory: 'STRING_VALUE'
  },
  KMSKeyArn: 'STRING_VALUE',
  Layers: [
    'STRING_VALUE',
    /* more items */
  ],
  LoggingConfig: {
    ApplicationLogLevel: TRACE | DEBUG | INFO | WARN | ERROR | FATAL,
    LogFormat: JSON | Text,
    LogGroup: 'STRING_VALUE',
    SystemLogLevel: DEBUG | INFO | WARN
  },
  MemorySize: 'NUMBER_VALUE',
  PackageType: Zip | Image,
  Publish: true || false,
  Runtime: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | dotnet6 | dotnet8 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2 | nodejs18.x | python3.10 | java17 | ruby3.2 | ruby3.3 | python3.11 | nodejs20.x | provided.al2023 | python3.12 | java21,
  SnapStart: {
    ApplyOn: PublishedVersions | None
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Timeout: 'NUMBER_VALUE',
  TracingConfig: {
    Mode: Active | PassThrough
  },
  VpcConfig: {
    Ipv6AllowedForDualStack: true || false,
    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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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 identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

    The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

    For a list of all currently supported runtimes, see Supported runtimes.

    Possible values include:
    • "nodejs"
    • "nodejs4.3"
    • "nodejs6.10"
    • "nodejs8.10"
    • "nodejs10.x"
    • "nodejs12.x"
    • "nodejs14.x"
    • "nodejs16.x"
    • "java8"
    • "java8.al2"
    • "java11"
    • "python2.7"
    • "python3.6"
    • "python3.7"
    • "python3.8"
    • "python3.9"
    • "dotnetcore1.0"
    • "dotnetcore2.0"
    • "dotnetcore2.1"
    • "dotnetcore3.1"
    • "dotnet6"
    • "dotnet8"
    • "nodejs4.3-edge"
    • "go1.x"
    • "ruby2.5"
    • "ruby2.7"
    • "provided"
    • "provided.al2"
    • "nodejs18.x"
    • "python3.10"
    • "java17"
    • "ruby3.2"
    • "ruby3.3"
    • "python3.11"
    • "nodejs20.x"
    • "provided.al2023"
    • "python3.12"
    • "java21"
  • 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 run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

  • Code — (map)

    The code for the function.

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

      The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

    • S3Bucket — (String)

      An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

    • S3Key — (String)

      The Amazon S3 key of the deployment package.

    • S3ObjectVersion — (String)

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

    • ImageUri — (String)

      URI of a container image in the Amazon ECR registry.

  • Description — (String)

    A description of the function.

  • Timeout — (Integer)

    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

  • MemorySize — (Integer)

    The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

  • Publish — (Boolean)

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

  • VpcConfig — (map)

    For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

    • SubnetIds — (Array<String>)

      A list of VPC subnet IDs.

    • SecurityGroupIds — (Array<String>)

      A list of VPC security group IDs.

    • Ipv6AllowedForDualStack — (Boolean)

      Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

  • PackageType — (String)

    The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

    Possible values include:
    • "Zip"
    • "Image"
  • 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. For more information, see Using Lambda environment variables.

  • KMSKeyArn — (String)

    The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

  • TracingConfig — (map)

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

    • Mode — (String)

      The tracing mode.

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

    A list of tags to apply to the function.

  • Layers — (Array<String>)

    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

  • FileSystemConfigs — (Array<map>)

    Connection settings for an Amazon EFS file system.

    • Arn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

    • LocalMountPath — required — (String)

      The path where the function can access the file system, starting with /mnt/.

  • ImageConfig — (map)

    Container image configuration values that override the values in the container image Dockerfile.

    • EntryPoint — (Array<String>)

      Specifies the entry point to their application, which is typically the location of the runtime executable.

    • Command — (Array<String>)

      Specifies parameters that you want to pass in with ENTRYPOINT.

    • WorkingDirectory — (String)

      Specifies the working directory.

  • CodeSigningConfigArn — (String)

    To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

  • Architectures — (Array<String>)

    The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

  • EphemeralStorage — (map)

    The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

    • Size — required — (Integer)

      The size of the function's /tmp directory.

  • SnapStart — (map)

    The function's SnapStart setting.

    • ApplyOn — (String)

      Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

      Possible values include:
      • "PublishedVersions"
      • "None"
  • LoggingConfig — (map)

    The function's Amazon CloudWatch Logs configuration settings.

    • LogFormat — (String)

      The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

      Possible values include:
      • "JSON"
      • "Text"
    • ApplicationLogLevel — (String)

      Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

      Possible values include:
      • "TRACE"
      • "DEBUG"
      • "INFO"
      • "WARN"
      • "ERROR"
      • "FATAL"
    • SystemLogLevel — (String)

      Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

      Possible values include:
      • "DEBUG"
      • "INFO"
      • "WARN"
    • LogGroup — (String)

      The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

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 (ARN).

    • Runtime — (String)

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      Possible values include:
      • "nodejs"
      • "nodejs4.3"
      • "nodejs6.10"
      • "nodejs8.10"
      • "nodejs10.x"
      • "nodejs12.x"
      • "nodejs14.x"
      • "nodejs16.x"
      • "java8"
      • "java8.al2"
      • "java11"
      • "python2.7"
      • "python3.6"
      • "python3.7"
      • "python3.8"
      • "python3.9"
      • "dotnetcore1.0"
      • "dotnetcore2.0"
      • "dotnetcore2.1"
      • "dotnetcore3.1"
      • "dotnet6"
      • "dotnet8"
      • "nodejs4.3-edge"
      • "go1.x"
      • "ruby2.5"
      • "ruby2.7"
      • "provided"
      • "provided.al2"
      • "nodejs18.x"
      • "python3.10"
      • "java17"
      • "ruby3.2"
      • "ruby3.3"
      • "python3.11"
      • "nodejs20.x"
      • "provided.al2023"
      • "python3.12"
      • "java21"
    • Role — (String)

      The function's execution role.

    • Handler — (String)

      The function that Lambda calls to begin running 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 in seconds that Lambda allows a function to run before stopping it.

    • MemorySize — (Integer)

      The amount of memory available to the function at runtime.

    • LastModified — (String)

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

    • 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 group IDs.

      • VpcId — (String)

        The ID of the VPC.

      • Ipv6AllowedForDualStack — (Boolean)

        Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

    • 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. Omitted from CloudTrail logs.

      • Variables — (map<String>)

        Environment variable key-value pairs. Omitted from CloudTrail logs.

      • Error — (map)

        Error messages for environment variables that couldn't be applied.

        • ErrorCode — (String)

          The error code.

        • Message — (String)

          The error message.

    • KMSKeyArn — (String)

      The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key.

    • TracingConfig — (map)

      The function's X-Ray tracing configuration.

      • Mode — (String)

        The tracing mode.

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

      For Lambda@Edge functions, the ARN of the main function.

    • RevisionId — (String)

      The latest updated revision of the function or alias.

    • Layers — (Array<map>)

      The function's layers.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the function layer.

      • CodeSize — (Integer)

        The size of the layer archive in bytes.

      • SigningProfileVersionArn — (String)

        The Amazon Resource Name (ARN) for a signing profile version.

      • SigningJobArn — (String)

        The Amazon Resource Name (ARN) of a signing job.

    • State — (String)

      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

      Possible values include:
      • "Pending"
      • "Active"
      • "Inactive"
      • "Failed"
    • StateReason — (String)

      The reason for the function's current state.

    • StateReasonCode — (String)

      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

      Possible values include:
      • "Idle"
      • "Creating"
      • "Restoring"
      • "EniLimitExceeded"
      • "InsufficientRolePermissions"
      • "InvalidConfiguration"
      • "InternalError"
      • "SubnetOutOfIPAddresses"
      • "InvalidSubnet"
      • "InvalidSecurityGroup"
      • "ImageDeleted"
      • "ImageAccessDenied"
      • "InvalidImage"
      • "KMSKeyAccessDenied"
      • "KMSKeyNotFound"
      • "InvalidStateKMSKey"
      • "DisabledKMSKey"
      • "EFSIOError"
      • "EFSMountConnectivityError"
      • "EFSMountFailure"
      • "EFSMountTimeout"
      • "InvalidRuntime"
      • "InvalidZipFileException"
      • "FunctionError"
    • LastUpdateStatus — (String)

      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

      Possible values include:
      • "Successful"
      • "Failed"
      • "InProgress"
    • LastUpdateStatusReason — (String)

      The reason for the last update that was performed on the function.

    • LastUpdateStatusReasonCode — (String)

      The reason code for the last update that was performed on the function.

      Possible values include:
      • "EniLimitExceeded"
      • "InsufficientRolePermissions"
      • "InvalidConfiguration"
      • "InternalError"
      • "SubnetOutOfIPAddresses"
      • "InvalidSubnet"
      • "InvalidSecurityGroup"
      • "ImageDeleted"
      • "ImageAccessDenied"
      • "InvalidImage"
      • "KMSKeyAccessDenied"
      • "KMSKeyNotFound"
      • "InvalidStateKMSKey"
      • "DisabledKMSKey"
      • "EFSIOError"
      • "EFSMountConnectivityError"
      • "EFSMountFailure"
      • "EFSMountTimeout"
      • "InvalidRuntime"
      • "InvalidZipFileException"
      • "FunctionError"
    • FileSystemConfigs — (Array<map>)

      Connection settings for an Amazon EFS file system.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

      • LocalMountPath — required — (String)

        The path where the function can access the file system, starting with /mnt/.

    • PackageType — (String)

      The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

      Possible values include:
      • "Zip"
      • "Image"
    • ImageConfigResponse — (map)

      The function's image configuration values.

      • ImageConfig — (map)

        Configuration values that override the container image Dockerfile.

        • EntryPoint — (Array<String>)

          Specifies the entry point to their application, which is typically the location of the runtime executable.

        • Command — (Array<String>)

          Specifies parameters that you want to pass in with ENTRYPOINT.

        • WorkingDirectory — (String)

          Specifies the working directory.

      • Error — (map)

        Error response to GetFunctionConfiguration.

        • ErrorCode — (String)

          Error code.

        • Message — (String)

          Error message.

    • SigningProfileVersionArn — (String)

      The ARN of the signing profile version.

    • SigningJobArn — (String)

      The ARN of the signing job.

    • Architectures — (Array<String>)

      The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

    • EphemeralStorage — (map)

      The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

      • Size — required — (Integer)

        The size of the function's /tmp directory.

    • SnapStart — (map)

      Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

      • ApplyOn — (String)

        When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

        Possible values include:
        • "PublishedVersions"
        • "None"
      • OptimizationStatus — (String)

        When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

        Possible values include:
        • "On"
        • "Off"
    • RuntimeVersionConfig — (map)

      The ARN of the runtime and any errors that occured.

      • RuntimeVersionArn — (String)

        The ARN of the runtime version you want the function to use.

      • Error — (map)

        Error response when Lambda is unable to retrieve the runtime version for a function.

        • ErrorCode — (String)

          The error code.

        • Message — (String)

          The error message.

    • LoggingConfig — (map)

      The function's Amazon CloudWatch Logs configuration settings.

      • LogFormat — (String)

        The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

        Possible values include:
        • "JSON"
        • "Text"
      • ApplicationLogLevel — (String)

        Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

        Possible values include:
        • "TRACE"
        • "DEBUG"
        • "INFO"
        • "WARN"
        • "ERROR"
        • "FATAL"
      • SystemLogLevel — (String)

        Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

        Possible values include:
        • "DEBUG"
        • "INFO"
        • "WARN"
      • LogGroup — (String)

        The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

Returns:

• (AWS.Request) —

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

var params = {
  AuthType: NONE | AWS_IAM, /* required */
  FunctionName: 'STRING_VALUE', /* required */
  Cors: {
    AllowCredentials: true || false,
    AllowHeaders: [
      'STRING_VALUE',
      /* more items */
    ],
    AllowMethods: [
      'STRING_VALUE',
      /* more items */
    ],
    AllowOrigins: [
      'STRING_VALUE',
      /* more items */
    ],
    ExposeHeaders: [
      'STRING_VALUE',
      /* more items */
    ],
    MaxAge: 'NUMBER_VALUE'
  },
  InvokeMode: BUFFERED | RESPONSE_STREAM,
  Qualifier: 'STRING_VALUE'
};
lambda.createFunctionUrlConfig(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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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)

    The alias name.

  • AuthType — (String)

    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

    Possible values include:
    • "NONE"
    • "AWS_IAM"
  • Cors — (map)

    The cross-origin resource sharing (CORS) settings for your function URL.

    • AllowCredentials — (Boolean)

      Whether to allow cookies or other credentials in requests to your function URL. The default is false.

    • AllowHeaders — (Array<String>)

      The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

    • AllowMethods — (Array<String>)

      The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

    • AllowOrigins — (Array<String>)

      The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

      Alternatively, you can grant access to all origins using the wildcard character (*).

    • ExposeHeaders — (Array<String>)

      The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

    • MaxAge — (Integer)

      The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

  • InvokeMode — (String)

    Use one of the following options:

    • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

    • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    Possible values include:
    • "BUFFERED"
    • "RESPONSE_STREAM"

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:

    • FunctionUrl — (String)

      The HTTP URL endpoint for your function.

    • FunctionArn — (String)

      The Amazon Resource Name (ARN) of your function.

    • AuthType — (String)

      The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • Cors — (map)

      The cross-origin resource sharing (CORS) settings for your function URL.

      • AllowCredentials — (Boolean)

        Whether to allow cookies or other credentials in requests to your function URL. The default is false.

      • AllowHeaders — (Array<String>)

        The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

      • AllowMethods — (Array<String>)

        The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

      • AllowOrigins — (Array<String>)

        The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

        Alternatively, you can grant access to all origins using the wildcard character (*).

      • ExposeHeaders — (Array<String>)

        The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

      • MaxAge — (Integer)

        The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

    • CreationTime — (String)

      When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    • InvokeMode — (String)

      Use one of the following options:

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

      Possible values include:
      • "BUFFERED"
      • "RESPONSE_STREAM"

Returns:

• (AWS.Request) —

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

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 or ARN 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 name of the 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.

var params = {
  CodeSigningConfigArn: 'STRING_VALUE' /* required */
};
lambda.deleteCodeSigningConfig(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: {}) —
  • CodeSigningConfigArn — (String)

    The The Amazon Resource Name (ARN) of the code signing configuration.

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.

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 identifier 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 identifier of the event source mapping.

    • StartingPosition — (String)

      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    • BatchSize — (Integer)

      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

      Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • MaximumBatchingWindowInSeconds — (Integer)

      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

      For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

      Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • ParallelizationFactor — (Integer)

      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

    • EventSourceArn — (String)

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

    • FilterCriteria — (map)

      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

      If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

      • Filters — (Array<map>)

        A list of filters.

        • Pattern — (String)

          A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

    • FunctionArn — (String)

      The ARN of the Lambda function.

    • LastModified — (Date)

      The date that the event source mapping was last updated or that its state changed.

    • LastProcessingResult — (String)

      The result of the last Lambda invocation of your function.

    • State — (String)

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

    • StateTransitionReason — (String)

      Indicates whether a user or Lambda made the last change to the event source mapping.

    • DestinationConfig — (map)

      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

      • OnSuccess — (map)

        The destination configuration for successful invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

      • OnFailure — (map)

        The destination configuration for failed invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

          To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

          To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

          To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

    • Topics — (Array<String>)

      The name of the Kafka topic.

    • Queues — (Array<String>)

      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    • SourceAccessConfigurations — (Array<map>)

      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

      • Type — (String)

        The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

        • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

        • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

        • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

        • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

        • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

        • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

        • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

        • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

        • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

        Possible values include:
        • "BASIC_AUTH"
        • "VPC_SUBNET"
        • "VPC_SECURITY_GROUP"
        • "SASL_SCRAM_512_AUTH"
        • "SASL_SCRAM_256_AUTH"
        • "VIRTUAL_HOST"
        • "CLIENT_CERTIFICATE_TLS_AUTH"
        • "SERVER_ROOT_CA_CERTIFICATE"
      • URI — (String)

        The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

    • SelfManagedEventSource — (map)

      The self-managed Apache Kafka cluster for your event source.

      • Endpoints — (map<Array<String>>)

        The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

    • MaximumRecordAgeInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      Note: The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
    • BisectBatchOnFunctionError — (Boolean)

      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

    • MaximumRetryAttempts — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

    • TumblingWindowInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

    • FunctionResponseTypes — (Array<String>)

      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    • AmazonManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • SelfManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for a self-managed Apache Kafka event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • ScalingConfig — (map)

      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

      • MaximumConcurrency — (Integer)

        Limits the number of concurrent instances that the Amazon SQS event source can invoke.

    • DocumentDBEventSourceConfig — (map)

      Specific configuration settings for a DocumentDB event source.

      • DatabaseName — (String)

        The name of the database to consume within the DocumentDB cluster.

      • CollectionName — (String)

        The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

      • FullDocument — (String)

        Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

        Possible values include:
        • "UpdateLookup"
        • "Default"
    • KMSKeyArn — (String)

      The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

    • FilterCriteriaError — (map)

      An object that contains details about an error related to filter criteria encryption.

      • ErrorCode — (String)

        The KMS exception that resulted from filter criteria encryption or decryption.

      • Message — (String)

        The error message.

Returns:

• (AWS.Request) —

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

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 or ARN of the Lambda function or version.

    Name formats

    • Function name – my-function (name-only), my-function:1 (with version).

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

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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 can't delete a version that an alias references.

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.

var params = {
  FunctionName: 'STRING_VALUE' /* required */
};
lambda.deleteFunctionCodeSigningConfig(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 or ARN 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.

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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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.

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.deleteFunctionEventInvokeConfig(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 or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

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

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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)

    A version number or alias name.

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.

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.deleteFunctionUrlConfig(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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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)

    The alias name.

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.

var params = {
  LayerName: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE' /* required */
};
lambda.deleteLayerVersion(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: {}) —
  • LayerName — (String)

    The name or Amazon Resource Name (ARN) of the layer.

  • VersionNumber — (Integer)

    The version number.

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.

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE' /* required */
};
lambda.deleteProvisionedConcurrencyConfig(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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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)

    The version number or alias name.

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.

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 that are related to concurrency and code storage.

      • TotalCodeSize — (Integer)

        The amount of storage space that you can use for all deployment packages and layer archives.

      • CodeSizeUnzipped — (Integer)

        The maximum size of a function's deployment package and layers when they're extracted.

      • CodeSizeZipped — (Integer)

        The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.

      • ConcurrentExecutions — (Integer)

        The maximum number of simultaneous function executions.

      • UnreservedConcurrentExecutions — (Integer)

        The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.

    • AccountUsage — (map)

      The number of functions and amount of storage in use.

      • TotalCodeSize — (Integer)

        The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

      • FunctionCount — (Integer)

        The number of Lambda functions.

Returns:

• (AWS.Request) —

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

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 or ARN 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 name of the 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. The data object has the following properties:

    • AliasArn — (String)

      The Amazon Resource Name (ARN) of the alias.

    • Name — (String)

      The name of the alias.

    • FunctionVersion — (String)

      The function version that the alias invokes.

    • Description — (String)

      A description of the alias.

    • RoutingConfig — (map)

      The routing configuration of the alias.

      • AdditionalVersionWeights — (map<Float>)

        The second version, and the percentage of traffic that's routed to it.

    • RevisionId — (String)

      A unique identifier that changes when you update the alias.

Returns:

• (AWS.Request) —

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

var params = {
  CodeSigningConfigArn: 'STRING_VALUE' /* required */
};
lambda.getCodeSigningConfig(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: {}) —
  • CodeSigningConfigArn — (String)

    The The Amazon Resource Name (ARN) of the code signing configuration.

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:

    • CodeSigningConfig — (map)

      The code signing configuration

      • CodeSigningConfigId — required — (String)

        Unique identifer for the Code signing configuration.

      • CodeSigningConfigArn — required — (String)

        The Amazon Resource Name (ARN) of the Code signing configuration.

      • Description — (String)

        Code signing configuration description.

      • AllowedPublishers — required — (map)

        List of allowed publishers.

        • SigningProfileVersionArns — required — (Array<String>)

          The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

      • CodeSigningPolicies — required — (map)

        The code signing policy controls the validation failure action for signature mismatch or expiry.

        • UntrustedArtifactOnDeployment — (String)

          Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

          Default value: Warn

          Possible values include:
          • "Warn"
          • "Enforce"
      • LastModified — required — (String)

        The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

• (AWS.Request) —

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

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 identifier 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 identifier of the event source mapping.

    • StartingPosition — (String)

      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    • BatchSize — (Integer)

      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

      Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • MaximumBatchingWindowInSeconds — (Integer)

      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

      For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

      Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • ParallelizationFactor — (Integer)

      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

    • EventSourceArn — (String)

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

    • FilterCriteria — (map)

      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

      If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

      • Filters — (Array<map>)

        A list of filters.

        • Pattern — (String)

          A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

    • FunctionArn — (String)

      The ARN of the Lambda function.

    • LastModified — (Date)

      The date that the event source mapping was last updated or that its state changed.

    • LastProcessingResult — (String)

      The result of the last Lambda invocation of your function.

    • State — (String)

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

    • StateTransitionReason — (String)

      Indicates whether a user or Lambda made the last change to the event source mapping.

    • DestinationConfig — (map)

      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

      • OnSuccess — (map)

        The destination configuration for successful invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

      • OnFailure — (map)

        The destination configuration for failed invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

          To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

          To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

          To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

    • Topics — (Array<String>)

      The name of the Kafka topic.

    • Queues — (Array<String>)

      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    • SourceAccessConfigurations — (Array<map>)

      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

      • Type — (String)

        The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

        • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

        • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

        • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

        • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

        • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

        • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

        • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

        • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

        • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

        Possible values include:
        • "BASIC_AUTH"
        • "VPC_SUBNET"
        • "VPC_SECURITY_GROUP"
        • "SASL_SCRAM_512_AUTH"
        • "SASL_SCRAM_256_AUTH"
        • "VIRTUAL_HOST"
        • "CLIENT_CERTIFICATE_TLS_AUTH"
        • "SERVER_ROOT_CA_CERTIFICATE"
      • URI — (String)

        The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

    • SelfManagedEventSource — (map)

      The self-managed Apache Kafka cluster for your event source.

      • Endpoints — (map<Array<String>>)

        The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

    • MaximumRecordAgeInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      Note: The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
    • BisectBatchOnFunctionError — (Boolean)

      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

    • MaximumRetryAttempts — (Integer)

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

    • TumblingWindowInSeconds — (Integer)

      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

    • FunctionResponseTypes — (Array<String>)

      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    • AmazonManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • SelfManagedKafkaEventSourceConfig — (map)

      Specific configuration settings for a self-managed Apache Kafka event source.

      • ConsumerGroupId — (String)

        The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • ScalingConfig — (map)

      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

      • MaximumConcurrency — (Integer)

        Limits the number of concurrent instances that the Amazon SQS event source can invoke.

    • DocumentDBEventSourceConfig — (map)

      Specific configuration settings for a DocumentDB event source.

      • DatabaseName — (String)

        The name of the database to consume within the DocumentDB cluster.

      • CollectionName — (String)

        The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

      • FullDocument — (String)

        Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

        Possible values include:
        • "UpdateLookup"
        • "Default"
    • KMSKeyArn — (String)

      The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

    • FilterCriteriaError — (map)

      An object that contains details about an error related to filter criteria encryption.

      • ErrorCode — (String)

        The KMS exception that resulted from filter criteria encryption or decryption.

      • Message — (String)

        The error message.

Returns:

• (AWS.Request) —

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

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 or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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 configuration of the function or version.

      • FunctionName — (String)

        The name of the function.

      • FunctionArn — (String)

        The function's Amazon Resource Name (ARN).

      • Runtime — (String)

        The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

        The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

        For a list of all currently supported runtimes, see Supported runtimes.

        Possible values include:
        • "nodejs"
        • "nodejs4.3"
        • "nodejs6.10"
        • "nodejs8.10"
        • "nodejs10.x"
        • "nodejs12.x"
        • "nodejs14.x"
        • "nodejs16.x"
        • "java8"
        • "java8.al2"
        • "java11"
        • "python2.7"
        • "python3.6"
        • "python3.7"
        • "python3.8"
        • "python3.9"
        • "dotnetcore1.0"
        • "dotnetcore2.0"
        • "dotnetcore2.1"
        • "dotnetcore3.1"
        • "dotnet6"
        • "dotnet8"
        • "nodejs4.3-edge"
        • "go1.x"
        • "ruby2.5"
        • "ruby2.7"
        • "provided"
        • "provided.al2"
        • "nodejs18.x"
        • "python3.10"
        • "java17"
        • "ruby3.2"
        • "ruby3.3"
        • "python3.11"
        • "nodejs20.x"
        • "provided.al2023"
        • "python3.12"
        • "java21"
      • Role — (String)

        The function's execution role.

      • Handler — (String)

        The function that Lambda calls to begin running 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 in seconds that Lambda allows a function to run before stopping it.

      • MemorySize — (Integer)

        The amount of memory available to the function at runtime.

      • LastModified — (String)

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

      • 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 group IDs.

        • VpcId — (String)

          The ID of the VPC.

        • Ipv6AllowedForDualStack — (Boolean)

          Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

      • 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. Omitted from CloudTrail logs.

        • Variables — (map<String>)

          Environment variable key-value pairs. Omitted from CloudTrail logs.

        • Error — (map)

          Error messages for environment variables that couldn't be applied.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • KMSKeyArn — (String)

        The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key.

      • TracingConfig — (map)

        The function's X-Ray tracing configuration.

        • Mode — (String)

          The tracing mode.

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

        For Lambda@Edge functions, the ARN of the main function.

      • RevisionId — (String)

        The latest updated revision of the function or alias.

      • Layers — (Array<map>)

        The function's layers.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the function layer.

        • CodeSize — (Integer)

          The size of the layer archive in bytes.

        • SigningProfileVersionArn — (String)

          The Amazon Resource Name (ARN) for a signing profile version.

        • SigningJobArn — (String)

          The Amazon Resource Name (ARN) of a signing job.

      • State — (String)

        The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

        Possible values include:
        • "Pending"
        • "Active"
        • "Inactive"
        • "Failed"
      • StateReason — (String)

        The reason for the function's current state.

      • StateReasonCode — (String)

        The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

        Possible values include:
        • "Idle"
        • "Creating"
        • "Restoring"
        • "EniLimitExceeded"
        • "InsufficientRolePermissions"
        • "InvalidConfiguration"
        • "InternalError"
        • "SubnetOutOfIPAddresses"
        • "InvalidSubnet"
        • "InvalidSecurityGroup"
        • "ImageDeleted"
        • "ImageAccessDenied"
        • "InvalidImage"
        • "KMSKeyAccessDenied"
        • "KMSKeyNotFound"
        • "InvalidStateKMSKey"
        • "DisabledKMSKey"
        • "EFSIOError"
        • "EFSMountConnectivityError"
        • "EFSMountFailure"
        • "EFSMountTimeout"
        • "InvalidRuntime"
        • "InvalidZipFileException"
        • "FunctionError"
      • LastUpdateStatus — (String)

        The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

        Possible values include:
        • "Successful"
        • "Failed"
        • "InProgress"
      • LastUpdateStatusReason — (String)

        The reason for the last update that was performed on the function.

      • LastUpdateStatusReasonCode — (String)

        The reason code for the last update that was performed on the function.

        Possible values include:
        • "EniLimitExceeded"
        • "InsufficientRolePermissions"
        • "InvalidConfiguration"
        • "InternalError"
        • "SubnetOutOfIPAddresses"
        • "InvalidSubnet"
        • "InvalidSecurityGroup"
        • "ImageDeleted"
        • "ImageAccessDenied"
        • "InvalidImage"
        • "KMSKeyAccessDenied"
        • "KMSKeyNotFound"
        • "InvalidStateKMSKey"
        • "DisabledKMSKey"
        • "EFSIOError"
        • "EFSMountConnectivityError"
        • "EFSMountFailure"
        • "EFSMountTimeout"
        • "InvalidRuntime"
        • "InvalidZipFileException"
        • "FunctionError"
      • FileSystemConfigs — (Array<map>)

        Connection settings for an Amazon EFS file system.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

        • LocalMountPath — required — (String)

          The path where the function can access the file system, starting with /mnt/.

      • PackageType — (String)

        The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

        Possible values include:
        • "Zip"
        • "Image"
      • ImageConfigResponse — (map)

        The function's image configuration values.

        • ImageConfig — (map)

          Configuration values that override the container image Dockerfile.

          • EntryPoint — (Array<String>)

            Specifies the entry point to their application, which is typically the location of the runtime executable.

          • Command — (Array<String>)

            Specifies parameters that you want to pass in with ENTRYPOINT.

          • WorkingDirectory — (String)

            Specifies the working directory.

        • Error — (map)

          Error response to GetFunctionConfiguration.

          • ErrorCode — (String)

            Error code.

          • Message — (String)

            Error message.

      • SigningProfileVersionArn — (String)

        The ARN of the signing profile version.

      • SigningJobArn — (String)

        The ARN of the signing job.

      • Architectures — (Array<String>)

        The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

      • EphemeralStorage — (map)

        The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

        • Size — required — (Integer)

          The size of the function's /tmp directory.

      • SnapStart — (map)

        Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

        • ApplyOn — (String)

          When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

          Possible values include:
          • "PublishedVersions"
          • "None"
        • OptimizationStatus — (String)

          When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

          Possible values include:
          • "On"
          • "Off"
      • RuntimeVersionConfig — (map)

        The ARN of the runtime and any errors that occured.

        • RuntimeVersionArn — (String)

          The ARN of the runtime version you want the function to use.

        • Error — (map)

          Error response when Lambda is unable to retrieve the runtime version for a function.

          • ErrorCode — (String)

            The error code.

          • Message — (String)

            The error message.

      • LoggingConfig — (map)

        The function's Amazon CloudWatch Logs configuration settings.

        • LogFormat — (String)

          The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

          Possible values include:
          • "JSON"
          • "Text"
        • ApplicationLogLevel — (String)

          Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

          Possible values include:
          • "TRACE"
          • "DEBUG"
          • "INFO"
          • "WARN"
          • "ERROR"
          • "FATAL"
        • SystemLogLevel — (String)

          Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

          Possible values include:
          • "DEBUG"
          • "INFO"
          • "WARN"
        • LogGroup — (String)

          The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

    • Code — (map)

      The deployment package of the function or version.

      • RepositoryType — (String)

        The service that's hosting the file.

      • Location — (String)

        A presigned URL that you can use to download the deployment package.

      • ImageUri — (String)

        URI of a container image in the Amazon ECR registry.

      • ResolvedImageUri — (String)

        The resolved URI for the image.

    • Tags — (map<String>)

      The function's tags.

    • Concurrency — (map)

      The function's reserved concurrency.

      • ReservedConcurrentExecutions — (Integer)

        The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• functionExists

• functionActiveV2

• functionUpdatedV2

var params = {
  FunctionName: 'STRING_VALUE' /* required */
};
lambda.getFunctionCodeSigningConfig(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 or ARN 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. The data object has the following properties:

    • CodeSigningConfigArn — (String)

      The The Amazon Resource Name (ARN) of the code signing configuration.

    • FunctionName — (String)

      The name or ARN 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.

Returns:

• (AWS.Request) —

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

var params = {
  FunctionName: 'STRING_VALUE' /* required */
};
lambda.getFunctionConcurrency(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 or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

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

    • Partial ARN – 123456789012:function:my-function.

    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. The data object has the following properties:

    • ReservedConcurrentExecutions — (Integer)

      The number of simultaneous executions that are reserved for the function.

Returns:

• (AWS.Request) —

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

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 or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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 (ARN).

    • Runtime — (String)

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      Possible values include:
      • "nodejs"
      • "nodejs4.3"
      • "nodejs6.10"
      • "nodejs8.10"
      • "nodejs10.x"
      • "nodejs12.x"
      • "nodejs14.x"
      • "nodejs16.x"
      • "java8"
      • "java8.al2"
      • "java11"
      • "python2.7"
      • "python3.6"
      • "python3.7"
      • "python3.8"
      • "python3.9"
      • "dotnetcore1.0"
      • "dotnetcore2.0"
      • "dotnetcore2.1"
      • "dotnetcore3.1"
      • "dotnet6"
      • "dotnet8"
      • "nodejs4.3-edge"
      • "go1.x"
      • "ruby2.5"
      • "ruby2.7"
      • "provided"
      • "provided.al2"
      • "nodejs18.x"
      • "python3.10"
      • "java17"
      • "ruby3.2"
      • "ruby3.3"
      • "python3.11"
      • "nodejs20.x"
      • "provided.al2023"
      • "python3.12"
      • "java21"
    • Role — (String)

      The function's execution role.

    • Handler — (String)

      The function that Lambda calls to begin running 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 in seconds that Lambda allows a function to run before stopping it.

    • MemorySize — (Integer)

      The amount of memory available to the function at runtime.

    • LastModified — (String)

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

    • 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 group IDs.

      • VpcId — (String)

        The ID of the VPC.

      • Ipv6AllowedForDualStack — (Boolean)

        Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

    • 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. Omitted from CloudTrail logs.

      • Variables — (map<String>)

        Environment variable key-value pairs. Omitted from CloudTrail logs.

      • Error — (map)

        Error messages for environment variables that couldn't be applied.

        • ErrorCode — (String)

          The error code.

        • Message — (String)

          The error message.

    • KMSKeyArn — (String)

      The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key.

    • TracingConfig — (map)

      The function's X-Ray tracing configuration.

      • Mode — (String)

        The tracing mode.

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

      For Lambda@Edge functions, the ARN of the main function.

    • RevisionId — (String)

      The latest updated revision of the function or alias.

    • Layers — (Array<map>)

      The function's layers.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the function layer.

      • CodeSize — (Integer)

        The size of the layer archive in bytes.

      • SigningProfileVersionArn — (String)

        The Amazon Resource Name (ARN) for a signing profile version.

      • SigningJobArn — (String)

        The Amazon Resource Name (ARN) of a signing job.

    • State — (String)

      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

      Possible values include:
      • "Pending"
      • "Active"
      • "Inactive"
      • "Failed"
    • StateReason — (String)

      The reason for the function's current state.

    • StateReasonCode — (String)

      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

      Possible values include:
      • "Idle"
      • "Creating"
      • "Restoring"
      • "EniLimitExceeded"
      • "InsufficientRolePermissions"
      • "InvalidConfiguration"
      • "InternalError"
      • "SubnetOutOfIPAddresses"
      • "InvalidSubnet"
      • "InvalidSecurityGroup"
      • "ImageDeleted"
      • "ImageAccessDenied"
      • "InvalidImage"
      • "KMSKeyAccessDenied"
      • "KMSKeyNotFound"
      • "InvalidStateKMSKey"
      • "DisabledKMSKey"
      • "EFSIOError"
      • "EFSMountConnectivityError"
      • "EFSMountFailure"
      • "EFSMountTimeout"
      • "InvalidRuntime"
      • "InvalidZipFileException"
      • "FunctionError"
    • LastUpdateStatus — (String)

      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

      Possible values include:
      • "Successful"
      • "Failed"
      • "InProgress"
    • LastUpdateStatusReason — (String)

      The reason for the last update that was performed on the function.

    • LastUpdateStatusReasonCode — (String)

      The reason code for the last update that was performed on the function.

      Possible values include:
      • "EniLimitExceeded"
      • "InsufficientRolePermissions"
      • "InvalidConfiguration"
      • "InternalError"
      • "SubnetOutOfIPAddresses"
      • "InvalidSubnet"
      • "InvalidSecurityGroup"
      • "ImageDeleted"
      • "ImageAccessDenied"
      • "InvalidImage"
      • "KMSKeyAccessDenied"
      • "KMSKeyNotFound"
      • "InvalidStateKMSKey"
      • "DisabledKMSKey"
      • "EFSIOError"
      • "EFSMountConnectivityError"
      • "EFSMountFailure"
      • "EFSMountTimeout"
      • "InvalidRuntime"
      • "InvalidZipFileException"
      • "FunctionError"
    • FileSystemConfigs — (Array<map>)

      Connection settings for an Amazon EFS file system.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

      • LocalMountPath — required — (String)

        The path where the function can access the file system, starting with /mnt/.

    • PackageType — (String)

      The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

      Possible values include:
      • "Zip"
      • "Image"
    • ImageConfigResponse — (map)

      The function's image configuration values.

      • ImageConfig — (map)

        Configuration values that override the container image Dockerfile.

        • EntryPoint — (Array<String>)

          Specifies the entry point to their application, which is typically the location of the runtime executable.

        • Command — (Array<String>)

          Specifies parameters that you want to pass in with ENTRYPOINT.

        • WorkingDirectory — (String)

          Specifies the working directory.

      • Error — (map)

        Error response to GetFunctionConfiguration.

        • ErrorCode — (String)

          Error code.

        • Message — (String)

          Error message.

    • SigningProfileVersionArn — (String)

      The ARN of the signing profile version.

    • SigningJobArn — (String)

      The ARN of the signing job.

    • Architectures — (Array<String>)

      The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

    • EphemeralStorage — (map)

      The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

      • Size — required — (Integer)

        The size of the function's /tmp directory.

    • SnapStart — (map)

      Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

      • ApplyOn — (String)

        When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

        Possible values include:
        • "PublishedVersions"
        • "None"
      • OptimizationStatus — (String)

        When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

        Possible values include:
        • "On"
        • "Off"
    • RuntimeVersionConfig — (map)

      The ARN of the runtime and any errors that occured.

      • RuntimeVersionArn — (String)

        The ARN of the runtime version you want the function to use.

      • Error — (map)

        Error response when Lambda is unable to retrieve the runtime version for a function.

        • ErrorCode — (String)

          The error code.

        • Message — (String)

          The error message.

    • LoggingConfig — (map)

      The function's Amazon CloudWatch Logs configuration settings.

      • LogFormat — (String)

        The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

        Possible values include:
        • "JSON"
        • "Text"
      • ApplicationLogLevel — (String)

        Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

        Possible values include:
        • "TRACE"
        • "DEBUG"
        • "INFO"
        • "WARN"
        • "ERROR"
        • "FATAL"
      • SystemLogLevel — (String)

        Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

        Possible values include:
        • "DEBUG"
        • "INFO"
        • "WARN"
      • LogGroup — (String)

        The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• functionActive

• functionUpdated

• publishedVersionActive

var params = {
  FunctionName: 'STRING_VALUE', /* required */
  Qualifier: 'STRING_VALUE'
};
lambda.getFunctionEventInvokeConfig(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 or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

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

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. 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)

    A version number or alias name.

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:

    • LastModified — (Date)

      The date and time that the configuration was last updated.

    • FunctionArn — (String)

      The Amazon Resource Name (ARN) of the function.

    • MaximumRetryAttempts — (Integer)

      The maximum number of times to retry when the function returns an error.

    • MaximumEventAgeInSeconds — (Integer)

      The maximum age of a request that Lambda sends to a function for processing.

    • DestinationConfig — (map)

      A destination for events after they have been sent to a function for processing.

      Destinations

      • Function - The Amazon Resource Name (ARN) of a Lambda function.

      • Queue - The ARN of a standard SQS queue.

      • Topic - The ARN of a standard SNS topic.

      • Event Bus - The ARN of an Amazon EventBridge event bus.

      • OnSuccess — (map)

        The destination configuration for successful invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

      • OnFailure — (map)

        The destination configuration for failed invocations.

        • Destination — (String)

          The Amazon Resource Name (ARN) of the destination resource.

          To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

          To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

          To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

Returns:

• (AWS.Request) —

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

var params = {
  FunctionName: 'STRING_VALUE' /* required */
};
lambda.getFunctionRecursionConfig(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)

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:

    • RecursiveLoop — (String)

      If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop.

      If your function's recursive loop detection configuration is Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

      By default, Lambda sets your function's configuration to Terminate. You can update this configuration using the PutFunctionRecursionConfig action.

      Possible values include:
      • "Allow"
      • "Terminate"

Returns: