com.amazonaws.services.lambda.AWSLambda Maven / Gradle / Ivy
/*
* Copyright 2010-2017 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 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.
*
**/
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 specific Lambda function. For an example, see Create the Lambda Function and Test It Manually.
*
*
* If you are using the versioning feature, you can invoke the specific
* function version by providing function version or alias name that is
* pointing to the function version using the Qualifier
* parameter in the request. If you don't provide the Qualifier
* parameter, the $LATEST version of the Lambda function is
* invoked. Invocations occur at least once in response to an event and
* functions must be idempotent to handle this. For information about the
* versioning feature, see AWS
* Lambda Function Versioning and Aliases.
*
*
* This operation requires permission for the
* lambda:InvokeFunction action.
*
*
* @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 EC2ThrottledException
* @throws EC2AccessDeniedException
* @throws InvalidSubnetIDException
* @throws InvalidSecurityGroupIDException
* @throws InvalidZipFileException
* @throws KMSDisabledException
* @throws KMSInvalidStateException
* @throws KMSAccessDeniedException
* @throws KMSNotFoundException
* @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);
}