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

Method Summary

Methods

Modifier and Type	Method and Description
AddEventSourceResult	addEventSource(AddEventSourceRequest addEventSourceRequest) Identifies an Amazon Kinesis stream as the event source for an AWS Lambda function.
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.
GetEventSourceResult	getEventSource(GetEventSourceRequest getEventSourceRequest) Returns configuration information for the specified event source mapping (see AddEventSource).
GetFunctionResult	getFunction(GetFunctionRequest getFunctionRequest) 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.
GetFunctionConfigurationResult	getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest) Returns the configuration information of the Lambda function.
InvokeAsyncResult	invokeAsync(InvokeAsyncRequest invokeAsyncRequest) Submits an invocation request to AWS Lambda.
ListEventSourcesResult	listEventSources() Returns a list of event source mappings.
ListEventSourcesResult	listEventSources(ListEventSourcesRequest listEventSourcesRequest) Returns a list of event source mappings.
ListFunctionsResult	listFunctions() Returns a list of your Lambda functions.
ListFunctionsResult	listFunctions(ListFunctionsRequest listFunctionsRequest) Returns a list of your Lambda functions.
void	removeEventSource(RemoveEventSourceRequest removeEventSourceRequest) Removes an event source mapping.
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.
UpdateFunctionConfigurationResult	updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest) Updates the configuration parameters for the specified Lambda function by using the values provided in the request.
UploadFunctionResult	uploadFunction(UploadFunctionRequest uploadFunctionRequest) Creates a new Lambda function or updates an existing function.

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)

getEventSource

GetEventSourceResult getEventSource(GetEventSourceRequest getEventSourceRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

This operation requires permission for the lambda:GetEventSource action.

Parameters:

getEventSourceRequest - Container for the necessary parameters to execute the GetEventSource service method on AWSLambda.

Returns:

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

Throws:

InvalidParameterValueException

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.

deleteFunction

void deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Deletes the specified Lambda function code and configuration.

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

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

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.

addEventSource

AddEventSourceResult addEventSource(AddEventSourceRequest addEventSourceRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Identifies an Amazon Kinesis stream as the event source for an AWS Lambda function. 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 LambdaL 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.

This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.

Parameters:

addEventSourceRequest - Container for the necessary parameters to execute the AddEventSource service method on AWSLambda.

Returns:

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

Throws:

InvalidParameterValueException

ServiceException

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.

uploadFunction

UploadFunctionResult uploadFunction(UploadFunctionRequest uploadFunctionRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

uploadFunctionRequest - Container for the necessary parameters to execute the UploadFunction service method on AWSLambda.

Returns:

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

Throws:

InvalidParameterValueException

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.

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 UploadFunction.

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

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

InvokeAsyncResult invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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:InvokeAsync 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.

listEventSources

ListEventSourcesResult listEventSources(ListEventSourcesRequest listEventSourcesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns a list of event source mappings. For each mapping, the API returns configuration information (see AddEventSource). You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSources action.

Parameters:

listEventSourcesRequest - Container for the necessary parameters to execute the ListEventSources service method on AWSLambda.

Returns:

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

Throws:

InvalidParameterValueException

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.

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 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.

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

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

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.

removeEventSource

void removeEventSource(RemoveEventSourceRequest removeEventSourceRequest)
                       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:RemoveEventSource action.

Parameters:

removeEventSourceRequest - Container for the necessary parameters to execute the RemoveEventSource service method on AWSLambda.

Throws:

InvalidParameterValueException

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.

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

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.

listEventSources

ListEventSourcesResult listEventSources()
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns a list of event source mappings. For each mapping, the API returns configuration information (see AddEventSource). You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSources action.

Returns:

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

Throws:

InvalidParameterValueException

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.

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.