Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

  • BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
  • DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
  • MaximumRecordAgeInSeconds - 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
  • MaximumRetryAttempts - 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.
  • ParallelizationFactor - Process multiple batches from each shard concurrently.

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>]
[--destination-config <value>]
[--maximum-record-age-in-seconds <value>]
[--bisect-batch-on-function-error | --no-bisect-batch-on-function-error]
[--maximum-retry-attempts <value>]
[--parallelization-factor <value>]
[--source-access-configurations <value>]
[--tumbling-window-in-seconds <value>]
[--function-response-types <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)

If true, the event source mapping is active. Set to false 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. For standard queues the max is 10,000. For FIFO queues the max is 10.
  • Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
  • Self-Managed Apache Kafka - Default 100. Max 10,000.

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

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

--destination-config (structure)

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

Shorthand Syntax:

OnSuccess={Destination=string},OnFailure={Destination=string}

JSON Syntax:

{
  "OnSuccess": {
    "Destination": "string"
  },
  "OnFailure": {
    "Destination": "string"
  }
}

--maximum-record-age-in-seconds (integer)

(Streams) Discard records older than the specified age. The default value is infinite (-1).

--bisect-batch-on-function-error | --no-bisect-batch-on-function-error (boolean)

(Streams) If the function returns an error, split the batch in two and retry.

--maximum-retry-attempts (integer)

(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.

--parallelization-factor (integer)

(Streams) The number of batches to process from each shard concurrently.

--source-access-configurations (list)

An array of the authentication protocol, or the VPC components to secure your event source.

(structure)

You can specify the authentication protocol, or the VPC components to secure access to your event source.

Type -> (string)

The type of authentication protocol or the VPC components for your event source. For example: "Type":"SASL_SCRAM_512_AUTH" .

  • BASIC_AUTH - (MQ) The Secrets Manager secret that stores your broker credentials.
  • VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.
  • VPC_SECURITY_GROUP - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.
  • SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.
  • SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.

URI -> (string)

The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

Shorthand Syntax:

Type=string,URI=string ...

JSON Syntax:

[
  {
    "Type": "BASIC_AUTH"|"VPC_SUBNET"|"VPC_SECURITY_GROUP"|"SASL_SCRAM_512_AUTH"|"SASL_SCRAM_256_AUTH",
    "URI": "string"
  }
  ...
]

--tumbling-window-in-seconds (integer)

(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

--function-response-types (list)

(Streams) A list of current response type enums applied to the event source mapping.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ReportBatchItemFailures

--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.

Examples

To update the mapping between an event source and an AWS Lambda function

The following update-event-source-mapping example updates the batch size to 8 in the specified mapping.

aws lambda update-event-source-mapping \
    --uuid  "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \
    --batch-size 8

Output:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569284520.333,
    "BatchSize": 8,
    "State": "Updating",
    "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue"
}

For more information, see AWS Lambda Event Source Mapping in the AWS Lambda Developer Guide.

Output

UUID -> (string)

The identifier of the event source mapping.

StartingPosition -> (string)

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

StartingPositionTimestamp -> (timestamp)

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading.

BatchSize -> (integer)

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

MaximumBatchingWindowInSeconds -> (integer)

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

ParallelizationFactor -> (integer)

(Streams) The number of batches to process from each shard concurrently. The default value is 1.

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, or its state changed.

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)

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

DestinationConfig -> (structure)

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

Topics -> (list)

The name of the Kafka topic.

(string)

Queues -> (list)

(MQ) The name of the Amazon MQ broker destination queue to consume.

(string)

SourceAccessConfigurations -> (list)

An array of the authentication protocol, or the VPC components to secure your event source.

(structure)

You can specify the authentication protocol, or the VPC components to secure access to your event source.

Type -> (string)

The type of authentication protocol or the VPC components for your event source. For example: "Type":"SASL_SCRAM_512_AUTH" .

  • BASIC_AUTH - (MQ) The Secrets Manager secret that stores your broker credentials.
  • VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.
  • VPC_SECURITY_GROUP - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.
  • SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.
  • SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.

URI -> (string)

The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

SelfManagedEventSource -> (structure)

The Self-Managed Apache Kafka cluster for your event source.

Endpoints -> (map)

The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .

key -> (string)

value -> (list)

(string)

MaximumRecordAgeInSeconds -> (integer)

(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.

BisectBatchOnFunctionError -> (boolean)

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

MaximumRetryAttempts -> (integer)

(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.

TumblingWindowInSeconds -> (integer)

(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

FunctionResponseTypes -> (list)

(Streams) A list of current response type enums applied to the event source mapping.

(string)