Skip to content

Latest commit

 

History

History
153 lines (117 loc) · 7.81 KB

API_UpdateEventSourceMapping.md

File metadata and controls

153 lines (117 loc) · 7.81 KB

UpdateEventSourceMapping

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

Request Syntax

PUT /2015-03-31/event-source-mappings/UUID HTTP/1.1
Content-type: application/json

{
   "[BatchSize](#SSS-UpdateEventSourceMapping-request-BatchSize)": number,
   "[Enabled](#SSS-UpdateEventSourceMapping-request-Enabled)": boolean,
   "[FunctionName](#SSS-UpdateEventSourceMapping-request-FunctionName)": "string"
}

URI Request Parameters

The request requires the following URI parameters.

** UUID ** The identifier of the event source mapping.

Request Body

The request accepts the following data in JSON format.

** BatchSize ** The maximum number of items to retrieve in a single batch.

  • Amazon Kinesis - Default 100. Max 10,000.
  • Amazon DynamoDB Streams - Default 100. Max 1,000.
  • Amazon Simple Queue Service - Default 10. Max 10. Type: Integer
    Valid Range: Minimum value of 1. Maximum value of 10000.
    Required: No

** Enabled ** Disables the event source mapping to pause polling and invocation.
Type: Boolean
Required: No

** 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: String
    Length Constraints: Minimum length of 1. Maximum length of 140.
    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-_]+))?
    Required: No

Response Syntax

HTTP/1.1 202
Content-type: application/json

{
   "[BatchSize](#SSS-UpdateEventSourceMapping-response-BatchSize)": number,
   "[EventSourceArn](#SSS-UpdateEventSourceMapping-response-EventSourceArn)": "string",
   "[FunctionArn](#SSS-UpdateEventSourceMapping-response-FunctionArn)": "string",
   "[LastModified](#SSS-UpdateEventSourceMapping-response-LastModified)": number,
   "[LastProcessingResult](#SSS-UpdateEventSourceMapping-response-LastProcessingResult)": "string",
   "[State](#SSS-UpdateEventSourceMapping-response-State)": "string",
   "[StateTransitionReason](#SSS-UpdateEventSourceMapping-response-StateTransitionReason)": "string",
   "[UUID](#SSS-UpdateEventSourceMapping-response-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.

** 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, in Unix time seconds.
Type: Timestamp

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

** 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 ** The cause of the last state change, either User initiated or Lambda initiated.
Type: String

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

Errors

InvalidParameterValueException
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
HTTP Status Code: 400

ResourceConflictException
The resource already exists.
HTTP Status Code: 409

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

ResourceNotFoundException
The resource (for example, a Lambda function or access policy statement) 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
Request throughput limit 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: