CARVIEW |
ListEventSourceMappings
Lists event source mappings. Specify an EventSourceArn
to show only event source mappings for a
single event source.
Request Syntax
GET /2015-03-31/event-source-mappings/?EventSourceArn=EventSourceArn
&FunctionName=FunctionName
&Marker=Marker
&MaxItems=MaxItems
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- EventSourceArn
-
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 or the ARN of the VPC connection (for cross-account event source mappings).
-
Amazon MQ – The ARN of the broker.
-
Amazon DocumentDB – The ARN of the DocumentDB change stream.
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
-
- FunctionName
-
The name or ARN 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.
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern:
(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
-
- Marker
-
A pagination token returned by a previous call.
- MaxItems
-
The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.
Valid Range: Minimum value of 1. Maximum value of 10000.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EventSourceMappings": [
{
"AmazonManagedKafkaEventSourceConfig": {
"ConsumerGroupId": "string",
"SchemaRegistryConfig": {
"AccessConfigs": [
{
"Type": "string",
"URI": "string"
}
],
"EventRecordFormat": "string",
"SchemaRegistryURI": "string",
"SchemaValidationConfigs": [
{
"Attribute": "string"
}
]
}
},
"BatchSize": number,
"BisectBatchOnFunctionError": boolean,
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"DocumentDBEventSourceConfig": {
"CollectionName": "string",
"DatabaseName": "string",
"FullDocument": "string"
},
"EventSourceArn": "string",
"EventSourceMappingArn": "string",
"FilterCriteria": {
"Filters": [
{
"Pattern": "string"
}
]
},
"FilterCriteriaError": {
"ErrorCode": "string",
"Message": "string"
},
"FunctionArn": "string",
"FunctionResponseTypes": [ "string" ],
"KMSKeyArn": "string",
"LastModified": number,
"LastProcessingResult": "string",
"MaximumBatchingWindowInSeconds": number,
"MaximumRecordAgeInSeconds": number,
"MaximumRetryAttempts": number,
"MetricsConfig": {
"Metrics": [ "string" ]
},
"ParallelizationFactor": number,
"ProvisionedPollerConfig": {
"MaximumPollers": number,
"MinimumPollers": number
},
"Queues": [ "string" ],
"ScalingConfig": {
"MaximumConcurrency": number
},
"SelfManagedEventSource": {
"Endpoints": {
"string" : [ "string" ]
}
},
"SelfManagedKafkaEventSourceConfig": {
"ConsumerGroupId": "string",
"SchemaRegistryConfig": {
"AccessConfigs": [
{
"Type": "string",
"URI": "string"
}
],
"EventRecordFormat": "string",
"SchemaRegistryURI": "string",
"SchemaValidationConfigs": [
{
"Attribute": "string"
}
]
}
},
"SourceAccessConfigurations": [
{
"Type": "string",
"URI": "string"
}
],
"StartingPosition": "string",
"StartingPositionTimestamp": number,
"State": "string",
"StateTransitionReason": "string",
"Topics": [ "string" ],
"TumblingWindowInSeconds": number,
"UUID": "string"
}
],
"NextMarker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EventSourceMappings
-
A list of event source mappings.
Type: Array of EventSourceMappingConfiguration objects
- NextMarker
-
A pagination token that's returned when the response doesn't contain all event source mappings.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
One of the parameters in the request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request does not exist.
HTTP Status Code: 404
- ServiceException
-
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500
- TooManyRequestsException
-
The request throughput limit was exceeded. For more information, see Lambda quotas.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.