com.amazonaws.services.lambda

Class AWSLambdaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.lambda.AWSLambdaClient

All Implemented Interfaces:

AWSLambda

Direct Known Subclasses:

AWSLambdaAsyncClient

public class AWSLambdaClient
extends AmazonWebServiceClient
implements AWSLambda

Client for accessing AWSLambda. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSLambda exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSLambdaClient() Constructs a new client to invoke service methods on AWSLambda.
AWSLambdaClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials.
AWSLambdaClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials and client configuration options.
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider.
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider and client configuration options.
AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSLambdaClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLambda.

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.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.lambda.AWSLambda

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSLambda exceptions.

Constructor Detail

AWSLambdaClient

public AWSLambdaClient()

Constructs a new client to invoke service methods on AWSLambda. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSLambdaClient

public AWSLambdaClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLambda. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSLambda (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSLambdaClient

public AWSLambdaClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSLambdaClient

public AWSLambdaClient(AWSCredentials awsCredentials,
               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLambda (ex: proxy settings, retry counts, etc.).

AWSLambdaClient

public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSLambdaClient

public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLambda (ex: proxy settings, retry counts, etc.).

AWSLambdaClient

public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration,
               RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSLambda (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

getEventSource

public GetEventSourceResult getEventSource(GetEventSourceRequest getEventSourceRequest)

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

This operation requires permission for the lambda:GetEventSource action.

Specified by:

getEventSource in interface AWSLambda

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

public void deleteFunction(DeleteFunctionRequest deleteFunctionRequest)

Deletes the specified Lambda function code and configuration.

This operation requires permission for the lambda:DeleteFunction action.

Specified by:

deleteFunction in interface AWSLambda

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

public ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)

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.

Specified by:

listFunctions in interface AWSLambda

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

public AddEventSourceResult addEventSource(AddEventSourceRequest addEventSourceRequest)

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.

Specified by:

addEventSource in interface AWSLambda

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

public UploadFunctionResult uploadFunction(UploadFunctionRequest uploadFunctionRequest)

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.

Specified by:

uploadFunction in interface AWSLambda

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

public GetFunctionConfigurationResult getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)

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.

Specified by:

getFunctionConfiguration in interface AWSLambda

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

public InvokeAsyncResult invokeAsync(InvokeAsyncRequest invokeAsyncRequest)

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.

Specified by:

invokeAsync in interface AWSLambda

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

public ListEventSourcesResult listEventSources(ListEventSourcesRequest listEventSourcesRequest)

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.

Specified by:

listEventSources in interface AWSLambda

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

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

Specified by:

getFunction in interface AWSLambda

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

public UpdateFunctionConfigurationResult updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)

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.

Specified by:

updateFunctionConfiguration in interface AWSLambda

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

public void removeEventSource(RemoveEventSourceRequest removeEventSourceRequest)

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.

Specified by:

removeEventSource in interface AWSLambda

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

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

Specified by:

listFunctions in interface 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.

listEventSources

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

Specified by:

listEventSources in interface 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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints 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.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface AWSLambda

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSLambda

Parameters:

request - The originally executed request

Returns:

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