list-event-source-mappings¶

Description¶

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.

Synopsis¶

  list-event-source-mappings
[--event-source-arn <value>]
[--function-name <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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.

Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.

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

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list the event source mappings for a function

The following list-event-source-mappings example displays a list of the event source mappings for the my-function Lambda function.

aws lambda list-event-source-mappings \
    --function-name my-function

Output:

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

NextMarker -> (string)

A pagination token that’s returned when the response doesn’t contain all event source mappings.

EventSourceMappings -> (list)

A list of event source mappings.

(structure)

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

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

VPC_SECURITY_GROUP - The VPC security group used to manage access to your Kafka brokers.

SASL_SCRAM_256_AUTH - The ARN of your secret key used for SASL SCRAM-256 authentication of your Kafka brokers.

SASL_SCRAM_512_AUTH - The ARN of your secret key used for SASL SCRAM-512 authentication of your 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 of a processing window in seconds. The range is between 1 second up to 15 minutes.

FunctionResponseTypes -> (list)

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

(string)

Table of Contents

Feedback

User Guide