Package software.amazon.awssdk.services.lambda

Interface LambdaAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface LambdaAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddPermissionResponse>	addPermission(AddPermissionRequest addPermissionRequest)	Adds a permission to the resource policy associated with the specified AWS Lambda function.
static LambdaAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a LambdaAsyncClient.
static LambdaAsyncClient	create()	Create a LambdaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateAliasResponse>	createAlias(CreateAliasRequest createAliasRequest)	Creates an alias that points to the specified Lambda function version.
default CompletableFuture<CreateEventSourceMappingResponse>	createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)	Identifies a stream as an event source for a Lambda function.
default CompletableFuture<CreateFunctionResponse>	createFunction(CreateFunctionRequest createFunctionRequest)	Creates a new Lambda function.
default CompletableFuture<DeleteAliasResponse>	deleteAlias(DeleteAliasRequest deleteAliasRequest)	Deletes the specified Lambda function alias.
default CompletableFuture<DeleteEventSourceMappingResponse>	deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)	Removes an event source mapping.
default CompletableFuture<DeleteFunctionResponse>	deleteFunction(DeleteFunctionRequest deleteFunctionRequest)	Deletes the specified Lambda function code and configuration.
default CompletableFuture<GetAccountSettingsResponse>	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)	Returns a customer's account settings.
default CompletableFuture<GetAliasResponse>	getAlias(GetAliasRequest getAliasRequest)	Returns the specified alias information such as the alias ARN, description, and function version it is pointing to.
default CompletableFuture<GetEventSourceMappingResponse>	getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)	Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
default CompletableFuture<GetFunctionResponse>	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.
default CompletableFuture<GetFunctionConfigurationResponse>	getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)	Returns the configuration information of the Lambda function.
default CompletableFuture<GetPolicyResponse>	getPolicy(GetPolicyRequest getPolicyRequest)	Returns the resource policy associated with the specified Lambda function.
default CompletableFuture<InvokeResponse>	invoke(InvokeRequest invokeRequest)	Invokes a specific Lambda function.
default CompletableFuture<InvokeAsyncResponse>	invokeAsync(InvokeAsyncRequest invokeAsyncRequest, AsyncRequestProvider requestProvider)
default CompletableFuture<ListAliasesResponse>	listAliases(ListAliasesRequest listAliasesRequest)	Returns list of aliases created for a Lambda function.
default CompletableFuture<ListEventSourceMappingsResponse>	listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)	Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).
default CompletableFuture<ListFunctionsResponse>	listFunctions(ListFunctionsRequest listFunctionsRequest)	Returns a list of your Lambda functions.
default CompletableFuture<ListTagsResponse>	listTags(ListTagsRequest listTagsRequest)	Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
default CompletableFuture<ListVersionsByFunctionResponse>	listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)	List all versions of a function.
default CompletableFuture<PublishVersionResponse>	publishVersion(PublishVersionRequest publishVersionRequest)	Publishes a version of your function from the current snapshot of $LATEST.
default CompletableFuture<RemovePermissionResponse>	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.
default CompletableFuture<TagResourceResponse>	tagResource(TagResourceRequest tagResourceRequest)	Creates a list of tags (key-value pairs) on the Lambda function.
default CompletableFuture<UntagResourceResponse>	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a Lambda function.
default CompletableFuture<UpdateAliasResponse>	updateAlias(UpdateAliasRequest updateAliasRequest)	Using this API you can update the function version to which the alias points and the alias description.
default CompletableFuture<UpdateEventSourceMappingResponse>	updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)	You can update an event source mapping.
default CompletableFuture<UpdateFunctionCodeResponse>	updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)	Updates the code for the specified Lambda function.
default CompletableFuture<UpdateFunctionConfigurationResponse>	updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)	Updates the configuration parameters for the specified Lambda function by using the values provided in the request.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static LambdaAsyncClient create()

Create a LambdaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static LambdaAsyncClientBuilder builder()

Create a builder that can be used to configure and create a LambdaAsyncClient.

addPermission

default CompletableFuture<AddPermissionResponse> 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.

Parameters:

addPermissionRequest -

Returns:

A Java Future containing the result of the AddPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• ResourceConflictException The resource already exists.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• PolicyLengthExceededException Lambda function access policy is limited to 20 KB.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createAlias

default CompletableFuture<CreateAliasResponse> 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.

Parameters:

createAliasRequest -

Returns:

A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• ResourceConflictException The resource already exists.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createEventSourceMapping

default CompletableFuture<CreateEventSourceMappingResponse> 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.

This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, see 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.

Parameters:

createEventSourceMappingRequest -

Returns:

A Java Future containing the result of the CreateEventSourceMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• ResourceConflictException The resource already exists.
• TooManyRequestsException
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createFunction

default CompletableFuture<CreateFunctionResponse> 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.

Parameters:

createFunctionRequest -

Returns:

A Java Future containing the result of the CreateFunction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• ResourceConflictException The resource already exists.
• TooManyRequestsException
• CodeStorageExceededException You have exceeded your maximum total code size per account. Limits
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteAlias

default CompletableFuture<DeleteAliasResponse> 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.

Parameters:

deleteAliasRequest -

Returns:

A Java Future containing the result of the DeleteAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteEventSourceMapping

default CompletableFuture<DeleteEventSourceMappingResponse> 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.

Parameters:

deleteEventSourceMappingRequest -

Returns:

A Java Future containing the result of the DeleteEventSourceMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteFunction

default CompletableFuture<DeleteFunctionResponse> 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.

Parameters:

deleteFunctionRequest -

Returns:

A Java Future containing the result of the DeleteFunction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• TooManyRequestsException
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• ResourceConflictException The resource already exists.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getAccountSettings

default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

Returns a customer's account settings.

You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.

Parameters:

getAccountSettingsRequest -

Returns:

A Java Future containing the result of the GetAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyRequestsException
• ServiceException The AWS Lambda service encountered an internal error.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getAlias

default CompletableFuture<GetAliasResponse> 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.

Parameters:

getAliasRequest -

Returns:

A Java Future containing the result of the GetAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getEventSourceMapping

default CompletableFuture<GetEventSourceMappingResponse> getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)

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

This operation requires permission for the lambda:GetEventSourceMapping action.

Parameters:

getEventSourceMappingRequest -

Returns:

A Java Future containing the result of the GetEventSourceMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getFunction

default CompletableFuture<GetFunctionResponse> 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.

Parameters:

getFunctionRequest -

Returns:

A Java Future containing the result of the GetFunction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• TooManyRequestsException
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getFunctionConfiguration

default CompletableFuture<GetFunctionConfigurationResponse> 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.

Parameters:

getFunctionConfigurationRequest -

Returns:

A Java Future containing the result of the GetFunctionConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• TooManyRequestsException
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getPolicy

default CompletableFuture<GetPolicyResponse> 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.

You need permission for the lambda:GetPolicy action.

Parameters:

getPolicyRequest -

Returns:

A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• TooManyRequestsException
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

invoke

default CompletableFuture<InvokeResponse> invoke(InvokeRequest invokeRequest)

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.

Parameters:

invokeRequest -

Returns:

A Java Future containing the result of the Invoke operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidRequestContentException The request body could not be parsed as JSON.
• RequestTooLargeException The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.
• UnsupportedMediaTypeException The content type of the Invoke request body is not JSON.
• TooManyRequestsException
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• EC2UnexpectedException AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
• SubnetIPAddressLimitReachedException AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
• ENILimitReachedException AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
• EC2ThrottledException AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
• EC2AccessDeniedException
• InvalidSubnetIDException The Subnet ID provided in the Lambda function VPC configuration is invalid.
• InvalidSecurityGroupIDException The Security Group ID provided in the Lambda function VPC configuration is invalid.
• InvalidZipFileException AWS Lambda could not unzip the function zip file.
• KMSDisabledException Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
• KMSInvalidStateException Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.
• KMSAccessDeniedException Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
• KMSNotFoundException Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
• InvalidRuntimeException The runtime or runtime version specified is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

invokeAsync

default CompletableFuture<InvokeAsyncResponse> invokeAsync(InvokeAsyncRequest invokeAsyncRequest,
                                                           AsyncRequestProvider requestProvider)

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.

Parameters:

invokeAsyncRequest -

requestProvider - Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. See AsyncRequestProvider for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows '

JSON that you want to provide to your Lambda function as input.

'.

Returns:

A Java Future containing the result of the InvokeAsync operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidRequestContentException The request body could not be parsed as JSON.
• InvalidRuntimeException The runtime or runtime version specified is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAliases

default CompletableFuture<ListAliasesResponse> 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.

Parameters:

listAliasesRequest -

Returns:

A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listEventSourceMappings

default CompletableFuture<ListEventSourceMappingsResponse> 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.

Parameters:

listEventSourceMappingsRequest -

Returns:

A Java Future containing the result of the ListEventSourceMappings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listFunctions

default CompletableFuture<ListFunctionsResponse> 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.

Parameters:

listFunctionsRequest -

Returns:

A Java Future containing the result of the ListFunctions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTags

default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).

Parameters:

listTagsRequest -

Returns:

A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listVersionsByFunction

default CompletableFuture<ListVersionsByFunctionResponse> listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)

List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

Parameters:

listVersionsByFunctionRequest -

Returns:

A Java Future containing the result of the ListVersionsByFunction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

publishVersion

default CompletableFuture<PublishVersionResponse> 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.

Parameters:

publishVersionRequest -

Returns:

A Java Future containing the result of the PublishVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• CodeStorageExceededException You have exceeded your maximum total code size per account. Limits
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removePermission

default CompletableFuture<RemovePermissionResponse> 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.

Parameters:

removePermissionRequest -

Returns:

A Java Future containing the result of the RemovePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

tagResource

default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null.

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

untagResource

default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name).

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateAlias

default CompletableFuture<UpdateAliasResponse> 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.

Parameters:

updateAliasRequest -

Returns:

A Java Future containing the result of the UpdateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateEventSourceMapping

default CompletableFuture<UpdateEventSourceMappingResponse> 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.

Parameters:

updateEventSourceMappingRequest -

Returns:

A Java Future containing the result of the UpdateEventSourceMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• ResourceConflictException The resource already exists.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateFunctionCode

default CompletableFuture<UpdateFunctionCodeResponse> 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.

Parameters:

updateFunctionCodeRequest -

Returns:

A Java Future containing the result of the UpdateFunctionCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• CodeStorageExceededException You have exceeded your maximum total code size per account. Limits
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateFunctionConfiguration

default CompletableFuture<UpdateFunctionConfigurationResponse> 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.

Parameters:

updateFunctionConfigurationRequest -

Returns:

A Java Future containing the result of the UpdateFunctionConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ServiceException The AWS Lambda service encountered an internal error.
• ResourceNotFoundException The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
• InvalidParameterValueException One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception. You will also get this exception if you have selected a deprecated runtime, such as Node v0.10.42.
• TooManyRequestsException
• ResourceConflictException The resource already exists.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• LambdaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation