create-event-source-mapping¶

Description¶

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics.

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.
MaximumRetryAttempts - Discard records after the specified number of retries.
ParallelizationFactor - Process multiple batches from each shard concurrently.

Synopsis¶

  create-event-source-mapping
--event-source-arn <value>
--function-name <value>
[--enabled | --no-enabled]
[--batch-size <value>]
[--maximum-batching-window-in-seconds <value>]
[--parallelization-factor <value>]
[--starting-position <value>]
[--starting-position-timestamp <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>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--event-source-arn (string)

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

Amazon Kinesis - The ARN of the data stream or a stream consumer.

Amazon DynamoDB Streams - The ARN of the stream.

Amazon Simple Queue Service - The ARN of the queue.

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

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

--parallelization-factor (integer)

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

--starting-position (string)

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

Possible values:

TRIM_HORIZON

LATEST

AT_TIMESTAMP

--starting-position-timestamp (timestamp)

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

--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) The maximum age of a record that Lambda sends to a function for processing.

--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) The maximum number of times to retry when the function returns an error.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a mapping between an event source and an AWS Lambda function

The following create-event-source-mapping example creates a mapping between an SQS queue and the my-function Lambda function.

aws lambda create-event-source-mapping \
    --function-name my-function \
    --batch-size 5 \
    --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue

Output:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569284520.333,
    "BatchSize": 5,
    "State": "Creating",
    "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.

BatchSize -> (integer)

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

MaximumBatchingWindowInSeconds -> (integer)

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

ParallelizationFactor -> (integer)

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

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.

MaximumRecordAgeInSeconds -> (integer)

(Streams) The maximum age of a record that Lambda sends to a function for processing.

BisectBatchOnFunctionError -> (boolean)

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

MaximumRetryAttempts -> (integer)