Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lambda ]

update-event-source-mapping

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-event-source-mapping
--uuid <value>
[--function-name <value>]
[--enabled | --no-enabled]
[--batch-size <value>]
[--maximum-batching-window-in-seconds <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--uuid (string)

The identifier of the event source mapping.

--function-name (string)

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.

--enabled | --no-enabled (boolean)

Disables the event source mapping to pause polling and invocation.

--batch-size (integer)

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.

--maximum-batching-window-in-seconds (integer)

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

UUID -> (string)

The identifier of the event source mapping.

BatchSize -> (integer)

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

MaximumBatchingWindowInSeconds -> (integer)

EventSourceArn -> (string)

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

FunctionArn -> (string)

The ARN of the Lambda function.

LastModified -> (timestamp)

The date that the event source mapping was last updated.

LastProcessingResult -> (string)

The result of the last AWS Lambda invocation of your Lambda function.

State -> (string)

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

StateTransitionReason -> (string)

The cause of the last state change, either User initiated or Lambda initiated .