com.amazonaws.services.lambda

Interface AWSLambda

All Known Subinterfaces:

AWSLambdaAsync

All Known Implementing Classes:

AWSLambdaAsyncClient, AWSLambdaClient

public interface AWSLambda

Interface for accessing AWSLambda. AWS Lambda

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 Lambda: How it Works in the AWS Lambda Developer Guide .

Method Summary

Methods

Modifier and Type	Method and Description
AddPermissionResult	addPermission(AddPermissionRequest addPermissionRequest) Adds a permission to the access policy associated with the specified AWS Lambda function.
CreateEventSourceMappingResult	createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest) Identifies a stream as an event source for a Lambda function.
CreateFunctionResult	createFunction(CreateFunctionRequest createFunctionRequest) Creates a new Lambda function.
DeleteEventSourceMappingResult	deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest) Removes an event source mapping.
void	deleteFunction(DeleteFunctionRequest deleteFunctionRequest) Deletes the specified Lambda function code and configuration.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetEventSourceMappingResult	getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest) Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
GetFunctionResult	getFunction(GetFunctionRequest getFunctionRequest) Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file.
GetFunctionConfigurationResult	getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest) Returns the configuration information of the Lambda function.
GetPolicyResult	getPolicy(GetPolicyRequest getPolicyRequest) Returns the access policy, containing a list of permissions granted via the AddPermission API, associated with the specified bucket.
InvokeResult	invoke(InvokeRequest invokeRequest) Invokes a specified Lambda function.
InvokeAsyncResult	invokeAsync(InvokeAsyncRequest invokeAsyncRequest) Deprecated.
ListEventSourceMappingsResult	listEventSourceMappings() Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping), where you identify a stream as an event source.
ListEventSourceMappingsResult	listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest) Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping), where you identify a stream as an event source.
ListFunctionsResult	listFunctions() Returns a list of your Lambda functions.
ListFunctionsResult	listFunctions(ListFunctionsRequest listFunctionsRequest) Returns a list of your Lambda functions.
void	removePermission(RemovePermissionRequest removePermissionRequest) You can remove individual permissions from an access policy associated with a Lambda function by providing a Statement ID.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://lambda.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateEventSourceMappingResult	updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest) You can update an event source mapping.
UpdateFunctionCodeResult	updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest) Updates the code for the specified Lambda function.
UpdateFunctionConfigurationResult	updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest) Updates the configuration parameters for the specified Lambda function by using the values provided in the request.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://lambda.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "lambda.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://lambda.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "lambda.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://lambda.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteFunction

void deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Deletes the specified Lambda function code and configuration.

When you delete a function the associated access policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the lambda:DeleteFunction action.

Parameters:

deleteFunctionRequest - Container for the necessary parameters to execute the DeleteFunction service method on AWSLambda.

Throws:

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

addPermission

AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Adds a permission to the access policy associated with the specified AWS Lambda function. In a "push event" model, the access policy attached to the Lambda function grants Amazon S3 or a user application permission for the Lambda lambda:Invoke action. For information about the push model, see AWS Lambda: How it Works . Each Lambda function has one access policy associated with it. You can use the AddPermission API to add a permission to the policy. You have one access policy but it can have multiple permission statements.

This operation requires permission for the lambda:AddPermission action.

Parameters:

addPermissionRequest - Container for the necessary parameters to execute the AddPermission service method on AWSLambda.

Returns:

The response from the AddPermission service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

PolicyLengthExceededException

ResourceConflictException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

listFunctions

ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Parameters:

listFunctionsRequest - Container for the necessary parameters to execute the ListFunctions service method on AWSLambda.

Returns:

The response from the ListFunctions service method, as returned by AWSLambda.

Throws:

ServiceException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

removePermission

void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException

You can remove individual permissions from an access policy associated with a Lambda function by providing a Statement ID.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

Parameters:

removePermissionRequest - Container for the necessary parameters to execute the RemovePermission service method on AWSLambda.

Throws:

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

createFunction

CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Creates a new Lambda 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 operation will fail. Note that the function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

Parameters:

createFunctionRequest - Container for the necessary parameters to execute the CreateFunction service method on AWSLambda.

Returns:

The response from the CreateFunction service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

CodeStorageExceededException

ResourceConflictException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

updateEventSourceMapping

UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

Parameters:

updateEventSourceMappingRequest - Container for the necessary parameters to execute the UpdateEventSourceMapping service method on AWSLambda.

Returns:

The response from the UpdateEventSourceMapping service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

invokeAsync

@Deprecated
InvokeAsyncResult invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deprecated.

IMPORTANT:This API is deprecated. We recommend you use Invoke API (see Invoke).

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.

Parameters:

invokeAsyncRequest - Container for the necessary parameters to execute the InvokeAsync service method on AWSLambda.

Returns:

The response from the InvokeAsync service method, as returned by AWSLambda.

Throws:

InvalidRequestContentException

ServiceException

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

updateFunctionConfiguration

UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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.

Parameters:

updateFunctionConfigurationRequest - Container for the necessary parameters to execute the UpdateFunctionConfiguration service method on AWSLambda.

Returns:

The response from the UpdateFunctionConfiguration service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

invoke

InvokeResult invoke(InvokeRequest invokeRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Invokes a specified Lambda function.

This operation requires permission for the lambda:InvokeFunction action.

Parameters:

invokeRequest - Container for the necessary parameters to execute the Invoke service method on AWSLambda.

Returns:

The response from the Invoke service method, as returned by AWSLambda.

Throws:

InvalidRequestContentException

ServiceException

RequestTooLargeException

ResourceNotFoundException

UnsupportedMediaTypeException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

getPolicy

GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Returns the access policy, containing a list of permissions granted via the AddPermission API, associated with the specified bucket.

You need permission for the lambda:GetPolicy action.

Parameters:

getPolicyRequest - Container for the necessary parameters to execute the GetPolicy service method on AWSLambda.

Returns:

The response from the GetPolicy service method, as returned by AWSLambda.

Throws:

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

listEventSourceMappings

ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping), where you identify a stream as an 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:ListEventSourceMappings action.

Parameters:

listEventSourceMappingsRequest - Container for the necessary parameters to execute the ListEventSourceMappings service method on AWSLambda.

Returns:

The response from the ListEventSourceMappings service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

getEventSourceMapping

GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).

This operation requires permission for the lambda:GetEventSourceMapping action.

Parameters:

getEventSourceMappingRequest - Container for the necessary parameters to execute the GetEventSourceMapping service method on AWSLambda.

Returns:

The response from the GetEventSourceMapping service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

getFunctionConfiguration

GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

Parameters:

getFunctionConfigurationRequest - Container for the necessary parameters to execute the GetFunctionConfiguration service method on AWSLambda.

Returns:

The response from the GetFunctionConfiguration service method, as returned by AWSLambda.

Throws:

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

deleteEventSourceMapping

DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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:DeleteEventSourceMapping action.

Parameters:

deleteEventSourceMappingRequest - Container for the necessary parameters to execute the DeleteEventSourceMapping service method on AWSLambda.

Returns:

The response from the DeleteEventSourceMapping service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

createEventSourceMapping

CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an 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 a Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

This operation requires permission for the lambda:CreateEventSourceMapping action.

Parameters:

createEventSourceMappingRequest - Container for the necessary parameters to execute the CreateEventSourceMapping service method on AWSLambda.

Returns:

The response from the CreateEventSourceMapping service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceConflictException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

updateFunctionCode

UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

This operation requires permission for the lambda:UpdateFunctionCode action.

Parameters:

updateFunctionCodeRequest - Container for the necessary parameters to execute the UpdateFunctionCode service method on AWSLambda.

Returns:

The response from the UpdateFunctionCode service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

CodeStorageExceededException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

getFunction

GetFunctionResult getFunction(GetFunctionRequest getFunctionRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction 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.

Parameters:

getFunctionRequest - Container for the necessary parameters to execute the GetFunction service method on AWSLambda.

Returns:

The response from the GetFunction service method, as returned by AWSLambda.

Throws:

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

listFunctions

ListFunctionsResult listFunctions()
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Returns:

The response from the ListFunctions service method, as returned by AWSLambda.

Throws:

ServiceException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

listEventSourceMappings

ListEventSourceMappingsResult listEventSourceMappings()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping), where you identify a stream as an 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:ListEventSourceMappings action.

Returns:

The response from the ListEventSourceMappings service method, as returned by AWSLambda.

Throws:

InvalidParameterValueException

ServiceException

ResourceNotFoundException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLambda indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.