Skip to content

Latest commit

 

History

History
247 lines (199 loc) · 13.9 KB

API_DeleteEventSourceMapping.md

File metadata and controls

247 lines (199 loc) · 13.9 KB
Raw

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"
   },
   "BatchSize": number,
   "BisectBatchOnFunctionError": boolean,
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "EventSourceArn": "string",
   "FilterCriteria": { 
      "Filters": [ 
         { 
            "Pattern": "string"
         }
      ]
   },
   "FunctionArn": "string",
   "FunctionResponseTypes": [ "string" ],
   "LastModified": number,
   "LastProcessingResult": "string",
   "MaximumBatchingWindowInSeconds": number,
   "MaximumRecordAgeInSeconds": number,
   "MaximumRetryAttempts": number,
   "ParallelizationFactor": number,
   "Queues": [ "string" ],
   "SelfManagedEventSource": { 
      "Endpoints": { 
         "string" : [ "string" ]
      }
   },
   "SelfManagedKafkaEventSourceConfig": { 
      "ConsumerGroupId": "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 BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.

** BisectBatchOnFunctionError ** (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
Type: Boolean

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

** EventSourceArn ** The Amazon Resource Name (ARN) of the event source.
Type: String
Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

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

** FunctionArn ** The ARN of the Lambda function.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?

** FunctionResponseTypes ** (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Valid Values: ReportBatchItemFailures

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

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

** 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: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

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

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

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

** Queues ** (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: [\s\S]*

** SelfManagedEventSource ** The self-managed Apache Kafka cluster for your event source.
Type: SelfManagedEventSource object

** SelfManagedKafkaEventSourceConfig ** Specific configuration settings for a self-managed Apache Kafka event source.
Type: SelfManagedKafkaEventSourceConfig object

** SourceAccessConfigurations ** An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 22 items.

** StartingPosition ** The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
Type: String
Valid Values: TRIM_HORIZON | LATEST | AT_TIMESTAMP

** StartingPositionTimestamp ** With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
Type: Timestamp

** State ** The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
Type: String

** StateTransitionReason ** Indicates whether a user or Lambda made the last change to the event source mapping.
Type: String

** Topics ** The name of the Kafka topic.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 249.
Pattern: ^[^.]([a-zA-Z0-9\-_.]+)

** TumblingWindowInSeconds ** (Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 900.

** UUID ** The identifier of the event source mapping.
Type: String

Errors

** InvalidParameterValueException **
One of the parameters in the request is invalid.
HTTP Status Code: 400

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

** ResourceNotFoundException **
The resource specified in the request does not exist.
HTTP Status Code: 404

** ServiceException **
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500

** TooManyRequestsException **
The request throughput limit was exceeded.
HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: