openapi: 3.2.0 info: version: 2015-03-31 x-release: v4 title: AWS Lambda Event Source Mappings API description: 'Lambda Overview Lambda is a compute service that lets you run code without provisioning or managing servers.' x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: lambda x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lambda-2015-03-31.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://lambda.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Lambda multi-region endpoint - url: https://lambda.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Lambda multi-region endpoint - url: http://lambda.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Lambda endpoint for China (Beijing) and China (Ningxia) - url: https://lambda.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Lambda endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Event Source Mappings paths: /2015-03-31/event-source-mappings/: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEventSourceMapping description: '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. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB 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. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB' responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - FunctionName properties: EventSourceArn: description:

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})?:(.*) FunctionName: description:

The name of the Lambda function.

Name formats

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 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-_]+))? minLength: 1 maxLength: 140 Enabled: description: '

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

Default: True

' type: boolean BatchSize: description:

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

type: integer minimum: 1 maximum: 10000 FilterCriteria: description: ' An object that contains the filters for an event source. ' type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' MaximumBatchingWindowInSeconds: description: '

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

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

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

' type: integer minimum: 0 maximum: 300 ParallelizationFactor: description: (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently. type: integer minimum: 1 maximum: 10 StartingPosition: description: 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 and Amazon DocumentDB. type: string enum: - TRIM_HORIZON - LATEST - AT_TIMESTAMP StartingPositionTimestamp: description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. type: string format: date-time DestinationConfig: description: A configuration object that specifies the destination of an event after Lambda processes it. type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. MaximumRecordAgeInSeconds: description: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1). type: integer minimum: -1 maximum: 604800 BisectBatchOnFunctionError: description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. type: boolean MaximumRetryAttempts: description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires. type: integer minimum: -1 maximum: 10000 TumblingWindowInSeconds: description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. type: integer minimum: 0 maximum: 900 Topics: description: The name of the Kafka topic. type: array items: $ref: '#/components/schemas/Topic' minItems: 1 maxItems: 1 Queues: description: ' (MQ) The name of the Amazon MQ broker destination queue to consume. ' type: array items: $ref: '#/components/schemas/Queue' minItems: 1 maxItems: 1 SourceAccessConfigurations: description: An array of authentication protocols or VPC components required to secure your event source. type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 SelfManagedEventSource: description: The self-managed Apache Kafka cluster for your event source. type: object properties: Endpoints: allOf: - $ref: '#/components/schemas/Endpoints' - description: 'The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].' FunctionResponseTypes: description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 AmazonManagedKafkaEventSourceConfig: description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: 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: description: Specific configuration settings for a self-managed Apache Kafka event source. type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: 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: description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. DocumentDBEventSourceConfig: description: ' Specific configuration settings for a DocumentDB event source. ' type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' tags: - Event Source Mappings summary: Create event source mapping x-summary-source: derived get: operationId: ListEventSourceMappings description: Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEventSourceMappingsResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: EventSourceArn in: query required: false description:

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

schema: type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) - name: FunctionName in: query required: false description:

The name of the Lambda function.

Name formats

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

schema: 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-_]+))? minLength: 1 maxLength: 140 - name: Marker in: query required: false description: A pagination token returned by a previous call. schema: type: string - name: MaxItems in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 10000 tags: - Event Source Mappings summary: List event source mappings x-summary-source: derived /2015-03-31/event-source-mappings/{UUID}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEventSourceMapping description: '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.' responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string tags: - Event Source Mappings summary: Delete event source mapping x-summary-source: derived get: operationId: GetEventSourceMapping description: Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string tags: - Event Source Mappings summary: Get event source mapping x-summary-source: derived put: operationId: UpdateEventSourceMapping description: '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. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB 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. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka Amazon DocumentDB' responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '485': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: FunctionName: description:

The name of the Lambda function.

Name formats

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 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-_]+))? minLength: 1 maxLength: 140 Enabled: description: '

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

Default: True

' type: boolean BatchSize: description:

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

type: integer minimum: 1 maximum: 10000 FilterCriteria: description: ' An object that contains the filters for an event source. ' type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' MaximumBatchingWindowInSeconds: description: '

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

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

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

' type: integer minimum: 0 maximum: 300 DestinationConfig: description: A configuration object that specifies the destination of an event after Lambda processes it. type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. MaximumRecordAgeInSeconds: description: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1). type: integer minimum: -1 maximum: 604800 BisectBatchOnFunctionError: description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. type: boolean MaximumRetryAttempts: description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires. type: integer minimum: -1 maximum: 10000 ParallelizationFactor: description: (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently. type: integer minimum: 1 maximum: 10 SourceAccessConfigurations: description: An array of authentication protocols or VPC components required to secure your event source. type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 TumblingWindowInSeconds: description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. type: integer minimum: 0 maximum: 900 FunctionResponseTypes: description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 ScalingConfig: description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. DocumentDBEventSourceConfig: description: ' Specific configuration settings for a DocumentDB event source. ' type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' tags: - Event Source Mappings summary: Update event source mapping x-summary-source: derived components: schemas: MaximumRetryAttemptsEventSourceMapping: type: integer minimum: -1 maximum: 10000 CollectionName: type: string pattern: (^(?!(system\x2e)))(^[_a-zA-Z0-9])([^$]*) minLength: 1 maxLength: 57 MaximumBatchingWindowInSeconds: type: integer minimum: 0 maximum: 300 ServiceException: {} Queue: type: string pattern: '[\s\S]*' minLength: 1 maxLength: 1000 ListEventSourceMappingsResponse: type: object properties: NextMarker: allOf: - $ref: '#/components/schemas/String' - description: A pagination token that's returned when the response doesn't contain all event source mappings. EventSourceMappings: allOf: - $ref: '#/components/schemas/EventSourceMappingsList' - description: A list of event source mappings. SourceAccessConfigurations: type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 FilterList: type: array items: $ref: '#/components/schemas/Filter' MaximumConcurrency: type: integer minimum: 2 maximum: 1000 Endpoint: type: string pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5} minLength: 1 maxLength: 300 Filter: type: object properties: Pattern: allOf: - $ref: '#/components/schemas/Pattern' - description: ' A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax. ' description: ' A structure within a FilterCriteria object that defines an event filtering pattern. ' ParallelizationFactor: type: integer minimum: 1 maximum: 10 OnSuccess: type: object properties: Destination: allOf: - $ref: '#/components/schemas/DestinationArn' - description: The Amazon Resource Name (ARN) of the destination resource. description: A destination for events that were processed successfully. FunctionResponseTypeList: type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 SourceAccessConfiguration: type: object properties: Type: allOf: - $ref: '#/components/schemas/SourceAccessType' - description: '

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

' URI: allOf: - $ref: '#/components/schemas/URI' - description: 'The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".' description: To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host. SelfManagedEventSource: type: object properties: Endpoints: allOf: - $ref: '#/components/schemas/Endpoints' - description: 'The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].' description: The self-managed Apache Kafka cluster for your event source. Queues: type: array items: $ref: '#/components/schemas/Queue' minItems: 1 maxItems: 1 ResourceNotFoundException: {} EventSourceMappingsList: type: array items: $ref: '#/components/schemas/EventSourceMappingConfiguration' TumblingWindowInSeconds: type: integer minimum: 0 maximum: 900 BatchSize: type: integer minimum: 1 maximum: 10000 Arn: type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) OnFailure: type: object properties: Destination: allOf: - $ref: '#/components/schemas/DestinationArn' - description: The Amazon Resource Name (ARN) of the destination resource. description: A destination for events that failed processing. InvalidParameterValueException: {} MaximumRecordAgeInSeconds: type: integer minimum: -1 maximum: 604800 EventSourcePosition: type: string enum: - TRIM_HORIZON - LATEST - AT_TIMESTAMP ResourceInUseException: {} TooManyRequestsException: {} DatabaseName: type: string pattern: '[^ /\.$\x22]*' minLength: 1 maxLength: 63 ResourceConflictException: {} BisectBatchOnFunctionError: type: boolean EventSourceMappingConfiguration: type: object properties: UUID: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the event source mapping. StartingPosition: allOf: - $ref: '#/components/schemas/EventSourcePosition' - description: 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 and Amazon DocumentDB. StartingPositionTimestamp: allOf: - $ref: '#/components/schemas/Date' - description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. BatchSize: allOf: - $ref: '#/components/schemas/BatchSize' - description: '

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: allOf: - $ref: '#/components/schemas/MaximumBatchingWindowInSeconds' - description: '

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

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

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

' ParallelizationFactor: allOf: - $ref: '#/components/schemas/ParallelizationFactor' - description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. EventSourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the event source. FilterCriteria: allOf: - $ref: '#/components/schemas/FilterCriteria' - description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering. FunctionArn: allOf: - $ref: '#/components/schemas/FunctionArn' - description: The ARN of the Lambda function. LastModified: allOf: - $ref: '#/components/schemas/Date' - description: The date that the event source mapping was last updated or that its state changed. LastProcessingResult: allOf: - $ref: '#/components/schemas/String' - description: The result of the last Lambda invocation of your function. State: allOf: - $ref: '#/components/schemas/String' - description: 'The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.' StateTransitionReason: allOf: - $ref: '#/components/schemas/String' - description: Indicates whether a user or Lambda made the last change to the event source mapping. DestinationConfig: allOf: - $ref: '#/components/schemas/DestinationConfig' - description: (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records. Topics: allOf: - $ref: '#/components/schemas/Topics' - description: The name of the Kafka topic. Queues: allOf: - $ref: '#/components/schemas/Queues' - description: ' (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.' SourceAccessConfigurations: allOf: - $ref: '#/components/schemas/SourceAccessConfigurations' - description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. SelfManagedEventSource: allOf: - $ref: '#/components/schemas/SelfManagedEventSource' - description: The self-managed Apache Kafka cluster for your event source. MaximumRecordAgeInSeconds: allOf: - $ref: '#/components/schemas/MaximumRecordAgeInSeconds' - description:

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

The minimum value that can be set is 60 seconds.

 BisectBatchOnFunctionError: allOf: - $ref: '#/components/schemas/BisectBatchOnFunctionError' - description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. MaximumRetryAttempts: allOf: - $ref: '#/components/schemas/MaximumRetryAttemptsEventSourceMapping' - description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. TumblingWindowInSeconds: allOf: - $ref: '#/components/schemas/TumblingWindowInSeconds' - description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. FunctionResponseTypes: allOf: - $ref: '#/components/schemas/FunctionResponseTypeList' - description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. AmazonManagedKafkaEventSourceConfig: allOf: - $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' - description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. SelfManagedKafkaEventSourceConfig: allOf: - $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' - description: Specific configuration settings for a self-managed Apache Kafka event source. ScalingConfig: allOf: - $ref: '#/components/schemas/ScalingConfig' - description: (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources. DocumentDBEventSourceConfig: allOf: - $ref: '#/components/schemas/DocumentDBEventSourceConfig' - description: Specific configuration settings for a DocumentDB event source. description: A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping. Topic: type: string pattern: ^[^.]([a-zA-Z0-9\-_.]+) minLength: 1 maxLength: 249 Endpoints: type: object minProperties: 1 maxProperties: 2 additionalProperties: $ref: '#/components/schemas/EndpointLists' SourceAccessType: type: string enum: - 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 FilterCriteria: type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' description: ' An object that contains the filters for an event source. ' DestinationConfig: type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. description: A configuration object that specifies the destination of an event after Lambda processes it. SelfManagedKafkaEventSourceConfig: type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: 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. description: Specific configuration settings for a self-managed Apache Kafka event source. ScalingConfig: type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. String: type: string FullDocument: type: string enum: - UpdateLookup - Default Pattern: type: string pattern: .* minLength: 0 maxLength: 4096 URI: type: string pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' minLength: 1 maxLength: 200 Date: type: string format: date-time FunctionArn: 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-_]+))? AmazonManagedKafkaEventSourceConfig: type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: 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. description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. Topics: type: array items: $ref: '#/components/schemas/Topic' minItems: 1 maxItems: 1 EndpointLists: type: array items: $ref: '#/components/schemas/Endpoint' minItems: 1 maxItems: 10 DestinationArn: type: string pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) minLength: 0 maxLength: 350 FunctionResponseType: type: string enum: - ReportBatchItemFailures DocumentDBEventSourceConfig: type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' description: ' Specific configuration settings for a DocumentDB event source. ' parameters: X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/lambda/ x-hasEquivalentPaths: true