GetEventSourceMapping
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
Request Syntax
GET /2015-03-31/event-source-mappings/UUID
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- UUID
-
The identifier of the event source mapping.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BatchSize": number,
"BisectBatchOnFunctionError": boolean,
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"EventSourceArn": "string",
"FunctionArn": "string",
"FunctionResponseTypes": [ "string" ],
"LastModified": number,
"LastProcessingResult": "string",
"MaximumBatchingWindowInSeconds": number,
"MaximumRecordAgeInSeconds": number,
"MaximumRetryAttempts": number,
"ParallelizationFactor": number,
"Queues": [ "string" ],
"SelfManagedEventSource": {
"Endpoints": {
"string" : [ "string" ]
}
},
"SourceAccessConfigurations": [
{
"Type": "string",
"URI": "string"
}
],
"StartingPosition": "string",
"StartingPositionTimestamp": number,
"State": "string",
"StateTransitionReason": "string",
"Topics": [ "string" ],
"TumblingWindowInSeconds": number,
"UUID": "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.
- BatchSize
-
The maximum number of items to retrieve in a single batch.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
- BisectBatchOnFunctionError
-
(Streams) If the function returns an error, split the batch in two and retry. The default value is false.
Type: Boolean
- DestinationConfig
-
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
Type: DestinationConfig object
- EventSourceArn
-
The Amazon Resource Name (ARN) of the event source.
Type: String
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
- FunctionArn
-
The ARN of the Lambda function.
Type: String
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-_]+))?
- FunctionResponseTypes
-
(Streams) A list of current response type enums applied to the event source mapping.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
ReportBatchItemFailures
- LastModified
-
The date that the event source mapping was last updated, or its state changed, in Unix time seconds.
Type: Timestamp
- LastProcessingResult
-
The result of the last AWS Lambda invocation of your Lambda function.
Type: String
- MaximumBatchingWindowInSeconds
-
(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
- MaximumRecordAgeInSeconds
-
(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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 604800.
- MaximumRetryAttempts
-
(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.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 10000.
- ParallelizationFactor
-
(Streams) The number of batches to process from each shard concurrently. The default value is 1.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
- Queues
-
(MQ) The name of the Amazon MQ broker destination queue to consume.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[\s\S]*
- SelfManagedEventSource
-
The Self-Managed Apache Kafka cluster for your event source.
Type: SelfManagedEventSource object
- SourceAccessConfigurations
-
An array of the authentication protocol, or the VPC components to secure your event source.
Type: Array of SourceAccessConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 22 items.
- StartingPosition
-
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.Type: String
Valid Values:
TRIM_HORIZON | LATEST | AT_TIMESTAMP
- StartingPositionTimestamp
-
With
StartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.Type: Timestamp
- State
-
The state of the event source mapping. It can be one of the following:
Creating
,Enabling
,Enabled
,Disabling
,Disabled
,Updating
, orDeleting
.Type: String
- StateTransitionReason
-
Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
Type: String
- Topics
-
The name of the Kafka topic.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 249.
Pattern:
^[^.]([a-zA-Z0-9\-_.]+)
- TumblingWindowInSeconds
-
(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 900.
- UUID
-
The identifier of the event source mapping.
Type: String
Errors
- InvalidParameterValueException
-
One of the parameters in the request is invalid.
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.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: