Skip to content

API_GetEventSourceMapping.md

Latest commit

 

History

History
151 lines (116 loc) · 8.12 KB

API_GetEventSourceMapping.md

File metadata and controls

151 lines (116 loc) · 8.12 KB

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 requires the following URI parameters.

** UUID ** The identifier of the event source mapping.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "[BatchSize](#SSS-GetEventSourceMapping-response-BatchSize)": number,
   "[BisectBatchOnFunctionError](#SSS-GetEventSourceMapping-response-BisectBatchOnFunctionError)": boolean,
   "[DestinationConfig](#SSS-GetEventSourceMapping-response-DestinationConfig)": { 
      "[OnFailure](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnFailure)": { 
         "[Destination](API_OnFailure.md#SSS-Type-OnFailure-Destination)": "string"
      },
      "[OnSuccess](API_DestinationConfig.md#SSS-Type-DestinationConfig-OnSuccess)": { 
         "[Destination](API_OnSuccess.md#SSS-Type-OnSuccess-Destination)": "string"
      }
   },
   "[EventSourceArn](#SSS-GetEventSourceMapping-response-EventSourceArn)": "string",
   "[FunctionArn](#SSS-GetEventSourceMapping-response-FunctionArn)": "string",
   "[LastModified](#SSS-GetEventSourceMapping-response-LastModified)": number,
   "[LastProcessingResult](#SSS-GetEventSourceMapping-response-LastProcessingResult)": "string",
   "[MaximumBatchingWindowInSeconds](#SSS-GetEventSourceMapping-response-MaximumBatchingWindowInSeconds)": number,
   "[MaximumRecordAgeInSeconds](#SSS-GetEventSourceMapping-response-MaximumRecordAgeInSeconds)": number,
   "[MaximumRetryAttempts](#SSS-GetEventSourceMapping-response-MaximumRetryAttempts)": number,
   "[ParallelizationFactor](#SSS-GetEventSourceMapping-response-ParallelizationFactor)": number,
   "[State](#SSS-GetEventSourceMapping-response-State)": "string",
   "[StateTransitionReason](#SSS-GetEventSourceMapping-response-StateTransitionReason)": "string",
   "[UUID](#SSS-GetEventSourceMapping-response-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.
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-_]+))?

** 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) The maximum amount of time to gather records before invoking the function, in seconds.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.

** MaximumRecordAgeInSeconds ** (Streams) The maximum age of a record that Lambda sends to a function for processing.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 604800.

** MaximumRetryAttempts ** (Streams) The maximum number of times to retry when the function returns an error.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000.

** ParallelizationFactor ** (Streams) The number of batches to process from each shard concurrently.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.

** State ** The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
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

** 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: