com.amazonaws.services.lambda

Class AWSLambdaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.lambda.AWSLambdaClient

All Implemented Interfaces:

AWSLambda

public class AWSLambdaClient
extends com.amazonaws.AmazonWebServiceClient
implements AWSLambda

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

Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

• Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.

• Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.

• Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.

• Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

• Amazon Root CA 1

• Starfield Services Root Certificate Authority - G2

• Starfield Class 2 Certification Authority

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

Field Summary

Fields

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSLambdaClient() Deprecated.
AWSLambdaClient(com.amazonaws.auth.AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials.
AWSLambdaClient(com.amazonaws.auth.AWSCredentials awsCredentials, com.amazonaws.ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials and client configuration options.
AWSLambdaClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider.
AWSLambdaClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSLambda using the specified AWS account credentials provider and client configuration options.
AWSLambdaClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration, com.amazonaws.http.HttpClient httpClient) 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(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AWSLambdaClient(com.amazonaws.ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
com.amazonaws.ResponseMetadata	getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
InvokeResult	invoke(InvokeRequest invokeRequest) Invokes a Lambda function.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all AWS Lambda exceptions.

Constructor Detail

AWSLambdaClient

@Deprecated
public AWSLambdaClient()

Deprecated.

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

@Deprecated
public AWSLambdaClient(com.amazonaws.ClientConfiguration clientConfiguration)

Deprecated.

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(com.amazonaws.auth.AWSCredentials awsCredentials)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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(com.amazonaws.auth.AWSCredentials awsCredentials,
                       com.amazonaws.ClientConfiguration clientConfiguration)

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

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                       com.amazonaws.ClientConfiguration clientConfiguration)

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

@Deprecated
public AWSLambdaClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                                   com.amazonaws.ClientConfiguration clientConfiguration,
                                   com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

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

AWSLambdaClient

public AWSLambdaClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                       com.amazonaws.ClientConfiguration clientConfiguration,
                       com.amazonaws.http.HttpClient httpClient)

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

httpClient - A http client

Method Detail

invoke

public InvokeResult invoke(InvokeRequest invokeRequest)
                    throws com.amazonaws.AmazonServiceException,
                           com.amazonaws.AmazonClientException

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level ( ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

Specified by:

invoke in interface AWSLambda

Parameters:

invokeRequest -

Returns:

invokeResult The response from the Invoke service method, as returned by AWS Lambda.

Throws:

ServiceException

ResourceNotFoundException

InvalidRequestContentException

RequestTooLargeException

UnsupportedMediaTypeException

TooManyRequestsException

InvalidParameterValueException

EC2UnexpectedException

SubnetIPAddressLimitReachedException

ENILimitReachedException

EFSMountConnectivityException

EFSMountFailureException

EFSMountTimeoutException

EFSIOException

SnapStartException

SnapStartTimeoutException

SnapStartNotReadyException

EC2ThrottledException

EC2AccessDeniedException

InvalidSubnetIDException

InvalidSecurityGroupIDException

InvalidZipFileException

KMSDisabledException

KMSInvalidStateException

KMSAccessDeniedException

KMSNotFoundException

InvalidRuntimeException

ResourceConflictException

ResourceNotReadyException

RecursiveInvocationException

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

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

getCachedResponseMetadata

@Deprecated
public com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.