Skip to content

Latest commit

 

History

History
406 lines (340 loc) · 22.2 KB

API_CreateEventSourceMapping.md

File metadata and controls

406 lines (340 loc) · 22.2 KB
Raw

CreateEventSourceMapping

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

  • BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
  • DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
  • MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
  • MaximumRetryAttempts - 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.
  • ParallelizationFactor - Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

Request Syntax

POST /2015-03-31/event-source-mappings/ HTTP/1.1
Content-type: application/json

{
   "BatchSize": number,
   "BisectBatchOnFunctionError": boolean,
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "Enabled": boolean,
   "EventSourceArn": "string",
   "FunctionName": "string",
   "FunctionResponseTypes": [ "string" ],
   "MaximumBatchingWindowInSeconds": number,
   "MaximumRecordAgeInSeconds": number,
   "MaximumRetryAttempts": number,
   "ParallelizationFactor": number,
   "Queues": [ "string" ],
   "SelfManagedEventSource": { 
      "Endpoints": { 
         "string" : [ "string" ]
      }
   },
   "SourceAccessConfigurations": [ 
      { 
         "Type": "string",
         "URI": "string"
      }
   ],
   "StartingPosition": "string",
   "StartingPositionTimestamp": number,
   "Topics": [ "string" ],
   "TumblingWindowInSeconds": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

** BatchSize ** 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 1,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. Type: Integer
    Valid Range: Minimum value of 1. Maximum value of 10000.
    Required: No

** BisectBatchOnFunctionError ** (Streams only) If the function returns an error, split the batch in two and retry.
Type: Boolean
Required: No

** DestinationConfig ** (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Type: DestinationConfig object
Required: No

** Enabled ** When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
Type: Boolean
Required: No

** EventSourceArn ** 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. Type: String
    Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
    Required: No

** FunctionName ** The name of the Lambda function.

Name formats

  • Function name - MyFunction.
  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
  • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
  • Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
    Type: String
    Length Constraints: Minimum length of 1. Maximum length of 140.
    Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
    Required: Yes

** FunctionResponseTypes ** (Streams only) A list of current response type enums applied to the event source mapping.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Valid Values: ReportBatchItemFailures
Required: No

** MaximumBatchingWindowInSeconds ** (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No

** MaximumRecordAgeInSeconds ** (Streams only) Discard records older than the specified age. The default value is infinite (-1).
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 604800.
Required: No

** MaximumRetryAttempts ** (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 10000.
Required: No

** ParallelizationFactor ** (Streams only) The number of batches to process from each shard concurrently.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No

** Queues ** (MQ) The name of the Amazon MQ broker destination queue to consume.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: [\s\S]*
Required: No

** SelfManagedEventSource ** The Self-Managed Apache Kafka cluster to send records.
Type: SelfManagedEventSource object
Required: No

** SourceAccessConfigurations ** An array of authentication protocols or VPC components required to secure your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 22 items.
Required: No

** StartingPosition ** The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
Type: String
Valid Values: TRIM_HORIZON | LATEST | AT_TIMESTAMP
Required: No

** StartingPositionTimestamp ** With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
Type: Timestamp
Required: No

** Topics ** The name of the Kafka topic.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 249.
Pattern: ^[^.]([a-zA-Z0-9\-_.]+)
Required: No

** TumblingWindowInSeconds ** (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 900.
Required: No

Response Syntax

HTTP/1.1 202
Content-type: application/json

{
   "BatchSize": number,
   "BisectBatchOnFunctionError": boolean,
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "EventSourceArn": "string",
   "FunctionArn": "string",
   "FunctionResponseTypes": [ "string" ],
   "LastModified": number,
   "LastProcessingResult": "string",
   "MaximumBatchingWindowInSeconds": number,
   "MaximumRecordAgeInSeconds": number,
   "MaximumRetryAttempts": number,
   "ParallelizationFactor": number,
   "Queues": [ "string" ],
   "SelfManagedEventSource": { 
      "Endpoints": { 
         "string" : [ "string" ]
      }
   },
   "SourceAccessConfigurations": [ 
      { 
         "Type": "string",
         "URI": "string"
      }
   ],
   "StartingPosition": "string",
   "StartingPositionTimestamp": number,
   "State": "string",
   "StateTransitionReason": "string",
   "Topics": [ "string" ],
   "TumblingWindowInSeconds": number,
   "UUID": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

** BatchSize ** 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.

** BisectBatchOnFunctionError ** (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Type: Boolean

** DestinationConfig ** (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Type: DestinationConfig object

** EventSourceArn ** The Amazon Resource Name (ARN) of the event source.
Type: String
Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

** FunctionArn ** The ARN of the Lambda function.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?

** FunctionResponseTypes ** (Streams only) A list of current response type enums applied to the event source mapping.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Valid Values: ReportBatchItemFailures

** LastModified ** The date that the event source mapping was last updated or that its state changed, in Unix time seconds.
Type: Timestamp

** LastProcessingResult ** The result of the last Lambda invocation of your function.
Type: String

** MaximumBatchingWindowInSeconds ** (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default: 0
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

** MaximumRecordAgeInSeconds ** (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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 604800.

** MaximumRetryAttempts ** (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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 10000.

** ParallelizationFactor ** (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.

** Queues ** (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: [\s\S]*

** SelfManagedEventSource ** The self-managed Apache Kafka cluster for your event source.
Type: SelfManagedEventSource object

** SourceAccessConfigurations ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 22 items.

** StartingPosition ** The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
Type: String
Valid Values: TRIM_HORIZON | LATEST | AT_TIMESTAMP

** StartingPositionTimestamp ** With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
Type: Timestamp

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

** StateTransitionReason ** Indicates whether a user or Lambda made the last change to the event source mapping.
Type: String

** Topics ** The name of the Kafka topic.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 249.
Pattern: ^[^.]([a-zA-Z0-9\-_.]+)

** TumblingWindowInSeconds ** (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 900.

** UUID ** The identifier of the event source mapping.
Type: String

Errors

** InvalidParameterValueException **
One of the parameters in the request is invalid.
HTTP Status Code: 400

** ResourceConflictException **
The resource already exists, or another operation is in progress.
HTTP Status Code: 409

** ResourceNotFoundException **
The resource specified in the request does not exist.
HTTP Status Code: 404

** ServiceException **
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500

** TooManyRequestsException **
The request throughput limit was exceeded.
HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: