DeleteEventSourceMapping
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.
Request Syntax
DELETE /2015-03-31/event-source-mappings/UUID HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- UUID
-
The identifier of the event source mapping.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"AmazonManagedKafkaEventSourceConfig": {
"ConsumerGroupId": "string",
"SchemaRegistryConfig": {
"AccessConfigs": [
{
"Type": "string",
"URI": "string"
}
],
"EventRecordFormat": "string",
"SchemaRegistryURI": "string",
"SchemaValidationConfigs": [
{
"Attribute": "string"
}
]
}
},
"BatchSize": number,
"BisectBatchOnFunctionError": boolean,
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"DocumentDBEventSourceConfig": {
"CollectionName": "string",
"DatabaseName": "string",
"FullDocument": "string"
},
"EventSourceArn": "string",
"EventSourceMappingArn": "string",
"FilterCriteria": {
"Filters": [
{
"Pattern": "string"
}
]
},
"FilterCriteriaError": {
"ErrorCode": "string",
"Message": "string"
},
"FunctionArn": "string",
"FunctionResponseTypes": [ "string" ],
"KMSKeyArn": "string",
"LastModified": number,
"LastProcessingResult": "string",
"LoggingConfig": {
"SystemLogLevel": "string"
},
"MaximumBatchingWindowInSeconds": number,
"MaximumRecordAgeInSeconds": number,
"MaximumRetryAttempts": number,
"MetricsConfig": {
"Metrics": [ "string" ]
},
"ParallelizationFactor": number,
"ProvisionedPollerConfig": {
"MaximumPollers": number,
"MinimumPollers": number,
"PollerGroupName": "string"
},
"Queues": [ "string" ],
"ScalingConfig": {
"MaximumConcurrency": number
},
"SelfManagedEventSource": {
"Endpoints": {
"string" : [ "string" ]
}
},
"SelfManagedKafkaEventSourceConfig": {
"ConsumerGroupId": "string",
"SchemaRegistryConfig": {
"AccessConfigs": [
{
"Type": "string",
"URI": "string"
}
],
"EventRecordFormat": "string",
"SchemaRegistryURI": "string",
"SchemaValidationConfigs": [
{
"Attribute": "string"
}
]
}
},
"SourceAccessConfigurations": [
{
"Type": "string",
"URI": "string"
}
],
"StartingPosition": "string",
"StartingPositionTimestamp": number,
"State": "string",
"StateTransitionReason": "string",
"Topics": [ "string" ],
"TumblingWindowInSeconds": number,
"UUID": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- AmazonManagedKafkaEventSourceConfig
-
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
Type: AmazonManagedKafkaEventSourceConfig object
- BatchSize
-
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set
BatchSizeto a value greater than 10, you must setMaximumBatchingWindowInSecondsto at least 1.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
- BisectBatchOnFunctionError
-
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry. The default value is false.
Type: Boolean
- DestinationConfig
-
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
Type: DestinationConfig object
- DocumentDBEventSourceConfig
-
Specific configuration settings for a DocumentDB event source.
Type: DocumentDBEventSourceConfig object
- EventSourceArn
-
The Amazon Resource Name (ARN) of the event source.
Type: String
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) - EventSourceMappingArn
-
The Amazon Resource Name (ARN) of the event source mapping.
Type: String
Length Constraints: Minimum length of 85. Maximum length of 120.
Pattern:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} - FilterCriteria
-
An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.