Skip to content

Latest commit

 

History

History
338 lines (278 loc) · 17.4 KB

API_UpdateEventSourceMapping.md

File metadata and controls

338 lines (278 loc) · 17.4 KB

UpdateEventSourceMapping

Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.

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.

Request Syntax

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

{
   "BatchSize": number,
   "BisectBatchOnFunctionError": boolean,
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "Enabled": boolean,
   "FunctionName": "string",
   "FunctionResponseTypes": [ "string" ],
   "MaximumBatchingWindowInSeconds": number,
   "MaximumRecordAgeInSeconds": number,
   "MaximumRetryAttempts": number,
   "ParallelizationFactor": number,
   "SourceAccessConfigurations": [ 
      { 
         "Type": "string",
         "URI": "string"
      }
   ],
   "TumblingWindowInSeconds": number
}

URI Request Parameters

The request uses the following URI parameters.

** UUID ** The identifier of the event source mapping.
Required: Yes

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

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

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

** MaximumBatchingWindowInSeconds ** (Streams and SQS standard queues) 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) 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) 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) The number of batches to process from each shard concurrently.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No

** SourceAccessConfigurations ** An array of the authentication protocol, or the VPC components to secure your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 1 item. Maximum number of 22 items.
Required: No

** TumblingWindowInSeconds ** (Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.
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 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. The default value is false.
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-_]+))?

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

** 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 and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

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

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

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

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

** SelfManagedEventSource ** The Self-Managed Apache Kafka cluster for your event source.
Type: SelfManagedEventSource object

** SourceAccessConfigurations ** An array of the authentication protocol, or the VPC components to secure your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 1 item. 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 Streams sources. AT_TIMESTAMP is only supported 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 the last change to the event source mapping was made by a user, or by the Lambda service.
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) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.
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

ResourceInUseException
The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING state.
HTTP Status Code: 400

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: