Skip to content

Latest commit

 

History

History
187 lines (147 loc) · 9.63 KB

API_DeleteEventSourceMapping.md

File metadata and controls

187 lines (147 loc) · 9.63 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

{
   "BatchSize": number,
   "BisectBatchOnFunctionError": boolean,
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "EventSourceArn": "string",
   "FunctionArn": "string",
   "LastModified": number,
   "LastProcessingResult": "string",
   "MaximumBatchingWindowInSeconds": number,
   "MaximumRecordAgeInSeconds": number,
   "MaximumRetryAttempts": number,
   "ParallelizationFactor": number,
   "Queues": [ "string" ],
   "SourceAccessConfigurations": [ 
      { 
         "Type": "string",
         "URI": "string"
      }
   ],
   "State": "string",
   "StateTransitionReason": "string",
   "Topics": [ "string" ],
   "UUID": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

** BatchSize ** The maximum number of items to retrieve in a single batch.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.

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

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

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

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

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

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

** MaximumBatchingWindowInSeconds ** (Streams) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

** MaximumRecordAgeInSeconds ** (Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 604800.

** MaximumRetryAttempts ** (Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 10000.

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

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

** SourceAccessConfigurations ** (MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format: { "username": "your username", "password": "your password" }
To reference the secret, use the following format: [ { "Type": "BASIC_AUTH", "URI": "secretARN" } ]
The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.
Type: Array of SourceAccessConfiguration objects
Array Members: Fixed number of 1 item.

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

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

** Topics ** (MSK) The name of the Kafka topic to consume.
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\-_.]+)

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