public class AWSLambdaClient extends AmazonWebServiceClient implements 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 Lambda: How it Works in the AWS Lambda Developer Guide .
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWSLambda exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
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.
|
Modifier and Type | Method and Description |
---|---|
AddPermissionResult |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to the resource policy associated with the
specified AWS Lambda function.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias that points to the specified Lambda function
version.
|
CreateEventSourceMappingResult |
createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Identifies a stream as an event source for a Lambda function.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a new Lambda function.
|
void |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias.
|
DeleteEventSourceMappingResult |
deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Removes an event source mapping.
|
void |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes the specified Lambda function code and configuration.
|
GetAliasResult |
getAlias(GetAliasRequest getAliasRequest)
Returns the specified alias information such as the alias ARN,
description, and function version it is pointing to.
|
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.
|
GetEventSourceMappingResult |
getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source
mapping (see CreateEventSourceMapping).
|
GetFunctionResult |
getFunction(GetFunctionRequest getFunctionRequest)
Returns the configuration information of the Lambda function and a
presigned URL link to the .zip file you uploaded with CreateFunction
so you can download the .zip file.
|
GetFunctionConfigurationResult |
getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
Returns the configuration information of the Lambda function.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource policy associated with the specified Lambda
function.
|
InvokeResult |
invoke(InvokeRequest invokeRequest)
Invokes a specific Lambda function.
|
InvokeAsyncResult |
invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
Deprecated.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Returns list of aliases created for a Lambda function.
|
ListEventSourceMappingsResult |
listEventSourceMappings()
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see CreateEventSourceMapping). |
ListEventSourceMappingsResult |
listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see CreateEventSourceMapping). |
ListFunctionsResult |
listFunctions()
Returns a list of your Lambda functions.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of your Lambda functions.
|
ListVersionsByFunctionResult |
listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
List all versions of a function.
|
PublishVersionResult |
publishVersion(PublishVersionRequest publishVersionRequest)
Publishes a version of your function from the current snapshot of
$LATEST.
|
void |
removePermission(RemovePermissionRequest removePermissionRequest)
You can remove individual permissions from an resource policy
associated with a Lambda function by providing a statement ID that you
provided when you added the permission.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://lambda.us-east-1.amazonaws.com/").
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId) |
UpdateAliasResult |
updateAlias(UpdateAliasRequest updateAliasRequest)
Using this API you can update the function version to which the alias
points and the alias description.
|
UpdateEventSourceMappingResult |
updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
You can update an event source mapping.
|
UpdateFunctionCodeResult |
updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates the code for the specified Lambda function.
|
UpdateFunctionConfigurationResult |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
Updates the configuration parameters for the specified Lambda
function by using the values provided in the request.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AWSLambdaClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AWSLambdaClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AWSLambda
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AWSLambdaClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AWSLambdaClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic UpdateAliasResult updateAlias(UpdateAliasRequest updateAliasRequest)
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases .
This requires permission for the lambda:UpdateAlias action.
updateAlias
in interface AWSLambda
updateAliasRequest
- Container for the necessary parameters to
execute the UpdateAlias service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public void deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes the specified Lambda function code and configuration.
If you are using the versioning feature and you don't specify a
function version in your DeleteFunction
request, AWS
Lambda will delete the function, including all its versions, and any
aliases pointing to the function versions. To delete a specific
function version, you must provide the function version via the
Qualifier
parameter. For information about function
versioning, see
AWS Lambda Function Versioning and Aliases
.
When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.
This operation requires permission for the
lambda:DeleteFunction
action.
deleteFunction
in interface AWSLambda
deleteFunctionRequest
- Container for the necessary parameters to
execute the DeleteFunction service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
ResourceConflictException
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.public AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.
For information about the push model, see AWS Lambda: How it Works .
If you are using versioning, the permissions you add are specific to
the Lambda function version or alias you specify in the
AddPermission
request via the Qualifier
parameter. For more information about versioning, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:AddPermission
action.
addPermission
in interface AWSLambda
addPermissionRequest
- Container for the necessary parameters to
execute the AddPermission service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
PolicyLengthExceededException
ResourceConflictException
TooManyRequestsException
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.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.
If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
listFunctions
in interface AWSLambda
listFunctionsRequest
- Container for the necessary parameters to
execute the ListFunctions service method on AWSLambda.ServiceException
TooManyRequestsException
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.public GetAliasResult getAlias(GetAliasRequest getAliasRequest)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases .
This requires permission for the lambda:GetAlias
action.
getAlias
in interface AWSLambda
getAliasRequest
- Container for the necessary parameters to
execute the GetAlias service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public void removePermission(RemovePermissionRequest removePermissionRequest)
You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
If you are using versioning, the permissions you remove are specific
to the Lambda function version or alias you specify in the
AddPermission
request via the Qualifier
parameter. For more information about versioning, see
AWS Lambda Function Versioning and Aliases
.
Note that removal of a permission will cause an active event source to lose permission to the function.
You need permission for the lambda:RemovePermission
action.
removePermission
in interface AWSLambda
removePermissionRequest
- Container for the necessary parameters
to execute the RemovePermission service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)
Creates a new Lambda 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 operation will fail. Note that the function name is case-sensitive.
If you are using versioning, you can also publish a version of the
Lambda function you are creating using the Publish
parameter. For more information about versioning, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:CreateFunction
action.
createFunction
in interface AWSLambda
createFunctionRequest
- Container for the necessary parameters to
execute the CreateFunction service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
CodeStorageExceededException
ResourceConflictException
TooManyRequestsException
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.public UpdateEventSourceMappingResult updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.
If you are using the versioning feature, you can update the event
source mapping to map to a specific Lambda function version or alias
as described in the FunctionName
parameter. For
information about the versioning feature, see
AWS Lambda Function Versioning and Aliases
.
If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.
This operation requires permission for the
lambda:UpdateEventSourceMapping
action.
updateEventSourceMapping
in interface AWSLambda
updateEventSourceMappingRequest
- Container for the necessary
parameters to execute the UpdateEventSourceMapping service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
ResourceConflictException
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.public PublishVersionResult publishVersion(PublishVersionRequest publishVersionRequest)
Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
publishVersion
in interface AWSLambda
publishVersionRequest
- Container for the necessary parameters to
execute the PublishVersion service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
CodeStorageExceededException
TooManyRequestsException
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.@Deprecated public InvokeAsyncResult invokeAsync(InvokeAsyncRequest invokeAsyncRequest)
IMPORTANT:This API is deprecated. We recommend you use Invoke API (see Invoke).
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:InvokeFunction
action.
invokeAsync
in interface AWSLambda
invokeAsyncRequest
- Container for the necessary parameters to
execute the InvokeAsync service method on AWSLambda.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.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.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
This operation requires permission for the
lambda:UpdateFunctionConfiguration
action.
updateFunctionConfiguration
in interface AWSLambda
updateFunctionConfigurationRequest
- Container for the necessary
parameters to execute the UpdateFunctionConfiguration service method
on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public InvokeResult invoke(InvokeRequest invokeRequest)
Invokes a specific Lambda function.
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. For information about the versioning
feature, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:InvokeFunction
action.
invoke
in interface AWSLambda
invokeRequest
- Container for the necessary parameters to execute
the Invoke service method on AWSLambda.InvalidRequestContentException
InvalidSubnetIDException
InvalidParameterValueException
InvalidSecurityGroupIDException
ServiceException
RequestTooLargeException
SubnetIPAddressLimitReachedException
EC2ThrottledException
ResourceNotFoundException
EC2AccessDeniedException
UnsupportedMediaTypeException
EC2UnexpectedException
TooManyRequestsException
ENILimitReachedException
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.public GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource
policy associated with the specific Lambda function version or alias
by specifying the version or alias name using the
Qualifier
parameter. For more information about
versioning, see
AWS Lambda Function Versioning and Aliases
.
For information about adding permissions, see AddPermission.
You need permission for the lambda:GetPolicy action.
getPolicy
in interface AWSLambda
getPolicyRequest
- Container for the necessary parameters to
execute the GetPolicy service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public GetEventSourceMappingResult getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the
lambda:GetEventSourceMapping
action.
getEventSourceMapping
in interface AWSLambda
getEventSourceMappingRequest
- Container for the necessary
parameters to execute the GetEventSourceMapping service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public ListEventSourceMappingsResult listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping
(see CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
If you are using the versioning feature, you can get list of event
source mappings for a specific Lambda function version or an alias as
described in the FunctionName
parameter. For information
about the versioning feature, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:ListEventSourceMappings
action.
listEventSourceMappings
in interface AWSLambda
listEventSourceMappingsRequest
- Container for the necessary
parameters to execute the ListEventSourceMappings service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public void deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases .
This requires permission for the lambda:DeleteAlias action.
deleteAlias
in interface AWSLambda
deleteAliasRequest
- Container for the necessary parameters to
execute the DeleteAlias service method on AWSLambda.InvalidParameterValueException
ServiceException
TooManyRequestsException
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.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 CreateFunction.
If you are using the versioning feature, you can retrieve this
information for a specific function version by using the optional
Qualifier
parameter and specifying the function version
or alias that points to it. If you don't provide it, the API returns
information about the $LATEST version of the function. For more
information about versioning, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:GetFunctionConfiguration
operation.
getFunctionConfiguration
in interface AWSLambda
getFunctionConfigurationRequest
- Container for the necessary
parameters to execute the GetFunctionConfiguration service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public DeleteEventSourceMappingResult deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
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:DeleteEventSourceMapping
action.
deleteEventSourceMapping
in interface AWSLambda
deleteEventSourceMappingRequest
- Container for the necessary
parameters to execute the DeleteEventSourceMapping service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public CreateEventSourceMappingResult createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This association between a stream source and a Lambda function is called the event source mapping.
IMPORTANT:This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.
You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.
Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases .
This operation requires permission for the
lambda:CreateEventSourceMapping
action.
createEventSourceMapping
in interface AWSLambda
createEventSourceMappingRequest
- Container for the necessary
parameters to execute the CreateEventSourceMapping service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
ResourceConflictException
TooManyRequestsException
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.public UpdateFunctionCodeResult updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
This operation requires permission for the
lambda:UpdateFunctionCode
action.
updateFunctionCode
in interface AWSLambda
updateFunctionCodeRequest
- Container for the necessary
parameters to execute the UpdateFunctionCode service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
CodeStorageExceededException
TooManyRequestsException
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.public ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases .
This requires permission for the lambda:ListAliases action.
listAliases
in interface AWSLambda
listAliasesRequest
- Container for the necessary parameters to
execute the ListAliases service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public ListVersionsByFunctionResult listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
listVersionsByFunction
in interface AWSLambda
listVersionsByFunctionRequest
- Container for the necessary
parameters to execute the ListVersionsByFunction service method on
AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.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 CreateFunction 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.
Using the optional Qualifier
parameter, you can specify
a specific function version for which you want this information. If
you don't specify this parameter, the API uses unqualified function
ARN which return information about the $LATEST
version of
the Lambda function. For more information, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:GetFunction
action.
getFunction
in interface AWSLambda
getFunctionRequest
- Container for the necessary parameters to
execute the GetFunction service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases .
Alias names are unique for a given function.
This requires permission for the lambda:CreateAlias action.
createAlias
in interface AWSLambda
createAliasRequest
- Container for the necessary parameters to
execute the CreateAlias service method on AWSLambda.InvalidParameterValueException
ServiceException
ResourceNotFoundException
ResourceConflictException
TooManyRequestsException
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.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.
If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases .
listFunctions
in interface AWSLambda
ServiceException
TooManyRequestsException
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.public ListEventSourceMappingsResult listEventSourceMappings() throws AmazonServiceException, AmazonClientException
Returns a list of event source mappings you created using the
CreateEventSourceMapping
(see CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
If you are using the versioning feature, you can get list of event
source mappings for a specific Lambda function version or an alias as
described in the FunctionName
parameter. For information
about the versioning feature, see
AWS Lambda Function Versioning and Aliases
.
This operation requires permission for the
lambda:ListEventSourceMappings
action.
listEventSourceMappings
in interface AWSLambda
InvalidParameterValueException
ServiceException
ResourceNotFoundException
TooManyRequestsException
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.public void setEndpoint(String endpoint)
AWSLambda
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.
setEndpoint
in interface AWSLambda
setEndpoint
in class AmazonWebServiceClient
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.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
setEndpoint
in class AmazonWebServiceClient
IllegalArgumentException
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSLambda
request
- The originally executed requestCopyright © 2016. All rights reserved.