Table Of Contents

Feedback

User Guide

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

[ aws . lambda ]

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-event-source-mapping
--event-source-arn <value>
--function-name <value>
[--enabled | --no-enabled]
[--batch-size <value>]
[--starting-position <value>]
[--starting-position-timestamp <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <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.

--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 Unix time in seconds from which to start reading.

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

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, in Unix time seconds.

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 .