Skip to content

Latest commit

 

History

History
269 lines (218 loc) · 15.3 KB

API_CreateEventSourceMapping.md

File metadata and controls

269 lines (218 loc) · 15.3 KB

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 each event source type, 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.
  • MaximumRetryAttempts - Discard records after the specified number of retries.
  • ParallelizationFactor - Process multiple batches from each shard concurrently.

Request Syntax

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

{
   "[BatchSize](#SSS-CreateEventSourceMapping-request-BatchSize)": number,
   "[BisectBatchOnFunctionError](#SSS-CreateEventSourceMapping-request-BisectBatchOnFunctionError)": boolean,
   "[DestinationConfig](#SSS-CreateEventSourceMapping-request-DestinationConfig)": { 
      "[OnFailure](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnFailure)": { 
         "[Destination](API_OnFailure.md#SSS-Type-OnFailure-Destination)": "string"
      },
      "[OnSuccess](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnSuccess)": { 
         "[Destination](API_OnSuccess.md#SSS-Type-OnSuccess-Destination)": "string"
      }
   },
   "[Enabled](#SSS-CreateEventSourceMapping-request-Enabled)": boolean,
   "[EventSourceArn](#SSS-CreateEventSourceMapping-request-EventSourceArn)": "string",
   "[FunctionName](#SSS-CreateEventSourceMapping-request-FunctionName)": "string",
   "[MaximumBatchingWindowInSeconds](#SSS-CreateEventSourceMapping-request-MaximumBatchingWindowInSeconds)": number,
   "[MaximumRecordAgeInSeconds](#SSS-CreateEventSourceMapping-request-MaximumRecordAgeInSeconds)": number,
   "[MaximumRetryAttempts](#SSS-CreateEventSourceMapping-request-MaximumRetryAttempts)": number,
   "[ParallelizationFactor](#SSS-CreateEventSourceMapping-request-ParallelizationFactor)": number,
   "[StartingPosition](#SSS-CreateEventSourceMapping-request-StartingPosition)": "string",
   "[StartingPositionTimestamp](#SSS-CreateEventSourceMapping-request-StartingPositionTimestamp)": 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 items to retrieve in a single batch.

  • Amazon Kinesis - Default 100. Max 10,000.
  • Amazon DynamoDB Streams - Default 100. Max 1,000.
  • Amazon Simple Queue Service - Default 10. Max 10. Type: Integer
    Valid Range: Minimum value of 1. Maximum value of 10000.
    Required: No

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

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

** Enabled ** If true, the event source mapping is active. Set to false to pause polling and invocation.
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. Type: String
    Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
    Required: Yes

** 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

** MaximumBatchingWindowInSeconds ** (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No

** MaximumRecordAgeInSeconds ** (Streams) The maximum age of a record that Lambda sends to a function for processing.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 604800.
Required: No

** MaximumRetryAttempts ** (Streams) The maximum number of times to retry when the function returns an error.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000.
Required: No

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

** StartingPosition ** The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB 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

Response Syntax

HTTP/1.1 202
Content-type: application/json

{
   "[BatchSize](#SSS-CreateEventSourceMapping-response-BatchSize)": number,
   "[BisectBatchOnFunctionError](#SSS-CreateEventSourceMapping-response-BisectBatchOnFunctionError)": boolean,
   "[DestinationConfig](#SSS-CreateEventSourceMapping-response-DestinationConfig)": { 
      "[OnFailure](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnFailure)": { 
         "[Destination](API_OnFailure.md#SSS-Type-OnFailure-Destination)": "string"
      },
      "[OnSuccess](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnSuccess)": { 
         "[Destination](API_OnSuccess.md#SSS-Type-OnSuccess-Destination)": "string"
      }
   },
   "[EventSourceArn](#SSS-CreateEventSourceMapping-response-EventSourceArn)": "string",
   "[FunctionArn](#SSS-CreateEventSourceMapping-response-FunctionArn)": "string",
   "[LastModified](#SSS-CreateEventSourceMapping-response-LastModified)": number,
   "[LastProcessingResult](#SSS-CreateEventSourceMapping-response-LastProcessingResult)": "string",
   "[MaximumBatchingWindowInSeconds](#SSS-CreateEventSourceMapping-response-MaximumBatchingWindowInSeconds)": number,
   "[MaximumRecordAgeInSeconds](#SSS-CreateEventSourceMapping-response-MaximumRecordAgeInSeconds)": number,
   "[MaximumRetryAttempts](#SSS-CreateEventSourceMapping-response-MaximumRetryAttempts)": number,
   "[ParallelizationFactor](#SSS-CreateEventSourceMapping-response-ParallelizationFactor)": number,
   "[State](#SSS-CreateEventSourceMapping-response-State)": "string",
   "[StateTransitionReason](#SSS-CreateEventSourceMapping-response-StateTransitionReason)": "string",
   "[UUID](#SSS-CreateEventSourceMapping-response-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 items to retrieve in a single batch.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.

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

** DestinationConfig ** (Streams) 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-_]+))?

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

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

** MaximumBatchingWindowInSeconds ** (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

** MaximumRecordAgeInSeconds ** (Streams) The maximum age of a record that Lambda sends to a function for processing.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 604800.

** MaximumRetryAttempts ** (Streams) The maximum number of times to retry when the function returns an error.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000.

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

** 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 the last change to the event source mapping was made by a user, or by the Lambda service.
Type: String

** 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: