AWS API Changes

2023/01/12 - AWS Lambda - 5 updated api methods

Changes Add support for MaximumConcurrency parameter for SQS event source. Customers can now limit the maximum concurrent invocations for their SQS Event Source Mapping.

CreateEventSourceMapping (updated)

Link ¶
Changes (both)

{'ScalingConfig': {'MaximumConcurrency': 'integer'}}

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

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

The following error handling options are available only 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.

See also: AWS API Documentation

Request Syntax

client.create_event_source_mapping(
    EventSourceArn='string',
    FunctionName='string',
    Enabled=True|False,
    BatchSize=123,
    FilterCriteria={
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    MaximumBatchingWindowInSeconds=123,
    ParallelizationFactor=123,
    StartingPosition='TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
    StartingPositionTimestamp=datetime(2015, 1, 1),
    DestinationConfig={
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    MaximumRecordAgeInSeconds=123,
    BisectBatchOnFunctionError=True|False,
    MaximumRetryAttempts=123,
    TumblingWindowInSeconds=123,
    Topics=[
        'string',
    ],
    Queues=[
        'string',
    ],
    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'
        },
    ],
    SelfManagedEventSource={
        'Endpoints': {
            'string': [
                'string',
            ]
        }
    },
    FunctionResponseTypes=[
        'ReportBatchItemFailures',
    ],
    AmazonManagedKafkaEventSourceConfig={
        'ConsumerGroupId': 'string'
    },
    SelfManagedKafkaEventSourceConfig={
        'ConsumerGroupId': 'string'
    },
    ScalingConfig={
        'MaximumConcurrency': 123
    }
)

type EventSourceArn

string

param 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.
Amazon MQ – The ARN of the broker.

type FunctionName

string

param FunctionName

[REQUIRED]

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 Enabled

boolean

param Enabled

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

Default: True

type BatchSize

integer

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

type FilterCriteria

dict

param FilterCriteria

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

Filters (list) --

A list of filters.
- (dict) --
  
  A structure within a FilterCriteria object that defines an event filtering pattern.
  - Pattern (string) --
    
    A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

type MaximumBatchingWindowInSeconds

integer

param MaximumBatchingWindowInSeconds

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, and Amazon MQ 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.

type ParallelizationFactor

integer

param ParallelizationFactor

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

type StartingPosition

string

param 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 supported only for Amazon Kinesis streams.

type StartingPositionTimestamp

datetime

param StartingPositionTimestamp

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.

type DestinationConfig

dict

param DestinationConfig

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess (dict) --

The destination configuration for successful invocations.
- Destination (string) --
  
  The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --

The destination configuration for failed invocations.
- Destination (string) --
  
  The Amazon Resource Name (ARN) of the destination resource.

type MaximumRecordAgeInSeconds

integer

param MaximumRecordAgeInSeconds

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

type BisectBatchOnFunctionError

boolean

param BisectBatchOnFunctionError

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

type MaximumRetryAttempts

integer

param MaximumRetryAttempts

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

type TumblingWindowInSeconds

integer

param TumblingWindowInSeconds

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

type Topics

list

param Topics

The name of the Kafka topic.

(string) --

type Queues

list

param Queues

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

(string) --

type SourceAccessConfigurations

list

param SourceAccessConfigurations

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

(dict) --

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
- 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.
- URI (string) --
  
  The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

type SelfManagedEventSource

dict

param SelfManagedEventSource

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

Endpoints (dict) --

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

type FunctionResponseTypes

list

param FunctionResponseTypes

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

(string) --

type AmazonManagedKafkaEventSourceConfig

dict

param AmazonManagedKafkaEventSourceConfig

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.

type SelfManagedKafkaEventSourceConfig

dict

param SelfManagedKafkaEventSourceConfig

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.

type ScalingConfig

dict

param ScalingConfig

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

rtype

dict

returns

Response Syntax

{
    'UUID': 'string',
    'StartingPosition': 'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
    'StartingPositionTimestamp': datetime(2015, 1, 1),
    'BatchSize': 123,
    'MaximumBatchingWindowInSeconds': 123,
    'ParallelizationFactor': 123,
    'EventSourceArn': 'string',
    'FilterCriteria': {
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    'FunctionArn': 'string',
    'LastModified': datetime(2015, 1, 1),
    'LastProcessingResult': 'string',
    'State': 'string',
    'StateTransitionReason': 'string',
    'DestinationConfig': {
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    'Topics': [
        'string',
    ],
    'Queues': [
        'string',
    ],
    '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'
        },
    ],
    'SelfManagedEventSource': {
        'Endpoints': {
            'string': [
                'string',
            ]
        }
    },
    'MaximumRecordAgeInSeconds': 123,
    'BisectBatchOnFunctionError': True|False,
    'MaximumRetryAttempts': 123,
    'TumblingWindowInSeconds': 123,
    'FunctionResponseTypes': [
        'ReportBatchItemFailures',
    ],
    'AmazonManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'SelfManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'ScalingConfig': {
        'MaximumConcurrency': 123
    }
}

Response Structure

(dict) --

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
- 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
- StartingPositionTimestamp (datetime) --
  
  With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.
- 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, and Amazon MQ 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) --
  
  (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 (dict) --
  
  An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - Filters (list) --
    
    A list of filters.
    - (dict) --
      
      A structure within a FilterCriteria object that defines an event filtering pattern.
      - 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 (datetime) --
  
  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 (dict) --
  
  (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - OnSuccess (dict) --
    
    The destination configuration for successful invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
  - OnFailure (dict) --
    
    The destination configuration for failed invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
- Topics (list) --
  
  The name of the Kafka topic.
  - (string) --
- Queues (list) --
  
  (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
  - (string) --
- SourceAccessConfigurations (list) --
  
  An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
  - (dict) --
    
    To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
    - 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.
    - URI (string) --
      
      The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .
- SelfManagedEventSource (dict) --
  
  The self-managed Apache Kafka cluster for your event source.
  - Endpoints (dict) --
    
    The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .
    - (string) --
      - (list) --
        
        (string) --
- MaximumRecordAgeInSeconds (integer) --
  
  (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.
- BisectBatchOnFunctionError (boolean) --
  
  (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
- MaximumRetryAttempts (integer) --
  
  (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) --
  
  (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
- FunctionResponseTypes (list) --
  
  (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
  - (string) --
- AmazonManagedKafkaEventSourceConfig (dict) --
  
  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 (dict) --
  
  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 (dict) --
  
  (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.

DeleteEventSourceMapping (updated)

Link ¶
Changes (response)

{'ScalingConfig': {'MaximumConcurrency': 'integer'}}

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

See also: AWS API Documentation

Request Syntax

client.delete_event_source_mapping(
    UUID='string'
)

type UUID

string

param UUID

[REQUIRED]

The identifier of the event source mapping.

rtype

dict

returns

Response Syntax

{
    'UUID': 'string',
    'StartingPosition': 'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
    'StartingPositionTimestamp': datetime(2015, 1, 1),
    'BatchSize': 123,
    'MaximumBatchingWindowInSeconds': 123,
    'ParallelizationFactor': 123,
    'EventSourceArn': 'string',
    'FilterCriteria': {
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    'FunctionArn': 'string',
    'LastModified': datetime(2015, 1, 1),
    'LastProcessingResult': 'string',
    'State': 'string',
    'StateTransitionReason': 'string',
    'DestinationConfig': {
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    'Topics': [
        'string',
    ],
    'Queues': [
        'string',
    ],
    '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'
        },
    ],
    'SelfManagedEventSource': {
        'Endpoints': {
            'string': [
                'string',
            ]
        }
    },
    'MaximumRecordAgeInSeconds': 123,
    'BisectBatchOnFunctionError': True|False,
    'MaximumRetryAttempts': 123,
    'TumblingWindowInSeconds': 123,
    'FunctionResponseTypes': [
        'ReportBatchItemFailures',
    ],
    'AmazonManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'SelfManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'ScalingConfig': {
        'MaximumConcurrency': 123
    }
}

Response Structure

(dict) --

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
- 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
- StartingPositionTimestamp (datetime) --
  
  With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.
- 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, and Amazon MQ 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) --
  
  (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 (dict) --
  
  An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - Filters (list) --
    
    A list of filters.
    - (dict) --
      
      A structure within a FilterCriteria object that defines an event filtering pattern.
      - 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 (datetime) --
  
  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 (dict) --
  
  (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - OnSuccess (dict) --
    
    The destination configuration for successful invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
  - OnFailure (dict) --
    
    The destination configuration for failed invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
- Topics (list) --
  
  The name of the Kafka topic.
  - (string) --
- Queues (list) --
  
  (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
  - (string) --
- SourceAccessConfigurations (list) --
  
  An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
  - (dict) --
    
    To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
    - 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.
    - URI (string) --
      
      The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .
- SelfManagedEventSource (dict) --
  
  The self-managed Apache Kafka cluster for your event source.
  - Endpoints (dict) --
    
    The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .
    - (string) --
      - (list) --
        
        (string) --
- MaximumRecordAgeInSeconds (integer) --
  
  (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.
- BisectBatchOnFunctionError (boolean) --
  
  (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
- MaximumRetryAttempts (integer) --
  
  (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) --
  
  (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
- FunctionResponseTypes (list) --
  
  (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
  - (string) --
- AmazonManagedKafkaEventSourceConfig (dict) --
  
  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 (dict) --
  
  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 (dict) --
  
  (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.

GetEventSourceMapping (updated)

Link ¶
Changes (response)

{'ScalingConfig': {'MaximumConcurrency': 'integer'}}

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

See also: AWS API Documentation

Request Syntax

client.get_event_source_mapping(
    UUID='string'
)

type UUID

string

param UUID

[REQUIRED]

The identifier of the event source mapping.

rtype

dict

returns

Response Syntax

{
    'UUID': 'string',
    'StartingPosition': 'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
    'StartingPositionTimestamp': datetime(2015, 1, 1),
    'BatchSize': 123,
    'MaximumBatchingWindowInSeconds': 123,
    'ParallelizationFactor': 123,
    'EventSourceArn': 'string',
    'FilterCriteria': {
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    'FunctionArn': 'string',
    'LastModified': datetime(2015, 1, 1),
    'LastProcessingResult': 'string',
    'State': 'string',
    'StateTransitionReason': 'string',
    'DestinationConfig': {
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    'Topics': [
        'string',
    ],
    'Queues': [
        'string',
    ],
    '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'
        },
    ],
    'SelfManagedEventSource': {
        'Endpoints': {
            'string': [
                'string',
            ]
        }
    },
    'MaximumRecordAgeInSeconds': 123,
    'BisectBatchOnFunctionError': True|False,
    'MaximumRetryAttempts': 123,
    'TumblingWindowInSeconds': 123,
    'FunctionResponseTypes': [
        'ReportBatchItemFailures',
    ],
    'AmazonManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'SelfManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'ScalingConfig': {
        'MaximumConcurrency': 123
    }
}

Response Structure

(dict) --

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
- 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
- StartingPositionTimestamp (datetime) --
  
  With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.
- 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, and Amazon MQ 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) --
  
  (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 (dict) --
  
  An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - Filters (list) --
    
    A list of filters.
    - (dict) --
      
      A structure within a FilterCriteria object that defines an event filtering pattern.
      - 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 (datetime) --
  
  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 (dict) --
  
  (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - OnSuccess (dict) --
    
    The destination configuration for successful invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
  - OnFailure (dict) --
    
    The destination configuration for failed invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
- Topics (list) --
  
  The name of the Kafka topic.
  - (string) --
- Queues (list) --
  
  (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
  - (string) --
- SourceAccessConfigurations (list) --
  
  An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
  - (dict) --
    
    To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
    - 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.
    - URI (string) --
      
      The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .
- SelfManagedEventSource (dict) --
  
  The self-managed Apache Kafka cluster for your event source.
  - Endpoints (dict) --
    
    The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .
    - (string) --
      - (list) --
        
        (string) --
- MaximumRecordAgeInSeconds (integer) --
  
  (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.
- BisectBatchOnFunctionError (boolean) --
  
  (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
- MaximumRetryAttempts (integer) --
  
  (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) --
  
  (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
- FunctionResponseTypes (list) --
  
  (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
  - (string) --
- AmazonManagedKafkaEventSourceConfig (dict) --
  
  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 (dict) --
  
  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 (dict) --
  
  (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.

ListEventSourceMappings (updated)

Link ¶
Changes (response)

{'EventSourceMappings': {'ScalingConfig': {'MaximumConcurrency': 'integer'}}}

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

See also: AWS API Documentation

Request Syntax

client.list_event_source_mappings(
    EventSourceArn='string',
    FunctionName='string',
    Marker='string',
    MaxItems=123
)

type EventSourceArn

string

param 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.
Amazon MQ – The ARN of the broker.

type FunctionName

string

param 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 Marker

string

param Marker

A pagination token returned by a previous call.

type MaxItems

integer

param MaxItems

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

rtype

dict

returns

Response Syntax

{
    'NextMarker': 'string',
    'EventSourceMappings': [
        {
            'UUID': 'string',
            'StartingPosition': 'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
            'StartingPositionTimestamp': datetime(2015, 1, 1),
            'BatchSize': 123,
            'MaximumBatchingWindowInSeconds': 123,
            'ParallelizationFactor': 123,
            'EventSourceArn': 'string',
            'FilterCriteria': {
                'Filters': [
                    {
                        'Pattern': 'string'
                    },
                ]
            },
            'FunctionArn': 'string',
            'LastModified': datetime(2015, 1, 1),
            'LastProcessingResult': 'string',
            'State': 'string',
            'StateTransitionReason': 'string',
            'DestinationConfig': {
                'OnSuccess': {
                    'Destination': 'string'
                },
                'OnFailure': {
                    'Destination': 'string'
                }
            },
            'Topics': [
                'string',
            ],
            'Queues': [
                'string',
            ],
            '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'
                },
            ],
            'SelfManagedEventSource': {
                'Endpoints': {
                    'string': [
                        'string',
                    ]
                }
            },
            'MaximumRecordAgeInSeconds': 123,
            'BisectBatchOnFunctionError': True|False,
            'MaximumRetryAttempts': 123,
            'TumblingWindowInSeconds': 123,
            'FunctionResponseTypes': [
                'ReportBatchItemFailures',
            ],
            'AmazonManagedKafkaEventSourceConfig': {
                'ConsumerGroupId': 'string'
            },
            'SelfManagedKafkaEventSourceConfig': {
                'ConsumerGroupId': 'string'
            },
            'ScalingConfig': {
                'MaximumConcurrency': 123
            }
        },
    ]
}

Response Structure

(dict) --
- NextMarker (string) --
  
  A pagination token that's returned when the response doesn't contain all event source mappings.
- EventSourceMappings (list) --
  
  A list of event source mappings.
  - (dict) --
    
    A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
    - 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    - StartingPositionTimestamp (datetime) --
      
      With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.
    - 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, and Amazon MQ 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) --
      
      (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 (dict) --
      
      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
      - Filters (list) --
        
        A list of filters.
        
        (dict) --
        
        A structure within a FilterCriteria object that defines an event filtering pattern.
        
        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 (datetime) --
      
      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 (dict) --
      
      (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
      - OnSuccess (dict) --
        
        The destination configuration for successful invocations.
        
        Destination (string) --
        
        The Amazon Resource Name (ARN) of the destination resource.
      - OnFailure (dict) --
        
        The destination configuration for failed invocations.
        
        Destination (string) --
        
        The Amazon Resource Name (ARN) of the destination resource.
    - Topics (list) --
      
      The name of the Kafka topic.
      - (string) --
    - Queues (list) --
      
      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
      - (string) --
    - SourceAccessConfigurations (list) --
      
      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
      - (dict) --
        
        To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
        
        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.
        
        URI (string) --
        
        The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .
    - SelfManagedEventSource (dict) --
      
      The self-managed Apache Kafka cluster for your event source.
      - Endpoints (dict) --
        
        The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .
        
        (string) --
        
        (list) --
        
        (string) --
    - MaximumRecordAgeInSeconds (integer) --
      
      (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.
    - BisectBatchOnFunctionError (boolean) --
      
      (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    - MaximumRetryAttempts (integer) --
      
      (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) --
      
      (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
    - FunctionResponseTypes (list) --
      
      (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
      - (string) --
    - AmazonManagedKafkaEventSourceConfig (dict) --
      
      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 (dict) --
      
      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 (dict) --
      
      (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.

UpdateEventSourceMapping (updated)

Link ¶
Changes (both)

{'ScalingConfig': {'MaximumConcurrency': 'integer'}}

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

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

The following error handling options are available only 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.

See also: AWS API Documentation

Request Syntax

client.update_event_source_mapping(
    UUID='string',
    FunctionName='string',
    Enabled=True|False,
    BatchSize=123,
    FilterCriteria={
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    MaximumBatchingWindowInSeconds=123,
    DestinationConfig={
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    MaximumRecordAgeInSeconds=123,
    BisectBatchOnFunctionError=True|False,
    MaximumRetryAttempts=123,
    ParallelizationFactor=123,
    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'
        },
    ],
    TumblingWindowInSeconds=123,
    FunctionResponseTypes=[
        'ReportBatchItemFailures',
    ],
    ScalingConfig={
        'MaximumConcurrency': 123
    }
)

type UUID

string

param UUID

[REQUIRED]

The identifier of the event source mapping.

type FunctionName

string

param 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 Enabled

boolean

param Enabled

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

Default: True

type BatchSize

integer

param BatchSize

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.

type FilterCriteria

dict

param FilterCriteria

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

Filters (list) --

A list of filters.
- (dict) --
  
  A structure within a FilterCriteria object that defines an event filtering pattern.
  - Pattern (string) --
    
    A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

type MaximumBatchingWindowInSeconds

integer

param MaximumBatchingWindowInSeconds

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.

type DestinationConfig

dict

param DestinationConfig

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess (dict) --

The destination configuration for successful invocations.
- Destination (string) --
  
  The Amazon Resource Name (ARN) of the destination resource.
OnFailure (dict) --

The destination configuration for failed invocations.
- Destination (string) --
  
  The Amazon Resource Name (ARN) of the destination resource.

type MaximumRecordAgeInSeconds

integer

param MaximumRecordAgeInSeconds

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

type BisectBatchOnFunctionError

boolean

param BisectBatchOnFunctionError

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

type MaximumRetryAttempts

integer

param MaximumRetryAttempts

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

type ParallelizationFactor

integer

param ParallelizationFactor

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

type SourceAccessConfigurations

list

param SourceAccessConfigurations

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

(dict) --

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
- 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.
- URI (string) --
  
  The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

type TumblingWindowInSeconds

integer

param TumblingWindowInSeconds

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

type FunctionResponseTypes

list

param FunctionResponseTypes

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

(string) --

type ScalingConfig

dict

param ScalingConfig

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

rtype

dict

returns

Response Syntax

{
    'UUID': 'string',
    'StartingPosition': 'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
    'StartingPositionTimestamp': datetime(2015, 1, 1),
    'BatchSize': 123,
    'MaximumBatchingWindowInSeconds': 123,
    'ParallelizationFactor': 123,
    'EventSourceArn': 'string',
    'FilterCriteria': {
        'Filters': [
            {
                'Pattern': 'string'
            },
        ]
    },
    'FunctionArn': 'string',
    'LastModified': datetime(2015, 1, 1),
    'LastProcessingResult': 'string',
    'State': 'string',
    'StateTransitionReason': 'string',
    'DestinationConfig': {
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    },
    'Topics': [
        'string',
    ],
    'Queues': [
        'string',
    ],
    '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'
        },
    ],
    'SelfManagedEventSource': {
        'Endpoints': {
            'string': [
                'string',
            ]
        }
    },
    'MaximumRecordAgeInSeconds': 123,
    'BisectBatchOnFunctionError': True|False,
    'MaximumRetryAttempts': 123,
    'TumblingWindowInSeconds': 123,
    'FunctionResponseTypes': [
        'ReportBatchItemFailures',
    ],
    'AmazonManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'SelfManagedKafkaEventSourceConfig': {
        'ConsumerGroupId': 'string'
    },
    'ScalingConfig': {
        'MaximumConcurrency': 123
    }
}

Response Structure

(dict) --

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
- 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, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
- StartingPositionTimestamp (datetime) --
  
  With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.
- 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, and Amazon MQ 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) --
  
  (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 (dict) --
  
  An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
  - Filters (list) --
    
    A list of filters.
    - (dict) --
      
      A structure within a FilterCriteria object that defines an event filtering pattern.
      - 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 (datetime) --
  
  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 (dict) --
  
  (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - OnSuccess (dict) --
    
    The destination configuration for successful invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
  - OnFailure (dict) --
    
    The destination configuration for failed invocations.
    - Destination (string) --
      
      The Amazon Resource Name (ARN) of the destination resource.
- Topics (list) --
  
  The name of the Kafka topic.
  - (string) --
- Queues (list) --
  
  (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
  - (string) --
- SourceAccessConfigurations (list) --
  
  An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
  - (dict) --
    
    To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
    - 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.
    - URI (string) --
      
      The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .
- SelfManagedEventSource (dict) --
  
  The self-managed Apache Kafka cluster for your event source.
  - Endpoints (dict) --
    
    The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .
    - (string) --
      - (list) --
        
        (string) --
- MaximumRecordAgeInSeconds (integer) --
  
  (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.
- BisectBatchOnFunctionError (boolean) --
  
  (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
- MaximumRetryAttempts (integer) --
  
  (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) --
  
  (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
- FunctionResponseTypes (list) --
  
  (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
  - (string) --
- AmazonManagedKafkaEventSourceConfig (dict) --
  
  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 (dict) --
  
  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 (dict) --
  
  (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.