/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.lambda; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.lambda.model.*; /** * Interface for accessing AWS Lambda 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: *

* *

* 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: *

* *

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

**/ public interface AWSLambda { /** * 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 * {@link 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. * * @param 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. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AWSLambda#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 {@link 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. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *

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

* * @param invokeRequest * @return invokeResult The response from the Invoke service method, as * returned by AWS Lambda. * @throws ServiceException * @throws ResourceNotFoundException * @throws InvalidRequestContentException * @throws RequestTooLargeException * @throws UnsupportedMediaTypeException * @throws TooManyRequestsException * @throws InvalidParameterValueException * @throws EC2UnexpectedException * @throws SubnetIPAddressLimitReachedException * @throws ENILimitReachedException * @throws EFSMountConnectivityException * @throws EFSMountFailureException * @throws EFSMountTimeoutException * @throws EFSIOException * @throws SnapStartException * @throws SnapStartTimeoutException * @throws SnapStartNotReadyException * @throws EC2ThrottledException * @throws EC2AccessDeniedException * @throws InvalidSubnetIDException * @throws InvalidSecurityGroupIDException * @throws InvalidZipFileException * @throws KMSDisabledException * @throws KMSInvalidStateException * @throws KMSAccessDeniedException * @throws KMSNotFoundException * @throws InvalidRuntimeException * @throws ResourceConflictException * @throws ResourceNotReadyException * @throws RecursiveInvocationException * @throws 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. * @throws 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. */ InvokeResult invoke(InvokeRequest invokeRequest) throws AmazonClientException, AmazonServiceException; /** * 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. */ public void shutdown(); /** * 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. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }