Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.
This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.
Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.
This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.
Deletes the specified Lambda function code and configuration.
This operation requires permission for the lambda:DeleteFunction action.
Returns configuration information for the specified event source mapping (see AddEventSource).
This operation requires permission for the lambda:GetEventSource action.
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
This operation requires permission for the lambda:GetFunction action.
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.
This operation requires permission for the lambda:GetFunctionConfiguration operation.
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.
This operation requires permission for the lambda:InvokeFunction action.
Returns a list of event source mappings you created using the AddEventSource (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
This operation requires permission for the lambda:ListEventSources action.
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:RemoveEventSource action.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
This operation requires permission for the lambda:UpdateFunctionConfiguration action.
Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.
This operation requires permission for the lambda:UploadFunction action.
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
", "shapes": { "AddEventSourceRequest": { "base": null, "refs": { } }, "Blob": { "base": null, "refs": { "InvokeAsyncRequest$InvokeArgs": "JSON that you want to provide to your Lambda function as input.
", "UploadFunctionRequest$FunctionZip": "A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
" } }, "DeleteFunctionRequest": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "FunctionConfiguration$Description": "The user-provided description.
", "UpdateFunctionConfigurationRequest$Description": "A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
", "UploadFunctionRequest$Description": "A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
" } }, "EventSourceConfiguration": { "base": "Describes mapping between an Amazon Kinesis stream and a Lambda function.
", "refs": { "EventSourceList$member": null } }, "EventSourceList": { "base": null, "refs": { "ListEventSourcesResponse$EventSources": "An arrary of EventSourceConfiguration objects.
The Amazon Resource Name (ARN) assigned to the function.
" } }, "FunctionCodeLocation": { "base": "The object for the Lambda function location.
", "refs": { "GetFunctionResponse$Code": null } }, "FunctionConfiguration": { "base": "A complex type that describes function metadata.
", "refs": { "FunctionList$member": null, "GetFunctionResponse$Configuration": null } }, "FunctionList": { "base": null, "refs": { "ListFunctionsResponse$Functions": "A list of Lambda functions.
" } }, "FunctionName": { "base": null, "refs": { "AddEventSourceRequest$FunctionName": "The Lambda function to invoke when AWS Lambda detects an event on the stream.
", "DeleteFunctionRequest$FunctionName": "The Lambda function to delete.
", "EventSourceConfiguration$FunctionName": "The Lambda function to invoke when AWS Lambda detects an event on the stream.
", "FunctionConfiguration$FunctionName": "The name of the function.
", "GetFunctionConfigurationRequest$FunctionName": "The name of the Lambda function for which you want to retrieve the configuration information.
", "GetFunctionRequest$FunctionName": "The Lambda function name.
", "InvokeAsyncRequest$FunctionName": "The Lambda function name.
", "ListEventSourcesRequest$FunctionName": "The name of the AWS Lambda function.
", "UpdateFunctionConfigurationRequest$FunctionName": "The name of the Lambda function.
", "UploadFunctionRequest$FunctionName": "The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.
" } }, "GetEventSourceRequest": { "base": null, "refs": { } }, "GetFunctionConfigurationRequest": { "base": null, "refs": { } }, "GetFunctionRequest": { "base": null, "refs": { } }, "GetFunctionResponse": { "base": "This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation
", "refs": { } }, "Handler": { "base": null, "refs": { "FunctionConfiguration$Handler": "The function Lambda calls to begin executing your function.
", "UpdateFunctionConfigurationRequest$Handler": "The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
", "UploadFunctionRequest$Handler": "The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.
" } }, "HttpStatus": { "base": null, "refs": { "InvokeAsyncResponse$Status": "It will be 202 upon success.
" } }, "Integer": { "base": null, "refs": { "AddEventSourceRequest$BatchSize": "The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.
", "EventSourceConfiguration$BatchSize": "The largest number of records that AWS Lambda will POST in the invocation request to your function.
" } }, "InvalidParameterValueException": { "base": "One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
", "refs": { } }, "InvokeAsyncRequest": { "base": null, "refs": { } }, "InvokeAsyncResponse": { "base": "Upon success, it returns empty response. Otherwise, throws an exception.
", "refs": { } }, "ListEventSourcesRequest": { "base": null, "refs": { } }, "ListEventSourcesResponse": { "base": "Contains a list of event sources (see API_EventSourceConfiguration)
", "refs": { } }, "ListFunctionsRequest": { "base": null, "refs": { } }, "ListFunctionsResponse": { "base": "Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.
", "refs": { } }, "Long": { "base": null, "refs": { "FunctionConfiguration$CodeSize": "The size, in bytes, of the function .zip file you uploaded.
" } }, "Map": { "base": null, "refs": { "AddEventSourceRequest$Parameters": "A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: \"TRIM_HORIZON\" and \"LATEST\". The default value is \"TRIM_HORIZON\". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.
The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
" } }, "MaxListItems": { "base": null, "refs": { "ListEventSourcesRequest$MaxItems": "Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
", "ListFunctionsRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
" } }, "MemorySize": { "base": null, "refs": { "FunctionConfiguration$MemorySize": "The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
", "UpdateFunctionConfigurationRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
", "UploadFunctionRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
" } }, "Mode": { "base": null, "refs": { "FunctionConfiguration$Mode": "The type of the Lambda function you uploaded.
", "UploadFunctionRequest$Mode": "How the Lambda function will be invoked. Lambda supports only the \"event\" mode.
" } }, "RemoveEventSourceRequest": { "base": null, "refs": { } }, "ResourceNotFoundException": { "base": "The function or the event source specified in the request does not exist.
", "refs": { } }, "RoleArn": { "base": null, "refs": { "AddEventSourceRequest$Role": "The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
", "EventSourceConfiguration$Role": "The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
", "FunctionConfiguration$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
", "UpdateFunctionConfigurationRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
", "UploadFunctionRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
" } }, "Runtime": { "base": null, "refs": { "FunctionConfiguration$Runtime": "The runtime environment for the Lambda function.
", "UploadFunctionRequest$Runtime": "The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only \"nodejs\" as the runtime.
" } }, "ServiceException": { "base": "The AWS Lambda service encountered an internal error.
", "refs": { } }, "String": { "base": null, "refs": { "AddEventSourceRequest$EventSource": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
", "EventSourceConfiguration$UUID": "The AWS Lambda assigned opaque identifier for the mapping.
", "EventSourceConfiguration$EventSource": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
", "EventSourceConfiguration$Status": "The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".
", "FunctionCodeLocation$RepositoryType": "The repository from which you can download the function.
", "FunctionCodeLocation$Location": "The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
", "FunctionConfiguration$ConfigurationId": "A Lambda-assigned unique identifier for the current function code and related configuration.
", "GetEventSourceRequest$UUID": "The AWS Lambda assigned ID of the event source mapping.
", "InvalidParameterValueException$Type": null, "InvalidParameterValueException$message": null, "InvalidRequestContentException$Type": null, "InvalidRequestContentException$message": null, "ListEventSourcesRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream.
", "ListEventSourcesRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.
A string, present if there are more event source mappings.
", "ListFunctionsRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
A string, present if there are more functions.
", "Map$key": null, "Map$value": null, "RemoveEventSourceRequest$UUID": "The event source mapping ID.
", "ResourceNotFoundException$Type": null, "ResourceNotFoundException$Message": null, "ServiceException$Type": null, "ServiceException$Message": null } }, "Timeout": { "base": null, "refs": { "FunctionConfiguration$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", "UpdateFunctionConfigurationRequest$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", "UploadFunctionRequest$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" } }, "Timestamp": { "base": null, "refs": { "EventSourceConfiguration$LastModified": "The UTC time string indicating the last time the event mapping was updated.
", "FunctionConfiguration$LastModified": "The timestamp of the last time you updated the function.
" } }, "UpdateFunctionConfigurationRequest": { "base": null, "refs": { } }, "UploadFunctionRequest": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "EventSourceConfiguration$IsActive": "Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.
" } } } }